文档中心

查询所有审核任务

最近更新时间：2024.04.19 11:10:08

首次发布时间：2023.12.28 11:22:02

本接口支持通过指定审核类型，查询该类型下所有审核任务。

注意事项

请求频率：单用户请求频率限制为 5 次/秒。
超时时间：约为 10 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。详情参见服务地址。

请求说明

请求方式：GET
请求地址：https://imagex.volcengineapi.com/?Action=GetImageAuditTasks&Version=2023-05-01

调试

API Explorer

您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetImageAuditTasks`	接口名称。当前 API 的名称为 `GetImageAuditTasks`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。
Region	String	否	`cn`	任务地区。仅支持默认取值 `cn`，表示国内。
Type	String	否	`UrlFile`	审核场景，缺省情况下查询全部场景的任务。取值如下所示： `UrlFile`：上传 txt 审核文件处理场景 `Url`：上传审核图片 URL 处理场景 `Upload`：图片上传场景
AuditAbility	String	否	`0`	审核能力，缺省情况下查询全部审核类型的任务。取值如下所示： `0`：基础审核能力 `1`：智能审核能力
Status	String	否	`Running`	审核状态，缺省情况下查询全部状态的任务。取值如下所示： `Running`：审核中 `Suspend`：已暂停 `Done`：已完成 `Failed`：审核失败 `Cancel`：已取消
TaskType	String	是	`audit`	审核任务类型，当前仅支持取值为 `audit`。
Limit	String	否	`100`	分页查询时，显示的每页数据的最大条数。取值范围为 (0,100]，默认值为 100。
Offset	String	否	`0`	分页偏移量，用于控制分页查询返回结果的起始位置，以便对数据进行分页展示和浏览。默认值为 0。说明例如，指定分页条数 Limit = 10，分页偏移量 Offset = 10，表示从查询结果的第 11 条记录开始返回数据，共展示 10 条数据。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
Tasks	Array of Tasks	`-`	审核任务详情
Total	Integer	`1`	符合请求的审核任务数量

Tasks

参数	类型	示例值	描述
ServiceId	String	`lk**i0`	该审核任务所在的服务 ID
Id	String	`653068d***af748040`	审核任务 ID
TaskType	String	`audit`	审核任务类型
Status	String	`Done`	该条审核任务的状态，取值如下所示： `Running`：审核中 `Suspend`：已暂停 `Done`：已完成 `Failed`：审核失败 `Cancel`：已取消
CreateAt	String	`2023-10-19 07:22:58`	该审核任务的创建时间
UpdateAt	String	`2023-10-19 07:22:58`	该审核任务的更新时间
AuditTask	Object of AuditTask	`-`	审核任务详情
Type	String	`UrlFile`	审核场景，取值如下所示： `UrlFile`：上传 txt 审核文件处理场景 `Url`：上传审核图片 URL 处理场景 `Upload`：图片上传场景
ResUri	Array of String	`["service/audit.txt"]`	仅当 `Type` 值为 `UrlFile` 时，有返回值。表示 txt 审核文件的存储 URI。

AuditTask

参数	类型	示例值	描述
ImageInfos	Array of ImageInfos	`-`	仅当 Type 取值 Url 时，有返回值。表示上传的待审核图片 Url 列表详情。
EnableAuditRange	Integer	`0`	仅当 `Type` 取值 `Upload` 时，有返回值。审核范围，取值如下所示： `0`：不限范围 `1`：指定范围
NoAuditPrefix	Array of String	`["a/"]`	仅当 `EnableAuditRange` 取值 `1` 时，有返回值。表示指定不审核的目录前缀。
AuditPrefix	Array of String	`["b/"]`	仅当 `EnableAuditRange` 取值 `1` 时，有返回值。表示指定审核的目录前缀。
AuditAbility	Integer	`1`	审核能力，取值如下所示： `0`：基础审核能力 `1`：智能审核能力
AuditDimensions	Array of String	`["porn","sexy"]`	指定的审核维度
AuditTextDimensions	Array of String	`["ad"]`	指定的智能安全审核类型下图片文本审核维度。
EnableLargeImageDetect	Boolean	`false`	是否开启大图审核，取值如下所示： `true`：开启 `false`：不开启
EnableFreeze	Boolean	`true`	是否开启冻结，取值如下所示： `true`：开启 `false`：不开启
FreezeType	Array of String	`["nopass","recheck"]`	指定的冻结措施，取值如下所示： `recheck`：建议复审 `nopass`：审核不通过
FreezeDimensions	Array of String	`["porn","sexy","ad"]`	指定的冻结维度
FreezeStrategy	Integer	`0`	冻结策略，当前仅支持取 `0`，表示禁用图片。
EnableCallback	Boolean	`true`	是否开启回调，取值如下所示： `true`：开启 `false`：不开启
CallbackDimensions	Array of String	`["ad"]`	指定的回调类型
CallbackImageTypes	Array of String	`["problem","frozen","fail"]`	回调图片类型，取值如下所示： `normal`：正常图片 `problem`：问题图片 `frozen`：冻结图片 `fail`：审核失败图片
CallbackUrl	String	`http://example.callback.com`	指定的回调 URL
ProcessedNumber	Integer	`0`	审核中的图片数量
FailedCount	Integer	`0`	审核失败的图片数量
SuccessCount	Integer	`0`	审核成功的图片数量

ImageInfos

参数	类型	示例值	描述
ImageUri	String	`https://test.png`	待审核图片的 URL
DataId	String	`92bodw28122j19***018h3i1928g`	自定义的区分图片的标识

请求示例

GET https://imagex.volcengineapi.com/?Action=GetImageAuditTasks&Version=2023-05-01&AuditAbility=0&Limit=100&Offset=0&Region=cn&Status=Running&TaskType=audit&Type=UrlFile

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306041104200100100232280022D31",
    "Action": "GetImageAuditTasks",
    "Version": "2023-05-01",
    "Service": "ImageX",
    "Region": "cn-north-1"
  },
  "Result": {
    "Tasks": [
      {
        "Id": "653068d***af748040",
        "ServiceId": "lk**i0",
        "TaskType": "audit",
        "Type": "UrlFile",
        "ResUri": [
          "service/audit.txt"
        ],
        "AuditTask": {
          "EnableAuditRange": 0,
          "AuditPrefix": null,
          "NoAuditPrefix": null,
          "AuditAbility": 1,
          "AuditDimensions": [
            "porn",
            "sensitive1",
            "sensitive2"
          ],
          "EnableFreeze": true,
          "FreezeDimensions": [
            "porn",
            "sensitive1"
          ],
          "FreezeType": [
            "nopass",
            "recheck"
          ],
          "FreezeStrategy": 0,
          "EnableCallback": true,
          "CallbackDimensions": [
            "porn",
            "sensitive1"
          ],
          "CallbackImageTypes": [
            "problem",
            "frozen"
          ],
          "CallbackUrl": "http://example.callback.com",
          "ProcessedNumber": 0,
          "SuccessCount": 0,
          "FailedCount": 0,
          "EnableLargeImageDetect": true,
          "AuditTextDimensions": [
            "ad"
          ],
          "BizType": "210005**1697671378",
          "AppId": "53**41"
        },
        "CreateAt": "2023-10-19 07:22:58",
        "UpdateAt": "2023-10-19 07:22:58",
        "Status": "Done"
      }
    ],
    "Total": 1
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码和 veImageX 错误码。

服务端 SDK

veImageX 提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。