CreateScanTask - 创建扫描任务

调用CreateScanTask接口为识别权限授权成功的资产创建识别敏感数据的定制化扫描任务。

接口说明

本接口适用于用户针对已授权的资产定制扫描任务,便于用户灵活控制扫描任务的运行时间间隔及每次扫描任务的运行时间。

QPS 限制

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

调试

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

授权信息

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

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

请求参数

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

实例、库、Bucket 数据资产的唯一标识 ID,可以调用 DescribeDataLimits 获取。

1
IntervalDayinteger

连续两个自定义扫描资产任务的间隔天数,取值范围:1~2147483648。

1
RunHourinteger

下次扫描任务的运行时间。单位:小时。

12
RunMinuteinteger

下次扫描任务的运行时间。单位:分钟。

30
TaskNamestring

扫描任务的名称。

scan-test-sample****
TaskUserNamestring

创建扫描任务的账号。

demo
OssScanPathstring

扫描 OSS 资产的扫描范围,支持前缀、后缀、正则匹配。

/test/test
ScanRangeinteger

自定义扫描任务的扫描范围匹配规则,需结合 ScanRangeContent 的配置内容才能生效。取值:

  • 0:全部匹配。
  • 1:前缀匹配。
  • 2:后缀匹配。
  • 3:正则匹配。
0
ScanRangeContentstring

在结构化数据资产的扫描范围内,通过前缀、后缀或正则匹配方式进行扫描。

说明 ScanRange 配置为 0 时,全部匹配此字段的内容; ScanRange 配置为 1 时,前缀匹配此字段的内容,如此字段配置为 test/abc,则匹配 test/abc 开头的文件路径;ScanRange 配置为 2 时,后缀匹配此字段的内容;ScanRange 配置为 3 时,通过正则表达式的方式匹配此字段的内容。
datamask/
ResourceTypelong

指定待查询产品的资源类型。取值:

  • 1:MaxCompute。
  • 2:OSS。
  • 3:ADS。
  • 4:OTS。
  • 5:RDS。
  • 6:SELF_DB。
2
SourceIpstring

该参数已废弃。

106.11.XX.XX
FeatureTypeinteger

此参数已废弃。

1
Langstring

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

  • zh:中文。

  • en:英文。

zh

返回参数

名称类型描述示例值
object
Idinteger

定制化扫描任务的资源 ID。

100
RequestIdstring

请求 ID。

B1F2BB1F-04EC-5D36-B136-B4DE17FD8DE0

示例

正常返回示例

JSON格式

{
  "Id": 100,
  "RequestId": "B1F2BB1F-04EC-5D36-B136-B4DE17FD8DE0"
}

错误码

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

变更历史

变更时间变更内容概要操作
2024-03-25OpenAPI 入参发生变更查看变更详情