احراز هویت

هر درخواستی که CLI می‌فرستد یک کلید API از پروژهٔ شما را با خود دارد. کلیدها را یک بار با status200 login ذخیره کنید، برای هر محیط یک زمینه، یا مانند اسکریپت‌ها آن‌ها را با پرچم‌ها یا متغیرهای محیطی به یک دستور بدهید. این صفحه هر روش را نشان می‌دهد، و این‌که وقتی چند روش هست، دستور کدام را به کار می‌برد.

پیش از شروع#

به یک کلید API از پروژهٔ خود نیاز دارید. آن را در تنظیمات پروژه > پیشرفته > کلیدهای API با ساخت کلید API بسازید و دسترسی‌ای را که دستورهایتان نیاز دارند به آن بدهید: یک کلید API بسازید را ببینید. کلید همان کاری را می‌کند که مجوزهایش اجازه می‌دهند، پس کلیدی که فقط می‌تواند رکوردها را بخواند، می‌تواند آن‌ها را فهرست کند و بخواند، اما نمی‌تواند تغییرشان دهد.

در Status200 Cloud، کلیدهای API فقط تا وقتی کار می‌کنند که پروژه روی طرح Growth یا بالاتر باشد. پایین‌تر از آن، هر دستور با API error (402) و پیامی که نام طرح را می‌آورد پاسخ می‌دهد، تا وقتی پروژه ارتقا یابد؛ پس از آن همان کلید دوباره کار می‌کند. کلیدهای API و SCIM پایین‌تر از طرحشان را ببینید.

ورود#

status200 login یک کلید API و نشانی Status200 شما را به‌عنوان یک زمینه ذخیره می‌کند و آن را زمینهٔ فعلی می‌کند:

status200 login <api-key> <instance-url> [--context-name <name>]

برای نمونه، زمینه‌ای به نام production:

status200 login <api-key> https://status200.ru --context-name production

پاسخ آن Logged in successfully. Context "production" is now active. است. اسلش پایان نشانی حذف می‌شود، و ورود دوباره با همان نام آن زمینه را جایگزین می‌کند.

زمینه‌ها#

زمینه یک ورود ذخیره‌شده است: یک نام، یک نشانی و یک کلید API. برای هر پروژه یا محیط یکی ذخیره کنید، سپس یکی را برای همهٔ دستورهای بعدی، یا برای یک دستور، انتخاب کنید.

1. برای هر محیط یک زمینه ذخیره کنید#

   Bash

   status200 login <production-api-key> https://status200.ru --context-name production
   status200 login <staging-api-key> https://status200.example.com --context-name staging

   هر ورود زمینهٔ خودش را زمینهٔ فعلی می‌کند، پس اکنون staging زمینهٔ فعلی است.

2. آن‌ها را فهرست کنید#

   Bash

   status200 context list

   ┌───┬────────────┬───────────────────────────────┐
   │   │ Name       │ URL                           │
   ├───┼────────────┼───────────────────────────────┤
   │   │ production │ https://status200.ru          │
   ├───┼────────────┼───────────────────────────────┤
   │ * │ staging    │ https://status200.example.com │
   └───┴────────────┴───────────────────────────────┘

   نشانهٔ * زمینهٔ فعلی را مشخص می‌کند. کلیدهای API هرگز فهرست نمی‌شوند.

3. به زمینهٔ دیگری بروید#

   Bash

   status200 context use production

   پاسخ آن Switched to context "production". است و دستورهای بعدی از آن استفاده می‌کنند.

4. برای یک دستور از یک زمینه استفاده کنید#

   Bash

   status200 incident list --context staging

   زمینهٔ فعلی همان‌طور که بود می‌ماند.

دستور کدام اعتبارنامه‌ها را به کار می‌برد#

دستور به یک کلید API و یک URL نیاز دارد. هر کدام از این دو را از نخستین جایی در این فهرست برمی‌دارد که آن را داشته باشد:

پس می‌توانید آن‌ها را با هم ترکیب کنید: برای نمونه، کلید API از یک متغیر محیطی همراه با URL زمینهٔ فعلی. متغیرهای محیطی برای اسکریپت‌ها و جاب‌های CI، که زمینهٔ ذخیره‌شده‌ای ندارند، مناسب‌اند:

export STATUS200_API_KEY=<api-key>
export STATUS200_URL=https://status200.ru
status200 incident list

export STATUS200_API_KEY=<api-key>
export STATUS200_URL=https://status200.ru
status200 incident list

$env:STATUS200_API_KEY = "<api-key>"
$env:STATUS200_URL = "https://status200.ru"
status200 incident list

برای یک دستور، پرچم‌ها بر همه‌چیز مقدم‌اند:

status200 --api-key <api-key> --url https://status200.ru incident list

ببینید CLI از چه چیزی استفاده خواهد کرد#

status200 whoami نشانی URL و کلید API را که دستور بعدی به کار می‌برد، و زمینه‌ای را که از آن آمده‌اند، نشان می‌دهد:

status200 whoami

URL:     https://status200.ru
API Key: 4f1c****0a13
Context: production

فقط چهار نویسهٔ اول و چهار نویسهٔ آخر کلید نشان داده می‌شوند. سطر Context فقط وقتی ظاهر می‌شود که URL و کلید مقادیر خود آن زمینه باشند، نه مقادیری که یک پرچم یا یک متغیر محیطی جایگزینشان کرده است. whoami تنظیمات شما را بدون فراخوانی Status200 می‌خواند: نشان می‌دهد دستور چه چیزی خواهد فرستاد، نه این‌که Status200 آن را می‌پذیرد یا نه. وقتی هیچ چیزی ذخیره یا تنظیم نشده باشد، پاسخ می‌دهد:

Not authenticated. Run `status200 login` to authenticate.

فایل پیکربندی#

status200 login زمینه‌ها را در ~/.oneuptime/config.json، در پوشهٔ خانگی شما، ذخیره می‌کند (در Windows، %USERPROFILE%\.oneuptime\config.json). CLI آن را طوری می‌سازد که فقط کاربر شما بتواند آن را بخواند و بنویسد (حالت 0600):

{
  "currentContext": "production",
  "contexts": {
    "production": {
      "name": "production",
      "apiUrl": "https://status200.ru",
      "apiKey": "<api-key>"
    },
    "staging": {
      "name": "staging",
      "apiUrl": "https://status200.example.com",
      "apiKey": "<api-key>"
    }
  }
}

این فایل کلیدهای API را همان‌طور که هستند نگه می‌دارد: آن را از پوشه‌های مشترک، پشتیبان‌ها و مخزن‌ها دور نگه دارید. برای خروج از یک زمینه، آن را با status200 context delete <name> حذف کنید؛ برای خروج از همهٔ آن‌ها، فایل را حذف کنید. کلیدی که ممکن است فاش شده باشد تا وقتی آن را در Status200، در تنظیمات پروژه > پیشرفته > کلیدهای API، حذف نکنید معتبر می‌ماند.

قالب‌های خروجی و اندازهٔ فهرست‌ها اینجا ذخیره نمی‌شوند: -o و --limit را به هر دستور بدهید.

عیب‌یابی#

گام‌های بعدی#