​

activity

orc activity は、Workspaceに記録された操作履歴をターミナルから確認するコマンドです。list で新しい順に一覧表示し、操作種別・操作主体の種類・日時範囲・プロジェクトIDで絞り込めます。types で、そのWorkspaceに記録されている操作種別を調べられます。get では一件のイベントの時刻、操作主体、操作種別、対象、記録されたメタデータを確認できます。

操作対象は選択したWorkspaceです。--workspace で今回の呼び出しの対象を指定できます。プロジェクトを指定しない一覧は、そのWorkspace内の記録を対象にします。招待の送信やAPIキーの変更など、誰がいつ操作したかを調べる場合に使用します。runの処理経過を調べる場合は orc logs を参照してください。

実行にはCLIの認証と、対象Workspaceの workspace:settings 権限が必要です。操作が履歴へ記録されている範囲を表示します。すべての処理の成功・失敗を示す共通の結果フィールドはありません。

選択中のWorkspaceの操作履歴を表示する。

操作種別で絞り込む。

一件のイベントを取得する。

Workspaceに記録された操作種別を調べる。

--type は api_key.created などの操作種別を指定して、完全一致で絞り込みます。複数の値をカンマで区切ると、いずれかの種別に一致する記録を返します。1回に最大50種別を指定できます。指定できる記録済みの値は orc activity types で確認してください。--action でも操作種別を一つ指定できます。両方を指定すると、両方の条件に一致する記録を返します。--actor-type は user、api_key、service_account、system のいずれかです。複数の条件を指定すると、すべてに一致する記録を返します。

ユーザーによるAPIキーの作成・失効の記録を表示します。

--since は指定時刻以降、--until は指定時刻より前の記録を返します。UTCの Z またはタイムゾーンオフセットを含むISO 8601形式で指定してください。片方だけでも指定できます。両方を指定する場合、--since は --until より前である必要があります。7d や 30d などの相対期間は受け付けません。

5月1日以降、6月1日より前に記録された操作を表示します。

--project-id は、選択したWorkspaceの中でプロジェクトIDが一致する記録を取得します。プロジェクト名の解決や、作業ディレクトリからのプロジェクト自動選択は行いません。プロジェクトIDが記録されていない操作は、このフィルターを付けた一覧には含まれません。

WorkspaceとプロジェクトIDを指定して絞り込みます。

--limit は一ページの最大件数です。既定値は50件で、1から200までの整数を指定できます。--cursor はAPIが返した next_cursor を変更せず渡すためのオプションです。同じWorkspaceとフィルターを維持し、カーソルを作成したり解読したりしないでください。

全ページを取得する場合は、共通オプションの --page-all を使います。各記録を一行ずつNDJSONで出力し、次のページがなくなるまで取得します。

操作記録をページごとに取得し、一行ずつ出力します。

選択したWorkspaceの記録済み操作を、作成時刻の新しい順に一覧表示します。同じ時刻のイベントはIDの降順で並びます。各項目にはイベントID、Workspace ID、操作主体の種類とID、操作種別、対象の種類とID、時刻、メタデータが含まれます。操作主体や対象のIDは記録によって空の場合があります。

enum: user|api_key|service_account|system

型: string。任意。

value

型: string。任意。

value

型: string。任意。

Recorded operation types to match (OR). Accepts repeated query parameters or comma-separated values. Combines with action and other filters using AND. Use activity types to discover types recorded in this workspace.; csv

型: string。任意。

Inclusive start timestamp in ISO 8601 format, including UTC Z or a timezone offset. Must be earlier than until when both are provided.; max 64 chars

型: string。任意。

Exclusive end timestamp in ISO 8601 format, including UTC Z or a timezone offset.; max 64 chars

型: string。任意。

ユーザーの操作だけを取得する。

選択したWorkspaceの履歴に実際に記録された操作種別を、アルファベット順の一覧で返します。すべての可能な操作のカタログではなく、履歴にない種別は含みません。履歴が空の場合は空の一覧になります。--type の値を確認するときに使用します。

記録された操作種別をJSONで表示する。

list で確認したイベントIDを指定し、その記録を取得します。取得対象は選択したWorkspace内に限られます。存在しないイベントと、別のWorkspaceに属するイベントはどちらも404になります。

Workspaceを指定して一件の記録を取得する。

--json または --format json はCLIのJSON envelopeで出力します。JSONの記録には workspace_id が含まれます。

Workspace内の記録をJSONで取得する。

期間と複数の操作種別を組み合わせる。

操作種別を絞り込んで一ページ取得する。

絞り込んだ操作を全ページ取得する。

認証・認可エラーの終了コードは2です。認証状態は orc status で確認してください。403の場合は、対象Workspaceと workspace:settings 権限を確認します。Workspaceを変更する場合は --workspace <workspace-id> を明示して再実行してください。

--action、--type、--actor-type、日時範囲、--project-id の条件を外し、同じWorkspaceで list を実行して確認します。操作が記録されていない場合や、プロジェクトIDが付いていない場合もあります。get が404の場合は、イベントIDと対象Workspaceを一覧で確認してください。

別のAPIのカーソルや変更した値を渡さず、最初のページからやり直してください。全件の読み出しには --page-all を使用できます。

日時にはタイムゾーン付きのISO形式を指定し、開始と終了の順序を確認してください。--type には空の値や末尾のカンマを付けず、orc activity types で確認した値を使います。履歴にまだ存在しない種別は一覧に表示されません。

一覧・個別取得のどちらも、対象Workspaceの workspace:settings 権限が必要です。認証なしでは取得できません。別のWorkspaceに属するイベントIDを指定しても、そのイベントの内容は返されません。

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

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