CLI を使い始める
domains
@orchestor-inc/cli のコマンドリファレンスです。
コマンド一覧
orc domains list— List tracked domainsorc domains create— Register a tracked domainorc domains get— Get a tracked domainorc domains update— Update a tracked domainorc domains delete— Soft-delete a tracked domainorc domains verify— Trigger DNS verification for a domainorc domains verification get— Get domain verification statusorc domains verification refresh— Recheck domain verification
orc domains list
List tracked domains
構文
orc domains list [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--brand-id | string | いいえ | Filter by brand. |
--role | string | いいえ | Filter by role.; enum: primary|alternate |
--verification-status | string | いいえ | enum: unverified|pending|verified|failed |
--ingestion-status | string | いいえ | enum: not_configured|configured|active|error |
--limit | number | いいえ | Maximum number of items to return |
--cursor | string | いいえ | Opaque cursor for the next page |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc domain list
ヘルプ
orc domains list --helporc domains create
Register a tracked domain
構文
orc domains create [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--idempotency-key | string | いいえ | Unique key for idempotent POST requests (24h TTL). If a request with the same key was already processed, the original response is returned without re-executing the operation. Reusing a key with a different request payload returns 409 idempotency_error. Use a UUID v4 or similar unique identifier. |
--domain | string | いいえ | (required) Body field: domain |
--brand-id | string | いいえ | (required) Body field: brand_id |
--role | string | いいえ | Body field: role; enum: primary|alternate |
--verification-method | string | いいえ | Body field: verification_method; enum: dns_txt|file_upload|manual; (use "null" or "reset" to clear) |
--ingestion-method | string | いいえ | Body field: ingestion_method; enum: log_forwarder|edge_worker|manual_upload; (use "null" or "reset" to clear) |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
ヘルプ
orc domains create --helporc domains get
Get a tracked domain
構文
orc domains get <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Path parameter: id |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc domain get
ヘルプ
orc domains get --helporc domains update
Update a tracked domain
構文
orc domains update <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Path parameter: id |
フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--role | string | いいえ | Body field: role; enum: primary|alternate |
--verification-method | string | いいえ | Body field: verification_method; enum: dns_txt|file_upload|manual; (use "null" or "reset" to clear) |
--ingestion-method | string | いいえ | Body field: ingestion_method; enum: log_forwarder|edge_worker|manual_upload; (use "null" or "reset" to clear) |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
ヘルプ
orc domains update --helporc domains delete
Soft-delete a tracked domain
構文
orc domains delete <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Path parameter: id |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
ヘルプ
orc domains delete --helporc domains verify
Trigger DNS verification for a domain
構文
orc domains verify <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Path parameter: id |
フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--idempotency-key | string | いいえ | Unique key for idempotent POST requests (24h TTL). If a request with the same key was already processed, the original response is returned without re-executing the operation. Reusing a key with a different request payload returns 409 idempotency_error. Use a UUID v4 or similar unique identifier. |
--method | string | いいえ | Body field: method; enum: dns_txt|file_upload|manual |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
ヘルプ
orc domains verify --helporc domains verification get
Get domain verification status
構文
orc domains verification get <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Path parameter: id |
フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--idempotency-key | string | いいえ | Unique key for idempotent POST requests (24h TTL). If a request with the same key was already processed, the original response is returned without re-executing the operation. Reusing a key with a different request payload returns 409 idempotency_error. Use a UUID v4 or similar unique identifier. |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
ヘルプ
orc domains verification get --helporc domains verification refresh
Recheck domain verification
構文
orc domains verification refresh <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Path parameter: id |
フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--idempotency-key | string | いいえ | Unique key for idempotent POST requests (24h TTL). If a request with the same key was already processed, the original response is returned without re-executing the operation. Reusing a key with a different request payload returns 409 idempotency_error. Use a UUID v4 or similar unique identifier. |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc domains verification recheck
ヘルプ
orc domains verification refresh --help