ScanOssObjectV1 - 创建文件扫描任务

调用ScanOssObjectV1接口为对应存储对象创建敏感数据识别的扫描任务。

接口说明

前置条件

对应的 Bucket 需要授权并连接后才能调用本接口,若 Bucket 未授权,调用 API 会返回 bucket_not_authorized 错误码。

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用将会被限流,这可能影响您的业务,请合理调用。

使用说明

根据接口返回的任务 ID 可调用 DescribeIdentifyTaskStatus 接口来查看任务的运行状态。

任务完成后可根据 BucketName、ServiceRegionId 和 ObjectKey 调用 DescribeOssObjectDetailV2 接口来查看对应存储对象的敏感数据识别结果。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
yundun-sddp:ScanOssObjectV1none
  • 全部资源
    *

请求参数

名称类型必填描述示例值
ServiceRegionIdstring

服务地域 ID,即 OSS Bucket 所在的地域 ID。

cn-hangzhou
BucketNamestring

OSS Bucket 名称。

sddp-api-demo-bucket
ObjectKeyListarray

待扫描的 OSS Bucket 中存储对象列表,一次最多可输入 50 个 ObjectKey。

string

OSS Bucket 中存储对象名称,需要传入完整路径。

dir1/object.txt
TemplateIdlong

行业模版 ID。

说明 可调用 DescribeCategoryTemplateList 获取模版列表,如不填本参数,默认使用主用模板来进行扫描。
1
Langstring

请求和接收消息的语言类型。取值:

  • zh:中文。
  • en:英文。
zh

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。

7C3AC882-E5A8-4855-BE77-B6837B695EF1
Idlong

创建识别任务成功后,返回的识别任务 ID。

268

示例

正常返回示例

JSON格式

{
  "RequestId": "7C3AC882-E5A8-4855-BE77-B6837B695EF1",
  "Id": 268
}

错误码

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