عملیات روی منابع

هر نوع رکورد دستور خودش را دارد، مانند incident، monitor یا status-page، و همهٔ آن‌ها عملیات یکسانی را می‌پذیرند: list، get، create، update، delete و count. این صفحه هر عملیات را نشان می‌دهد، همراه با فیلترها، صفحه‌بندی و JSONی که رکورد با آن نوشته می‌شود.

عملیات چگونه کنار هم قرار می‌گیرند#

خواندن، تغییر دادن و حذف یک رکورد به شناسهٔ آن نیاز دارد. فهرست کردن، شمردن و ساختن به هیچ شناسه‌ای نیاز ندارند، و یک list یا یک create شناسه‌هایی را به شما می‌دهد که بقیه می‌گیرند:

شناسه یک UUID است، مانند 6f1c2a40-3b1e-4c55-9a0b-3e2f8d7c1a11. می‌توانید آن را از صفحهٔ رکورد در Status200 هم کپی کنید: یافتن شناسه یک منبع را ببینید.

دستور یک رکورد را پیدا کنید#

status200 resources

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

برای نشان دادن یک نوع، status200 resources --type database یا --type analytics را به کار ببرید. مرجع دستورها همهٔ دستورها را فهرست می‌کند.

فهرست کردن رکوردها#

status200 <resource> list [--query <json>] [--limit <n>] [--skip <n>] [--sort <json>] [-o <format>]

# The ten newest incidents
status200 incident list

# The oldest monitors first, 50 at a time: the second page
status200 monitor list --sort '{"createdAt":"ASC"}' --limit 50 --skip 50

# Every field of each incident, as JSON
status200 incident list -o json

یک فهرست، هر فیلدی از هر رکورد را که کلید می‌تواند بخواند از Status200 می‌خواهد. جدول شش تا از آن‌ها را نشان می‌دهد؛ JSON همه را نشان می‌دهد (قالب‌های خروجی را ببینید). برای ورق زدن همهٔ رکوردها، --skip را هر بار به اندازهٔ --limit بالا ببرید تا صفحه‌ای خالی برگردد؛ count می‌گوید چند رکورد وجود دارد.

برچسب‌ها به جای تازه‌ترین‌ها در ابتدا، به ترتیب نام فهرست می‌شوند: برچسب‌هایی که نامشان با عدد شروع می‌شود اول می‌آیند، به ترتیب همان عدد (2. Team پیش از 10. Owner)، و سپس بقیه به ترتیب الفبایی. برای فهرست کردن آن‌ها به ترتیبی دیگر، --sort را بدهید.

فیلتر کردن یک فهرست#

--query همان فیلتر API را می‌گیرد: فیلدی با یک مقدار با همان مقدار منطبق می‌شود، و شیئی با _type مقایسه می‌کند.

status200 incident list --query '{"title":{"_type":"Search","value":"checkout"}}'

پالایش، مرتب‌سازی و صفحه‌بندی در مرجع API همهٔ _typeها را فهرست می‌کند.

خواندن یک رکورد#

status200 <resource> get <id> [-o <format>]

status200 incident get 6f1c2a40-3b1e-4c55-9a0b-3e2f8d7c1a11

جدول برای هر فیلد رکورد یک سطر نشان می‌دهد و هر مقدار را در ۶۰ نویسه کوتاه می‌کند؛ -o json مقدارها را کامل نشان می‌دهد. شناسه‌ای که به هیچ رکوردی که کلید شما بتواند بخواند اشاره نکند، پاسخ Not found می‌گیرد، و دستور با کد 3 خارج می‌شود.

ساختن یک رکورد#

status200 <resource> create --data <json> [-o <format>]
status200 <resource> create --file <path> [-o <format>]

--data رکورد را به‌صورت JSON می‌گیرد، و --file آن را از یک فایل JSON می‌خواند. یکی از این دو را بدهید؛ اگر هر دو داده شوند، فایل به کار می‌رود. فیلدها همان فیلدهای API هستند، و مرجع API فیلدهای هر منبع را فهرست می‌کند. پروژه از کلید API می‌آید، پس هیچ رکوردی نام آن را نمی‌آورد.

# A manual monitor
status200 monitor create --data '{"name":"Checkout API","monitorType":"Manual"}'

# An incident with one of your severities
status200 incident create --data '{"title":"Checkout API is down","incidentSeverityId":"<severity-id>"}'

# The same incident, from a file
status200 incident create --file incident.json

CLI رکورد تازه را همراه با _id آن چاپ می‌کند. یک حادثه در وضعیت ساخته‌شدهٔ پروژهٔ شما آغاز می‌شود، مگر این‌که currentIncidentStateId وضعیت دیگری را نام ببرد: وضعیتی که رکورد تازه در آن آغاز می‌شود را ببینید. برای یافتن شناسه‌های سطح‌های شدت خود:

status200 incident-severity list -o json | jq -r '.[] | "\(._id)  \(.name)"'

به‌روزرسانی یک رکورد#

status200 <resource> update <id> --data <json> [-o <format>]

--data الزامی است و فقط فیلدهایی را که باید تغییر کنند در بر دارد:

# Rename a monitor
status200 monitor update <monitor-id> --data '{"name":"Checkout API (EU)"}'

# Move an incident to your resolved state
status200 incident update <incident-id> --data '{"currentIncidentStateId":"<resolved-state-id>"}'

Status200 به یک به‌روزرسانی با یک شیء خالی پاسخ می‌دهد: CLI یک سطر خالی چاپ می‌کند، یا با -o json، {} را. برای دیدن رکورد در وضعیت کنونی‌اش get را اجرا کنید. بردن یک حادثه به وضعیتی دیگر به این روش، تغییر را مانند داشبورد روی خط زمانی آن ثبت می‌کند، و وضعیتی پیش از وضعیت کنونی آن رد می‌شود. برای یافتن شناسهٔ وضعیت حل‌شده، که نخستین وضعیت در ترتیب پروژهٔ شماست:

status200 incident-state list --query '{"isResolvedState":true}' --sort '{"order":"ASC"}' --limit 1 -o json | jq -r '.[0]._id'

حذف یک رکورد#

status200 <resource> delete <id>

status200 monitor delete 6f1c2a40-3b1e-4c55-9a0b-3e2f8d7c1a11

پاسخ آن Monitor 6f1c2a40-3b1e-4c55-9a0b-3e2f8d7c1a11 deleted successfully. است.

شمردن رکوردها#

status200 <resource> count [--query <json>]

# Every incident
status200 incident count

# Incidents that are not resolved
status200 incident count --query '{"currentIncidentState":{"isResolvedState":false}}'

CLI یک عدد چاپ می‌کند، در جدول و در JSON یکسان، تا اسکریپت بتواند آن را همان‌طور که هست بخواند.

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

عیب‌یابی#

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