Method: tasks.cancel

取消正在进行的任务。

HTTP 请求

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

网址采用 gRPC 转码语法。

路径参数

参数
id

string

必需。要取消的任务的资源 ID。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "tenant": string,
  "metadata": {
    object
  }
}
字段
tenant

string

可选。不透明的路由标识符。如果设置了该字段，则必须与代理卡片中所选 AgentInterface 的 tenant 值一致。
metadata

object (Struct format)

用于传递其他上下文或参数的灵活键值对映射。

响应正文

如果成功，则响应正文包含一个 Task 实例。

授权范围

需要以下 OAuth 范围之一：

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

如需了解详情，请参阅 Authentication Overview。