Method: tasks.cancel

進行中のタスクをキャンセルします。

HTTP リクエスト

POST https://ces.googleapis.com/tasks/{id}:cancel

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
id

string

必須。キャンセルするタスクのリソース ID。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "tenant": string,
  "metadata": {
    object
  }
}
フィールド
tenant

string

省略可。不透明なルーティング識別子。このフィールドが設定されている場合、エージェント カードで選択した AgentInterface の tenant 値と一致する必要があります。
metadata

object (Struct format)

追加のコンテキストやパラメータを渡すための柔軟な Key-Value マップ。

レスポンスの本文

成功した場合、レスポンスの本文には Task のインスタンスが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

詳細については、Authentication Overview をご覧ください。