查看任务概览
功能介绍
查看工作共享空间下的任务概览，包括全部任务数量以及成功、执行中、失败、已归档状态的任务数量。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
GET /v1/kmp-control/tasks/overview
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
workspace_id |
是 |
String |
任务所属工作共享空间ID。 最小长度：32 最大长度：32 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
X-Auth-Token |
是 |
String |
IAM Token信息，用于租户鉴权，该字段由租户请求IAM的Token接口获得。 |
响应参数
状态码： 200
参数 |
参数类型 |
描述 |
|---|---|---|
total |
Integer |
空间下任务总数。 缺省值：0 |
finished |
Integer |
空间下已处理完成任务，已归档任务总数量。 缺省值：0 |
unfinished |
Integer |
空间下执行中任务数量。 缺省值：0 |
状态码： 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 |
请求示例
查看工作共享空间下的任务概览情况。
GET https://{Endpoint}/v1/kmp-control/tasks/overview?workspace_id={workspace_id}
?workspace_id=8452429fe3e14ebd9958e2183a5b24cf
响应示例
状态码： 200
请求成功。
{
"total" : 10,
"finished" : 8,
"unfinished" : 2
}
状态码
状态码 |
描述 |
|---|---|
200 |
请求成功。 |
400 |
非法请求。 |
500 |
服务内部错误。 |
错误码
请参见错误码。
