归档/取消归档任务
功能介绍
任务的归档和取消归档操作,归档成功之后的任务不会在任务列表显示。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
POST /v1/kmp-control/tasks/archive
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
archived |
是 |
Boolean |
是否归档。
|
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
IAM Token信息,用于租户鉴权,该字段由租户请求IAM的Token接口获得。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
id |
是 |
String |
任务或者工作空间ID。 |
响应参数
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
请求ID,用于运维人员定位请求日志。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 |
error_msg |
String |
错误描述。 最小长度:2 最大长度:512 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
X-request-id |
String |
请求ID,用于运维人员定位请求日志。 |
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码。格式为:KMP.XXXXXXXX,其中X表示数字。 最小长度:12 最大长度:12 |
error_msg |
String |
错误描述。 最小长度:2 最大长度:512 |
请求示例
-
归档任务。
POST https://{Endpoint}/v1/kmp-control/tasks/archive?archived=true { "id" : "0004d71bcb51497f89b5c79254d6xxxx" }
-
取消归档任务。
POST https://{Endpoint}/v1/kmp-control/tasks/archive?archived=false { "id" : "0004d71bcb51497f89b5c79254d6xxxx" }
响应示例
状态码: 200
请求成功。
true
状态码
状态码 |
描述 |
---|---|
200 |
请求成功。 |
400 |
非法请求。 |
500 |
服务内部错误。 |
错误码
请参见错误码。