はじめに

顧客の観測を休止・再開する

この依頼で使う

「契約の休止中は計測を止めて、再開時に戻したい」

取得前に決める

対象顧客、停止日時、再開条件、残す履歴を指定します。停止期間の未収集データをゼロ値や遡及収集済みと扱いません。

顧客の観測履歴を残して収集を止め、再開時の測定枠と設定を確認します。

前提条件

顧客ワークスペースを管理できる権限を持つアカウントで認証します。書き込み前に対象顧客と現在の lifecycle status を確認します。

この手順は npm CLI 0.6.0(beta タグ)以降を使います。CLI ワークフロー一覧のコマンドでインストールしてください。

クイックリファレンス

プレースホルダーは対象の workspace ID と request ごとの idempotency key に置き換えます。dry-run と確定 request には別の idempotency key を使います。

orc workspaces get YOUR_CLIENT_WORKSPACE_ID --json
orc workspaces pause YOUR_CLIENT_WORKSPACE_ID --idempotency-key YOUR_PAUSE_IDEMPOTENCY_KEY --yes --json
orc workspaces get YOUR_CLIENT_WORKSPACE_ID --json
orc workspaces resume YOUR_CLIENT_WORKSPACE_ID --dry-run --idempotency-key YOUR_DRY_RUN_IDEMPOTENCY_KEY --json
orc workspaces resume YOUR_CLIENT_WORKSPACE_ID --idempotency-key YOUR_RESUME_IDEMPOTENCY_KEY --yes --json
orc workspaces get YOUR_CLIENT_WORKSPACE_ID --json

1. 止める対象を確認する

workspaces get で顧客、lifecycle_status、paused_at、running_runs を確認します。pause は archive や個別 prompt の disable とは別の操作です。過去の履歴と workspace の測定枠は保持されます。

2. 休止状態と履歴を確認する

workspaces pause の後に同じ workspace を読みます。lifecycle_status が paused になり、新しい観測が開始されないことを確認します。pause の時点で実行中の Run は取り消されず、running_runs が 0 になるまで完走します。

3. 枠を確認して再開する

workspaces resume --dry-run で、再開後の状態、質問数、AI、cadence、entitlement の超過を読みます。dry-run は状態を変更しません。問題がなければ --dry-run なしで再開します。観測は次の定期 window から始まり、休止中の期間を遡及収集しません。

途中で止まった場合

pause または resume の応答を受け取れなかった場合は、その request と同じ idempotency key で再送します。状態を確認してから再開する場合は、新しい idempotency key で --dry-run を実行します。workspace_archived または workspace_expired が返る場合は、workspace を再開できません。

失敗が残る場合は、失敗を報告して再検証するで、このワークフローと失敗した手順を報告へ添えます。