更新时间:2023-06-06 GMT+08:00

任务列表查询

功能介绍

查询批量图像内容审核任务列表,可通过指定任务状态查询来对任务列表进行过滤。

URI

GET /v2/{project_id}/moderation/image/batch/jobs

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID。获取方法请参见获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

status

String

图像内容审核任务处理状态如下:

  • created 已创建
  • running 正在处理
  • finish 已完成
  • failed 处理失败

offset

Integer

偏移量, 默认为0。

limit

Integer

指定每一页返回的最大条目数,默认为符合查询条件的总任务数量。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。

用于获取操作API的权限。获取方法请参见获取Token接口,响应消息头中X-Subject-Token的值即为Token。

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

result

Array of CheckTaskJobsItemsBody objects

调用成功时表示调用结果。

调用失败时无此字段。

count

Integer

符合查询条件的总任务数量。

表5 CheckTaskJobsItemsBody

参数

参数类型

描述

job_id

String

任务标识。

status

String

任务状态如下:

  • created 已创建
  • running 正在处理
  • finish 已完成
  • failed 处理失败

create_time

String

任务创建的时间。例如:2018-01-02T15:03:04Z。

update_time

String

任务最近更新的时间。例如:2018-01-02T15:03:04Z。

状态码: 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

调用失败时的错误码,具体请参见错误码

调用成功时无此字段。

error_msg

String

调用失败时的错误信息。

调用成功时无此字段。

fail_category

String

当包含多个场景时,调用失败的场景。

请求示例

“endpoint”即调用API的请求地址,不同服务不同区域的endpoint不同,具体请参见终端节点

例如,服务部署在“中国-香港”区域的“endpoint”“moderation.ap-southeast-1.myhuaweicloud.com”,请求URL为“https://moderation.ap-southeast-1.myhuaweicloud.com/v2/{project_id}/moderation/image/batch/jobs?status={status_type}”“project_id”为项目ID,获取方法请参见获取项目ID

GET https://{endpoint}/v2/{project_id}/moderation/image/batch/jobs?status={status_type}

响应示例

状态码: 200

成功响应示例

{
  "result" : [ {
    "job_id" : "44d93b70-db01-4f96-a618-2a79c964c4b2",
    "status" : "finish",
    "create_time" : "2018-11-22T06:17:09Z",
    "update_time" : "2018-11-22T06:17:16Z"
  } ],
 "count" : 1
}

状态码: 400

失败响应示例

{
  "error_code" : "AIS.0005",
  "error_msg" : "The service does not exist."
}

状态码

状态码

描述

200

成功响应示例。

400

失败响应示例。

错误码

请参见错误码