CreateSensitiveScanTask - 创建敏感信息扫描任务

Updated at:

用于创建图片敏感信息扫描任务并返回任务ID。

接口说明

请求说明

  • ImageUrl 必填,且必须是公网可访问的 HTTP/HTTPS 地址。

  • 目前暂不支持外网图片,仅支持国内公网可访问的图片 URL。推荐先将图片上传到国内地域的阿里云 OSS Bucket,再使用图片预签名 URL 作为本接口入参。参考文档:如何获取单个或多个文件的 URL

  • 通过 ImageUrl 上传的图片大小不能超过 10 MB。

  • 可选参数 ClientToken 用于保证请求的幂等性,由客户端生成该参数值,要保证在不同请求间唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

aideepsign:CreateSensitiveScanTask

create

*全部资源

*

无 无

请求参数

名称

类型

必填

描述

示例值

ClientToken

string

否

用于保证请求的幂等性。由客户端生成该参数值,要保证在不同请求间唯一。ClientToken 只支持 ASCII 字符,且不能超过 64 个字符。

5A2CFF0E-5718-45B5-9D4D-70B3FF3898

ImageUrl

string

否

待扫描图片的 URL 地址,仅支持 HTTP/HTTPS 协议。图片大小不超过 10 MB。ImageUrl 与 ObjectKey 二选一,至少提供一个。

https://example.com/document.jpg

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

A1B2C3D4-E5F6-7890-ABCD-EF1234567890

TaskId

string

任务 ID,用于调用 GetSensitiveScanResult 查询结果。

f47ac10b-58cc-4372-a567-0e02b2c3d479

Success

boolean

表示是否调用成功。true:调用成功。 false:调用失败。

True

Message

string

附加信息

null

HttpStatusCode

integer

HTTP 状态码。

200

Code

string

内部错误码。

OK

示例

正常返回示例

JSON格式

{
  "RequestId": "A1B2C3D4-E5F6-7890-ABCD-EF1234567890",
  "TaskId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "Success": true,
  "Message": "null",
  "HttpStatusCode": 200,
  "Code": "OK"
}

错误码

HTTP status code

错误码

错误信息

描述

400 IdempotentParameterMismatch The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情。