​

domains

orc domains は、ブランドに関連する検証・取り込み用Domainリソースを管理します。一覧・詳細・登録・更新・削除と、所有権検証の開始、状態確認、再確認を行います。primary と alternate のrole、検証状態、取り込み状態で一覧を絞れます。

認証と対象Workspaceへのアクセスが必要です。操作の id は一覧で返されたDomainリソースIDで、ホスト名ではありません。ブランドの domain・domains の登録とは別のリソースです。検証を開始する前に、保存された検証方法とtokenの公開手順を確認してください。

Domainリソースと検証状態を確認します。

削除されていないDomainを一覧します。--brand-id、--role、--verification-status、--ingestion-status は組み合わせて絞り込みます。cursorを続ける場合は条件を保持してください。

Filter by brand id in the selected workspace. Omit to include domains or suggestions for all brands.

型: string。任意。

Filter by the stored domain role. Omit to include both primary and alternate domains.; enum: primary|alternate

型: string。任意。

Filter by the stored ownership verification state. Omit to include all states.; enum: unverified|pending|verified|failed

型: string。任意。

Filter by the stored ingestion state. Omit to include all states.; enum: not_configured|configured|active|error

型: string。任意。

domain と現在のWorkspaceの brand_id が必須です。roleは既定で alternate、検証状態は unverified です。検証方法を設定するとtokenが作られますが、検証は開始しません。

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

(required) Hostname stored for ownership verification and ingestion, without a protocol or path.

型: string。任意。

(required) Existing non-deleted brand in the selected workspace to which this domain belongs.

型: string。任意。

Stored domain role: primary for the main domain, alternate for an additional domain. Defaults to alternate.; enum: primary|alternate

型: string。任意。

Ownership check method: dns_txt publishes the token in DNS; file_upload serves it at /.well-known/orchestor-domain-verify; manual requires support. Null means no method is configured. Omitted or null leaves the method unconfigured.; enum: |dns_txt|file_upload|manual; (use "null" or "reset" to clear)

型: string。任意。

Configured traffic ingestion method. Null means no method is selected. Omitted or null leaves the method unconfigured.; enum: |log_forwarder|edge_worker|manual_upload; (use "null" or "reset" to clear)

型: string。任意。

DNS検証用のDomainを登録する

Domain IDで詳細を取得します。tokenと検証手順は verification get から取得してください。不明・削除済み・Workspace外のIDは404です。

指定した role、verification_method、ingestion_method だけを変更します。非nullの検証方法を指定すると、同じ方法でもtokenを再生成し unverified に戻ります。nullは方法を解除しますが、保存tokenと状態を保持します。検証は開始しません。

Stored domain role: primary for the main domain, alternate for an additional domain. Omit to keep the stored value.; enum: primary|alternate

型: string。任意。

Ownership check method: dns_txt publishes the token in DNS; file_upload serves it at /.well-known/orchestor-domain-verify; manual requires support. Null means no method is configured. Omit to keep the stored value. A non-null value replaces the token and resets status to unverified. Null clears the method without clearing the existing token or status.; enum: |dns_txt|file_upload|manual; (use "null" or "reset" to clear)

型: string。任意。

Configured traffic ingestion method. Null means no method is selected. Omit to keep the stored value.; enum: |log_forwarder|edge_worker|manual_upload; (use "null" or "reset" to clear)

型: string。任意。

Domainを論理削除し、id と deleted: true を返します。以後の一覧・取得から外れます。不明・削除済みIDは404です。

保存済みの verification_method で非同期の所有権検証を開始します。方法が未設定なら400です。状態を pending にし、試行回数と以前のエラーをresetします。返された poll_url の状態を確認してください。

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

token公開後に検証を開始する

保存された状態・token・方法別の手順を取得します。verified状態の最終確認が24時間より前なら、背景の再確認を要求する場合があります。stale_recheck_enqueued は要求済みの印で、完了の印ではありません。

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

tokenと公開手順を取得する

設定済みの方法と公開したtokenで所有権を再確認します。202と poll_url を返し、状態は pending になります。tokenを再公開する必要がある場合は先に手順を確認してください。

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

Recheck domain verification

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

verify に方法を渡しても保存された設定を上書きしません。方法の変更は update --verification-method で行います。登録・検証設定だけで取り込みが稼働するとは限りません。取り込み方法は log_forwarder、edge_worker、manual_upload です。

対象Workspaceへのアクセスが必要です。変更操作には対応する書き込み権限が必要です。

orc domains では、次のグローバルオプションを使用できます。

各オプションの詳細と使用例は、グローバルオプションを参照してください。