文档首页/ 数据安全中心 DSC/ API参考/ API/ 扫描任务/ 获取扫描作业下的扫描范围配置列表 - ListScopes
更新时间:2026-11-13 GMT+08:00
分享

获取扫描作业下的扫描范围配置列表 - ListScopes

功能介绍

功能介绍:获取扫描作业下的扫描范围配置列表。 关键参数说明:通过job_id定位作业。 返回值说明:返回范围配置总数及范围列表(含资产ID、范围、匹配模式、深度等)。

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

GET /v1/{project_id}/sdg/scan/job/{job_id}/scopes

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,标识用户在数据安全中心控制台中创建的项目

约束限制:

不涉及

取值范围:

长度为32个字符的字符串

默认取值:

不涉及

job_id

是

String

参数解释:

扫描作业ID,标识需要获取扫描范围配置列表的扫描作业,可通过调用创建扫描作业接口获取,或可在数据安全中心控制台作业列表中查看

约束限制:

不涉及

取值范围:

长度1~64个字符

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token,用于接口请求鉴权,可通过调用IAM服务查询用户Token接口获取

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

total

Integer

参数解释:

总记录数

取值范围:

不涉及

scopes

Array of AssetScope objects

参数解释:

扫描范围配置列表,每个元素为一个AssetScope对象,表示一个资产扫描范围的配置信息

取值范围:

数组类型

表4 AssetScope

参数

参数类型

描述

asset_id

Array of strings

参数解释:

资产ID列表,作业覆盖的扫描资产标识,列表元素为字符串类型的资产ID,可通过调用查询资产列表接口获取

取值范围:

数组类型

scope

String

参数解释:

资产范围,用于描述扫描范围配置

取值范围:

  • pre-前缀

  • post-后缀

  • dir-目录

pattern

String

参数解释:

匹配模式

取值范围:

不涉及

include

Boolean

参数解释:

是否包含

取值范围:

true-是,false-否

depth

Integer

参数解释:

扫描深度,表示数据扫描的层级深度,用于控制多层级数据对象的扫描深度

取值范围:

0~10之间的整数,单位为层

index

Integer

参数解释:

资产索引

取值范围:

不涉及

type

Integer

参数解释:

资产类型

取值范围:

不涉及

请求示例

获取扫描作业下的扫描范围配置列表

/v1/2b31ed520aabbccddeedb6e571234567/sdg/scan/job/3a7b8c9d-0e1f-4a2b-9c8d-7e6f5a4b3c2d/scopes

响应示例

状态码:200

{
  "total" : 1,
  "scopes" : [ {
    "asset_id" : [ "5c9d0e1f-2a3b-4c4d-9e0f-8a7b6c5d4e3f" ],
    "scope" : "pre",
    "pattern" : "\\d{11}",
    "include" : true,
    "depth" : 1,
    "index" : 100,
    "type" : 100
  } ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

相关文档