任务列表查询
功能介绍
查询批量图像内容审核任务列表,可通过指定任务状态查询来对任务列表进行过滤。
URI
GET /v2/{project_id}/moderation/image/batch/jobs
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID。获取方法请参见获取项目ID。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
status |
否 |
String |
图像内容审核任务处理状态如下:
|
offset |
否 |
Integer |
偏移量, 默认为0。 |
limit |
否 |
Integer |
指定每一页返回的最大条目数,默认为符合查询条件的总任务数量。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用户Token。 用于获取操作API的权限。获取方法请参见获取Token接口,响应消息头中X-Subject-Token的值即为Token。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
result |
Array of CheckTaskJobsItemsBody objects |
调用成功时表示调用结果。 调用失败时无此字段。 |
count |
Integer |
符合查询条件的总任务数量。 |
参数 |
参数类型 |
描述 |
---|---|---|
job_id |
String |
任务标识。 |
status |
String |
任务状态如下:
|
create_time |
String |
任务创建的时间。例如:2018-01-02T15:03:04Z。 |
update_time |
String |
任务最近更新的时间。例如:2018-01-02T15:03:04Z。 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
调用失败时的错误码,具体请参见错误码。 调用成功时无此字段。 |
error_msg |
String |
调用失败时的错误信息。 调用成功时无此字段。 |
fail_category |
String |
当包含多个场景时,调用失败的场景。 |
请求示例
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 |
失败响应示例。 |
错误码
请参见错误码。