获取扫描策略 - ListImageScanPolicy
功能介绍
获取扫描策略
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/image/scanner-policies
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0，表示默认企业项目（default）。 |
|
global_image_type |
否 |
String |
镜像类型:
|
|
type |
是 |
String |
策略类型 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
is_all |
Boolean |
扫描全部镜像 | true:扫描全部镜像 false:指定镜像扫描 |
|
enabled |
Boolean |
定时扫描策略开关 |
|
scan_cycle |
Integer |
定时扫描周期 | 3 每三天 7 每一周 14 每两周 |
|
scan_scope |
Integer |
扫描风险类型 | 0:无 0x0fffff:全部 0x0f0000:漏洞 0x00f000:基线检查 0x000f00:恶意文件 0x0000f0:敏感信息 0x00000f:软件合规 |
|
rate_limit |
Integer |
扫描限速 单位：个/h | 0 不限制 |
|
time_scope |
Integer |
时间范围 单位：天 | 0 全部镜像 1 3 7 |
|
total_registry_num |
Integer |
镜像仓库列表总数 |
|
registry_list |
Array of registry_list objects |
镜像列表 |
请求示例
查询镜像软件列表
GET https://{endpoint}//v5/{project_id}/image/scanner-policies?type=cycle&enterprise_project_id=all_granted_eps
响应示例
状态码：200
当前租户的扫描策略
{
"is_all" : false,
"enabled" : false,
"scan_cycle" : 0,
"scan_scope" : 10,
"rate_limit" : 10,
"time_scope" : 1,
"total_registry_num" : 10,
"registry_list" : [ {
"is_selected" : false,
"registry_name" : "test1",
"registry_id" : "id",
"registry_type" : "SwrPrivate"
} ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
当前租户的扫描策略 |
错误码
请参见错误码。
