You need to enable JavaScript to run this app.
导航
查询所有审核任务
最近更新时间:2024.08.05 18:26:11首次发布时间:2023.10.20 18:03:21

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

说明

该接口属于历史版本 API,建议您使用新版 GetImageAuditTasks 接口。

注意事项

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

请求说明

  • 请求方式:GET
  • 请求地址:https://imagex.volcengineapi.com/?Action=GetImageAuditTasks&Version=2018-08-01

调试

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringGetImageAuditTasks接口名称。当前 API 的名称为 GetImageAuditTasks
VersionString2018-08-01接口版本。当前 API 的版本为 2018-08-01
RegionStringcn任务地区。仅支持默认取值 cn,表示国内。

Type

String

UrlFile

审核场景,缺省情况下查询全部场景的任务。取值如下所示:

  • UrlFile:上传 txt 审核文件处理场景
  • Url:上传审核图片 URL 处理场景
  • Upload:图片上传场景

AuditAbility

String

0

审核能力,缺省情况下查询全部审核类型的任务。取值如下所示:

  • 0:基础审核能力
  • 1:智能审核能力

Status

String

Running

审核状态,缺省情况下查询全部状态的任务。取值如下所示:

  • Running:审核中
  • Suspend:已暂停
  • Done:已完成
  • Failed:审核失败
  • Cancel:已取消
TaskTypeStringaudit审核任务类型,当前仅支持取值为 audit
LimitString100分页条数。取值范围为 (0,100],默认值为 100。
OffsetString0分页偏移量,默认为 0。取值为 1 时,表示跳过第一条数据,从第二条数据取值。

返回参数

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

参数类型示例值描述
TasksArray of Tasks-审核任务详情
TotalInteger1符合请求的审核任务数量

Tasks

参数类型示例值描述
ServiceIdString78**0k该审核任务所在的服务 ID
IdString33000****05165X审核任务 ID
TaskTypeStringaudit审核任务类型,当前仅支持取值为 audit

Status

String

Running

该条审核任务的状态,取值如下所示:

  • Running:审核中
  • Suspend:已暂停
  • Done:已完成
  • Failed:审核失败
  • Cancel:已取消
CreateAtString2023-10-19 07:22:58该审核任务的创建时间
UpdateAtString2023-10-19 07:22:58该审核任务的更新时间
AuditTaskObject of AuditTask-审核任务

Type

String

UrlFile

审核场景,取值如下所示:

  • UrlFile:上传 txt 审核文件处理场景
  • Url:上传审核图片 URL 处理场景
  • Upload:图片上传场景
ResUriArray of String指定服务/审核文件.txt仅当 Type 值为 UrlFile 时,有返回值。表示 txt 审核文件的存储 URI。

AuditTask

参数类型示例值描述
ImageInfosArray of ImageInfos-仅当 Type 取值 Url 时,有返回值。表示上传的待审核图片 Url 列表详情。

EnableAuditRange

Integer

0

仅当 Type 取值 Upload 时,有返回值。
审核范围,取值如下所示:

  • 0:不限范围
  • 1:指定范围
NoAuditPrefixArray of String["a/"]仅当 EnableAuditRange 取值 1 时,有返回值。表示指定不审核的目录前缀。
AuditPrefixArray of String["b/"]仅当 EnableAuditRange 取值 1 时,有返回值。表示指定审核的目录前缀。

AuditAbility

Integer

1

审核能力,取值如下所示:

  • 0:基础审核能力
  • 1:智能审核能力
AuditDimensionsArray of String["pron","sexy"]指定的审核维度
AuditTextDimensionsArray of String["ad"]指定的智能安全审核类型下图片文本审核维度。

EnableLargeImageDetect

Boolean

false

是否开启大图审核,取值如下所示:

  • true:开启
  • false:不开启

EnableFreeze

Boolean

true

是否开启冻结,取值如下所示:

  • true:开启
  • false:不开启

FreezeType

Array of String

["recheck","nopass"]

指定的冻结措施,取值如下所示:

  • recheck:建议复审
  • nopass:审核不通过
FreezeDimensionsArray of String["pron","sexy","ad"]指定的冻结维度
FreezeStrategyInteger0冻结策略,当前仅支持取 0,表示禁用图片。

EnableCallback

Boolean

true

是否开启回调,取值如下所示:

  • true:开启
  • false:不开启
CallbackDimensionsArray of String["ad"]指定的回调类型

CallbackImageTypes

Array of String

["problem","frozen","fail"]

回调图片类型,取值如下所示:

  • normal:正常图片
  • problem:问题图片
  • frozen:冻结图片
  • fail:审核失败图片
CallbackUrlStringhttps://example.callback.com指定的回调 URL
ProcessedNumberInteger85审核中的图片数量
FailedCountInteger4631审核失败的图片数量
SuccessCountInteger2629审核成功的图片数量

ImageInfos

参数类型示例值描述
ImageUriStringhttps://test.png待审核图片的 URL
DataIdStringtest自定义的区分图片的标识

示例

请求示例

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202306041104200100100232280022D31",
    "Action": "GetImageAuditTasks",
    "Version": "2018-08-01",
    "Service": "ImageX",
    "Region": "cn-north-1"
  },
  "Result": {
    "Tasks": [
      {
        "Id": "653068d***af748040",
        "ServiceId": "lk**i0",
        "AccountId": "21**08",
        "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"
        },
        "Creator": "creatorname",
        "CreateAt": "2023-10-19 07:22:58",
        "UpdateAt": "2023-10-19 07:22:58",
        "Status": "Done"
      }
    ],
    "Total": 1
  }
}

错误码

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

服务端 SDK

推荐您使用服务端 SDK 来调用 API,我们已在 GitHub 提供了 PHP 的参考示例