رفتن به محتوا
مستندات
مرجع دستورها

مرجع دستورها

مشاهده به‌صورت Markdown

همهٔ دستورهای CLI status200، با آرگومان‌ها، گزینه‌ها و مقادیر پیش‌فرضشان. برای دیدن همین‌ها در ترمینال، --help را به هر دستوری اضافه کنید.

گزینه‌های سراسریگزینه‌هایی که هر دستور می‌پذیرد.ورود و زمینه‌هاlogin و دستورهای context.دستورهای منابعlist، get، create، update، delete و count.دستورهای دیگرdeploy، whoami، resources، version و help.

دستورها

flowchart LR O["status200"] --> L["login"] O --> C["context"] C --> C1["list<br/>use<br/>current<br/>delete"] O --> R["incident، monitor<br/>و هر منبع دیگر"] R --> R1["list<br/>get<br/>create<br/>update<br/>delete<br/>count"] O --> U["deploy<br/>whoami<br/>resources<br/>version<br/>help"]

دستورهای CLI status200

گزینه‌های سراسری

گزینهچه می‌کندپیش‌فرض
--api-key <key>کلید API برای همین دستورSTATUS200_API_KEY، سپس کلید زمینه
--url <url>نشانی Status200 شما برای همین دستورSTATUS200_URL، سپس URL زمینه
--context <name>زمینهٔ ذخیره‌شده‌ای که این دستور به کار می‌بردزمینهٔ فعلی
-o, --output <format>json، table یا widetable در ترمینال، json در پایپ
--no-colorبدون رنگ چاپ می‌کندرنگی، مگر این‌که NO_COLOR تنظیم شده باشد
-V, --versionنسخهٔ CLI را چاپ می‌کند
-h, --helpراهنمای یک دستور را نشان می‌دهد

گزینه‌ها پیش یا پس از دستور می‌آیند: status200 --context staging incident list و status200 incident list --context staging یک کار را انجام می‌دهند.

ورود و زمینه‌ها

status200 login

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

Bash 
status200 login <api-key> <instance-url> [--context-name <name>]
آرگومان یا گزینهالزامیچیستپیش‌فرض
<api-key>بلهیک کلید API از پروژهٔ شما
<instance-url>بلهنشانی Status200 شما، مانند https://status200.ru
--context-name <name>خیرنامی که زمینه با آن ذخیره می‌شودdefault

status200 context list

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

Bash 
status200 context list [-o <format>]
گزینهالزامیچیست
-o, --output <format>خیرjson، table یا wide. JSON برای هر زمینه name، apiUrl و isCurrent را می‌دهد

status200 context use

یک زمینهٔ ذخیره‌شده را زمینهٔ فعلی می‌کند.

Bash 
status200 context use <name>
آرگومانالزامیچیست
<name>بلهنام یک زمینهٔ ذخیره‌شده

status200 context current

نام و URL زمینهٔ فعلی را نشان می‌دهد، و کلید API آن را با پنهان بودن همهٔ نویسه‌ها جز چهار نویسهٔ اول و چهار نویسهٔ آخر.

Bash 
status200 context current

status200 context delete

یک زمینهٔ ذخیره‌شده را حذف می‌کند. اگر زمینهٔ فعلی بود، نخستین زمینهٔ باقی‌مانده زمینهٔ فعلی می‌شود.

Bash 
status200 context delete <name>
آرگومانالزامیچیست
<name>بلهنام یک زمینهٔ ذخیره‌شده

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

<resource> دستور یک نوع رکورد است، از جدول‌های منابع، مانند incident یا monitor. برای نمونه‌ها عملیات روی منابع را ببینید.

status200 <resource> list

رکوردها را فهرست می‌کند، تازه‌ترین‌ها در ابتدا. برچسب‌ها در عوض به ترتیب نام فهرست می‌شوند، برچسب‌های شماره‌دار اول (2. Team پیش از 10. Owner).

Bash 
status200 <resource> list [--query <json>] [--limit <n>] [--skip <n>] [--sort <json>] [-o <format>]
گزینهچه می‌کندپیش‌فرض
--query <json>یک فیلتر، به‌صورت JSONهر رکوردی که کلید می‌تواند بخواند
--limit <n>بیشترین تعداد رکوردهای برگشتی، تا ۱۰٬۰۰۰10
--skip <n>چند رکورد اول نادیده گرفته شوند0
--sort <json>ترتیب، به‌صورت JSON: {"<field>":"ASC"} یا {"<field>":"DESC"}تازه‌ترین‌ها در ابتدا
-o, --output <format>json، table یا widetable در ترمینال، json در پایپ

status200 <resource> get

یک رکورد را می‌خواند. فقط برای رکوردها: تله‌متری get ندارد.

Bash 
status200 <resource> get <id> [-o <format>]
آرگومان یا گزینهالزامیچیست
<id>بلهشناسهٔ رکورد، یک UUID
-o, --output <format>خیرjson، table یا wide

status200 <resource> create

یک رکورد می‌سازد و آن را چاپ می‌کند.

Bash 
status200 <resource> create (--data <json> | --file <path>) [-o <format>]
گزینهالزامیچیست
--data <json>یکی از این دورکورد، به‌صورت JSON
--file <path>یکی از این دویک فایل JSON که رکورد را در خود دارد. اگر همراه با --data داده شود، فایل به کار می‌رود
-o, --output <format>خیرjson، table یا wide

status200 <resource> update

فیلدهایی را که می‌دهید تغییر می‌دهد. فقط برای رکوردها: تله‌متری update ندارد.

Bash 
status200 <resource> update <id> --data <json> [-o <format>]
آرگومان یا گزینهالزامیچیست
<id>بلهشناسهٔ رکورد
--data <json>بلهفیلدهایی که باید تغییر کنند، به‌صورت JSON
-o, --output <format>خیرjson، table یا wide

status200 <resource> delete

یک رکورد را بی‌درنگ و بدون پرسیدن حذف می‌کند. فقط برای رکوردها: تله‌متری delete ندارد.

Bash 
status200 <resource> delete <id> [--force]
آرگومان یا گزینهالزامیچیست
<id>بلهشناسهٔ رکورد
--forceخیرپذیرفته می‌شود و چیزی را تغییر نمی‌دهد: delete هرگز تأیید نمی‌خواهد

status200 <resource> count

رکوردها را می‌شمارد و عدد را چاپ می‌کند.

Bash 
status200 <resource> count [--query <json>] [-o <format>]
گزینهالزامیچیست
--query <json>خیریک فیلتر، به‌صورت JSON. بدون آن، هر رکوردی که کلید می‌تواند بخواند
-o, --output <format>خیرjson، table یا wide

منابع

رکوردها list، get، create، update، delete و count را می‌پذیرند:

حوزهدستورها
پایشmonitor, monitor-status, monitor-status-event
حادثه‌هاincident, incident-state, incident-severity, incident-state-timeline, incident-public-note, incident-internal-note, incident-alert, postmortem-status
هشدارهاalert, alert-state, alert-severity, alert-state-timeline, alert-internal-note
صفحه‌های وضعیتstatus-page, status-page-announcement
نگهداری زمان‌بندی‌شدهscheduled-maintenance-event, scheduled-maintenance-state, scheduled-maintenance-state-timeline
تیم‌ها و کشیکteam, on-call-policy
امنیتsecurity-case, security-case-note, security-detection, security-playbook
برچسب‌هاlabel

تله‌متری list، create و count را می‌پذیرد:

حوزهدستورها
مشاهده‌پذیریlog, metric, span, exception-instance, monitor-log
امنیتsecurity-event, threat-intel-indicator
تغییرها و هزینهchange-event, kubernetes-cost-allocation

CLI همراه با Status200 منتشر می‌شود، پس status200 resources دستورهای همان نسخه‌ای را که نصب کرده‌اید فهرست می‌کند.

درخواست‌های API

هر عملیات یک درخواست به API است، با کلید در سرآیند APIKey. <path> مسیر API منبع است که status200 resources آن را می‌دهد: /incident برای incident، و /on-call-duty-policy برای on-call-policy.

عملیاتدرخواستبدنه
listPOST /api/<path>/get-listquery، select، skip، limit و sort
getPOST /api/<path>/<id>/get-itemselect
createPOST /api/<path>{"data": ...}
updatePUT /api/<path>/<id>/{"data": ...}
deleteDELETE /api/<path>/<id>/هیچ
countPOST /api/<path>/countquery

دستورهای دیگر

status200 deploy

یک استقرار، یا تغییری دیگر، را از یک خط لوله ثبت می‌کند: روی نمودارهای سرویس کشیده می‌شود و Status200 AI هنگام بررسی یک حادثه آن را می‌خواند. با یک کلید دریافت دادهٔ تله‌متری می‌نویسد، نه با کلید API. استقرارها و تغییرها را ببینید.

Bash 
status200 deploy [--service <name>] [--service-version <version>] [--previous-version <version>] [--commit <sha>] [--repository <url>] [--branch <name>] [--pull-request <number>] [--environment <name>] [--title <title>] [--description <text>] [--type <type>] [--time <time>] [--attribute <key=value...>] [--ingestion-key <key>]
گزینهالزامیچیستپیش‌فرض
--service <name>خیرسرویسی که مستقر شدیک تغییر در سطح کل پروژه
--service-version <version>خیرنسخهٔ مستقرشده
--previous-version <version>خیرنسخه‌ای که جایگزینش شد
--commit <sha>خیرکامیت مستقرشده
--repository <url>خیرمخزنی که کامیت در آن است
--branch <name>خیرشاخهٔ مستقرشده
--pull-request <number>خیرPull Request مستقرشده
--environment <name>خیرمحیطی که در آن مستقر شد
--title <title>خیرعنوان تغییر؛ هر نوعی جز استقرار به آن نیاز داردDeploy <version>
--description <text>خیرجزئیات تغییر
--type <type>خیرنوع تغییر، مانند config-change یا rollbackdeployment
--time <time>خیرزمان رخ دادن آن، مانند 2026-10-19T10:00:00Zاکنون
--attribute <key=value...>خیرویژگی‌های بیشتر، به‌صورت key=value، یک یا چند تا
--ingestion-key <key>خیریک کلید دریافت دادهٔ تله‌متری پروژهSTATUS200_TELEMETRY_INGESTION_KEY

status200 whoami

URL و کلید API را که دستور بعدی به کار می‌برد، با کلید پوشانده‌شده، و زمینه‌ای را که از آن آمده‌اند نشان می‌دهد. Status200 را فرا نمی‌خواند. ببینید CLI از چه چیزی استفاده خواهد کرد را ببینید.

Bash 
status200 whoami

status200 resources

هر نوع رکوردی را که CLI برایش دستور دارد فهرست می‌کند: دستورش، نام‌های مفرد و جمع، نوع و مسیر API آن، و شمار کل.

Bash 
status200 resources [--type <type>] [-o <format>]
گزینهالزامیچیستپیش‌فرض
--type <type>خیرdatabase برای رکوردها، analytics برای تله‌متریهر دو
-o, --output <format>خیرjson، table یا wide. JSON برای هر کدام name، singularName، pluralName، modelType و apiPath را می‌دهدtable در ترمینال، json در پایپ

status200 version

نسخهٔ CLI را چاپ می‌کند، همان‌طور که status200 --version می‌کند.

Bash 
status200 version

status200 help

راهنمای CLI، یا یک دستور، را نشان می‌دهد.

Bash 
status200 help [command]

متغیرهای محیطی

متغیرچه می‌کند
STATUS200_API_KEYکلید API، وقتی هیچ پرچم --api-key کلیدی ندهد
STATUS200_URLنشانی Status200 شما، وقتی هیچ پرچم --url نشانی‌ای ندهد
STATUS200_TELEMETRY_INGESTION_KEYکلید دریافت دادهٔ تله‌متری‌ای که status200 deploy با آن می‌نویسد، وقتی هیچ پرچم --ingestion-key کلیدی ندهد
NO_COLORبا هر مقداری، رنگ‌ها را خاموش می‌کند

فایل‌ها

فایلچه چیزی را نگه می‌دارد
~/.oneuptime/config.jsonزمینه‌های ذخیره‌شده، کلیدهای API آن‌ها و زمینهٔ فعلی

کدهای خروج

کدمعنا
0کار کرد
1شکست خورد: Status200 درخواست را رد کرد، یا دستور اشتباه بود
2کلید API قابل‌استفاده‌ای نیست: پیدا نشد، نامعتبر است، یا پایین‌تر از طرحش است
3پیدا نشد: Status200 پاسخ 404 داد

برای نمونه‌ها کدهای خروج را ببینید.

گام‌های بعدی

نمای کلی CLICLI را نصب کنید و نخستین دستورهایتان را اجرا کنید.عملیات روی منابعنمونه‌هایی از هر عملیات.اسکریپت‌نویسی و CI/CDCLI در اسکریپت‌ها و خط لوله‌ها.