更新任务 - UpdateJob
功能介绍
功能介绍:更新扫描作业配置。 关键参数说明:通过job_id定位作业;name、asset_ids、cycle必填,校验逻辑与创建一致。 返回值说明:返回操作状态。
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
PUT /v1/{project_id}/sdg/scan/job/{job_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,标识用户在数据安全中心控制台中创建的项目 约束限制: 不涉及 取值范围: 长度为32个字符的字符串 默认取值: 不涉及 |
| job_id | 是 | String | 参数解释: 扫描作业ID,标识需要更新的扫描作业,可通过创建扫描任务接口的返回结果或调用查询任务列表接口获取 约束限制: 不涉及 取值范围: 长度1~64个字符 默认取值: 不涉及 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token,用于接口请求鉴权,可通过调用IAM服务查询用户Token接口获取 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| name | 是 | String | 参数解释: 扫描任务名称 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
| asset_scope | 否 | Array of AssetScope objects | 参数解释: 作业范围,数组元素为AssetScope对象 约束限制: 数组最大500个元素 取值范围: 不涉及 默认取值: 不涉及 |
| asset_ids | 是 | Array of strings | 参数解释: 资产ID列表,指定扫描作业覆盖的资产,列表元素为字符串类型的资产ID,可通过调用查询资产列表接口获取 约束限制: 数组最大500个元素 取值范围: 数组类型 默认取值: 不涉及 |
| rule_group_ids | 否 | Array of strings | 参数解释: 规则分组ID列表,指定作业使用的规则分组,列表元素为字符串类型的规则分组ID,可通过调用查询规则分组列表接口获取 约束限制: 数组最大500个元素 取值范围: 数组类型 默认取值: 不涉及 |
| scan_template_ids | 否 | Array of strings | 参数解释: 扫描模板ID列表,指定作业使用的识别扫描模板,列表元素为字符串类型的扫描模板ID,可通过调用查询模板列表接口获取 约束限制: 数组最大500个元素 取值范围: 数组类型 默认取值: 不涉及 |
| template_type | 是 | String | 参数解释: 作业类型 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| sampling_proportion | 否 | Integer | 参数解释: 采样比例,用于指定扫描时对数据的采样比例,以百分比表示 约束限制: 不涉及 取值范围: 0~100之间的整数,单位为百分比(%) 默认取值: 不涉及 |
| cycle | 是 | String | 参数解释: 扫描周期 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| time_zone | 否 | String | 参数解释: 时间可用区 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
| start_time | 否 | Long | 参数解释: 开始时间,为Unix时间戳,单位为毫秒,表示任务计划开始扫描的时间点 约束限制: 不涉及 取值范围: 毫秒级Unix时间戳 默认取值: 不涉及 |
| use_nlp | 否 | Boolean | 参数解释: 是否使用自然语言处理,用于指定识别扫描时是否启用NLP技术辅助数据识别 约束限制: 不涉及 取值范围: true-使用,false-不使用 默认取值: 不涉及 |
| open | 否 | Boolean | 参数解释: 是否开启扫描 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| topic_urn | 否 | String | 参数解释: 主题URN,用于指定扫描任务完成后发送通知的消息主题,可通过消息通知服务SMN查询主题列表获取主题URN 约束限制: 不涉及 取值范围: 字符串类型 默认取值: 不涉及 |
| credential_types | 否 | Array of strings | 参数解释: 凭证类型,数组元素为String类型 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| incremental_only | 否 | Boolean | 参数解释: 是否仅扫描增量数据,用于指定扫描作业是否只扫描新增或变更的增量数据 约束限制: 不涉及 取值范围: true-是,false-否 默认取值: 不涉及 |
| scan_time_scope | 否 | Integer | 参数解释: 扫描时间范围,表示按指定时间窗口内的数据变更进行扫描的时间范围 约束限制: 不涉及 取值范围: 0~2147483647之间的整数,单位为天 默认取值: 0 |
| scan_sensitivity | 否 | String | 参数解释: 扫描敏感度,用于指定扫描作业的敏感度级别,不同敏感度对应不同的检测强度 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| scan_mode | 否 | String | 参数解释: 作业模式 约束限制: 不涉及 取值范围: 默认取值: FULL |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| asset_id | 否 | Array of strings | 参数解释: 资产ID列表,作业覆盖的扫描资产标识,列表元素为字符串类型的资产ID,可通过调用查询资产列表接口获取 约束限制: 不涉及 取值范围: 数组类型 默认取值: 不涉及 |
| scope | 否 | String | 参数解释: 资产范围,用于描述扫描范围配置 约束限制: 不涉及 取值范围: 默认取值: 不涉及 |
| pattern | 否 | String | 参数解释: 匹配模式 约束限制: 最大长度1024字符 取值范围: 不涉及 默认取值: 不涉及 |
| include | 否 | Boolean | 参数解释: 是否包含 约束限制: 不涉及 取值范围: true-是,false-否 默认取值: 不涉及 |
| depth | 否 | Integer | 参数解释: 扫描深度,表示数据扫描的层级深度,用于控制多层级数据对象的扫描深度 约束限制: 不涉及 取值范围: 0~10之间的整数,单位为层 默认取值: 不涉及 |
| index | 否 | Integer | 参数解释: 资产索引 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
| type | 否 | Integer | 参数解释: 资产类型 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 操作结果状态 取值范围: 不涉及 |
| msg | String | 参数解释: 操作结果描述信息 取值范围: 不涉及 |
| id | String | 参数解释: 资源ID,唯一标识 取值范围: 不涉及 |
请求示例
更新任务
{
"name" : "scan-job-01",
"asset_scope" : [ {
"asset_id" : [ "5c9d0e1f-2a3b-4c4d-9e0f-8a7b6c5d4e3f" ],
"scope" : "pre",
"pattern" : "\\d{11}",
"include" : true,
"depth" : 1,
"index" : 100,
"type" : 100
}, {
"asset_id" : [ "5c9d0e1f-2a3b-4c4d-9e0f-8a7b6c5d4e3f" ],
"scope" : "pre",
"pattern" : "\\d{11}",
"include" : true,
"depth" : 1,
"index" : 100,
"type" : 100
} ],
"asset_ids" : [ "5c9d0e1f-2a3b-4c4d-9e0f-8a7b6c5d4e3f" ],
"rule_group_ids" : [ "4b8c9d0e-1f2a-4b3c-8d9e-7f6a5b4c3d2e" ],
"scan_template_ids" : [ "7e1f2a3b-4c5d-4e6f-1a2b-0c9d8e7f6a5b" ],
"template_type" : "TRADITIONAL",
"sampling_proportion" : 100,
"cycle" : "DAY",
"time_zone" : "Asia/Shanghai",
"start_time" : 1700000000000,
"use_nlp" : true,
"open" : true,
"topic_urn" : "urn:smn:cn-north-4:826314dd1b5b4037b9765f9b7a17df46:classification-notice",
"credential_types" : [ "OBS" ],
"incremental_only" : true,
"scan_time_scope" : 30,
"scan_sensitivity" : "HIGH",
"scan_mode" : "FULL"
} 响应示例
状态码:200
{
"status" : "success",
"msg" : "更新扫描任务成功",
"id" : "8f2a3b4c-5d6e-4f7a-2b3c-1d0e9f8a7b6c"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。