更新时间：2026-11-12 GMT+08:00

取消冷热分离待下发任务 - CancelColdTableWaitingTasks

功能介绍

取消指定实例的待下发任务。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

如果使用角色与策略授权，具体权限要求请参见权限和授权项。

如果使用身份策略授权，需具备如下身份策略权限。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
gaussdbformysql:coldTable:operate	Write	instance *	g:EnterpriseProjectId g:ResourceTag/<tag-key>	gaussdb:coldTable:operate	-

URI

DELETE /v3/{project_id}/instances/{instance_id}/cold-tables/waiting-tasks

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：租户在某一Region下的project ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及。
instance_id	是	String	参数解释：实例ID，此参数是实例的唯一标识。获取方法请参见查询实例列表。约束限制：不涉及。取值范围：只能由英文字母、数字组成，后缀为in07，长度为36个字符。默认取值：不涉及。

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	是	String	参数解释：用户Token。通过调用IAM服务获取用户Token接口获取。请求响应成功后在响应消息头中包含的“X-Subject-Token”的值即为Token值。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
X-Language	否	String	参数解释：请求语言类型。约束限制：不涉及。取值范围： en-us：英文。 zh-cn：中文。默认取值： en-us。

表3 请求Body参数
参数	是否必选	参数类型	描述
cancel_tasks	是	Array of CancelColdTableWaitingTask objects	参数解释：取消目标列表。约束限制：列表长度不超过50。

表4 CancelColdTableWaitingTask
参数	是否必选	参数类型	描述
db_name	是	String	参数解释：数据库名。获取方法请参见查询冷热分离待下发任务列表。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
table_name	是	String	参数解释：表名。获取方法请参见查询冷热分离待下发任务列表。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
partition_name	否	String	参数解释：分区名。获取方法请参见查询冷热分离待下发任务列表。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
type	是	String	参数解释：任务类型。约束限制：不涉及。取值范围： waiting_archive：待归档。 waiting_unarchive：待回迁。默认取值：不涉及。

响应参数

状态码：200

无

状态码：400

表5 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误消息。

状态码：500

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误消息。

请求示例

批量取消db1库orders表p202301分区与logs整表的待下发任务。

DELETE https://{endpoint}/v3/619d3e78f61b4be68bc5aa0b59edcf7b/instances/a23fb62bd61e4e9e9636fd2225f395bein07/cold-tables/waiting-tasks

{
  "cancel_tasks" : [ {
    "db_name" : "db1",
    "table_name" : "orders",
    "partition_name" : "p202301",
    "type" : "waiting_archive"
  }, {
    "db_name" : "db1",
    "table_name" : "logs",
    "partition_name" : "",
    "type" : "waiting_unarchive"
  } ]
}

响应示例

无

状态码

状态码	描述
200	Success.
400	Client error.
500	Server error.

错误码

请参见错误码。

父主题：冷热分离