文档首页/ 云地图服务 KooMap/ API参考/ API/ 实景三维任务管理/ 展示工作共享空间内任务概览
更新时间：2024-05-17 GMT+08:00
查看PDF
分享

展示工作共享空间内任务概览

功能介绍

该接口用于展示工作共享空间内任务的概览信息。包含：

  • 任务总数（total_count）：在该空间内已创建的实景三维任务数量。

  • 运行中数量（running_count）：在该空间内正在运行的实景三维任务数量，包含的任务状态有PENDING、STARTING、RUNNING、STOPPING。

  • 成功数量（success_count）：在该空间内执行成功的任务数量，包含的任务状态有SUCCESS、STOP_SUCCESS。

  • 失败数量（failed_count）：在该空间内执行失败的任务数量，包含的任务状态有START_FAILED、FAILED。

  • 已归档数量（archived_count）：在该空间内已归档的任务数量，包含的任务状态有ARCHIVED。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

GET /v1/real3d/{workspace_id}/tasks/overview

表1 路径参数

参数

是否必选

参数类型

描述

workspace_id

是

String

工作共享空间ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

IAM Token信息，用于租户鉴权，该字段由租户请求IAM的Token接口获得。

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

workspace_id

String

统计的工作共享空间ID。

total_count

Integer

任务总数。

running_count

Integer

运行中数量。

success_count

Integer

成功数量。

failed_count

Integer

失败数量。

archived_count

Integer

已归档数量。

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码。格式为：KMP.XXXXXXXX，其中X表示数字。

最小长度：12

最大长度：12

error_msg

String

错误描述。

最小长度：2

最大长度：512

状态码： 500

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码。格式为：KMP.XXXXXXXX，其中X表示数字。

最小长度：12

最大长度：12

error_msg

String

错误描述。

最小长度：2

最大长度：512

请求示例

该请求获取工作共享空间内任务的概览信息。

GET https://{Endpoint}/v1/real3d/c734a30b6c5f42cfaf49e01eb6903xxx/tasks/overview

响应示例

状态码： 200

请求成功。

{
  "workspace_id" : "c734a30b6c5f42cfaf49e01eb6903xxx",
  "total_count" : 1,
  "running_count" : 0,
  "success_count" : 1,
  "failed_count" : 0,
  "archived_count" : 0
}

状态码

状态码

描述

200

请求成功。

400

非法请求。

500

服务内部错误。

错误码

请参见错误码。

相关文档