调用ScanOssObjectV1接口为对应存储对象创建敏感数据识别的扫描任务。
接口说明
前置条件
对应的 Bucket 需要授权并连接后才能调用本接口,若 Bucket 未授权,调用 API 会返回 bucket_not_authorized 错误码。
QPS 限制
本接口的单用户 QPS 限制为 10 次/秒。超过限制,API 调用将会被限流,这可能影响您的业务,请合理调用。
使用说明
根据接口返回的任务 ID 可调用 DescribeIdentifyTaskStatus 接口来查看任务的运行状态。
任务完成后可根据 BucketName、ServiceRegionId 和 ObjectKey 调用 DescribeOssObjectDetailV2 接口来查看对应存储对象的敏感数据识别结果。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
yundun-sddp:ScanOssObjectV1 |
none |
*全部资源
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
ServiceRegionId |
string |
是 |
服务地域 ID,即 OSS Bucket 所在的地域 ID。 |
cn-hangzhou |
BucketName |
string |
是 |
OSS Bucket 名称。 |
sddp-api-demo-bucket |
ObjectKeyList |
array |
是 |
待扫描的 OSS Bucket 中存储对象列表,一次最多可输入 50 个 ObjectKey。 |
|
string |
否 |
OSS Bucket 中存储对象名称,需要传入完整路径。 |
dir1/object.txt |
|
TemplateId |
integer |
否 |
行业模版 ID。 说明
可调用 DescribeCategoryTemplateList 获取模版列表,如不填本参数,默认使用主用模板来进行扫描。 |
1 |
Lang |
string |
否 |
请求和接收消息的语言类型。取值:
|
zh |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
Schema of Response |
||
RequestId |
string |
本次调用请求的 ID,是由阿里云为该请求生成的唯一标识符,可用于排查和定位问题。 |
7C3AC882-E5A8-4855-BE77-B6837B695EF1 |
Id |
integer |
创建识别任务成功后,返回的识别任务 ID。 |
268 |
示例
正常返回示例
JSON
格式
{
"RequestId": "7C3AC882-E5A8-4855-BE77-B6837B695EF1",
"Id": 268
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。