获取集群防护默认策略列表 - ListClusterProtectionDefaultPolicy
功能介绍
获取集群防护默认策略列表
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/cluster-protect/default-policy
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
|
offset |
是 |
Integer |
参数解释: 偏移量:指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0,最大值2000000 默认取值: 不涉及 |
|
limit |
是 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
参数解释: 总数 取值范围: 最小值0,最大值10000 |
|
x_auth_token |
String |
参数解释: 用户Token 取值范围: 字符长度1-32768位 |
|
project_id |
String |
参数解释: 项目ID 取值范围: 字符长度1-32768位 |
|
enterprise_project_id |
String |
参数解释: 主机所属的企业项目ID 取值范围: 字符长度1-256位 |
|
region |
String |
参数解释: Region ID 取值范围: 字符长度1-32768位 |
|
general_policy_num |
Integer |
参数解释: 通用策略数 取值范围: 最小值0,最大值2147483647 |
|
malicious_image_policy_num |
Integer |
参数解释: 恶意镜像策略数 取值范围: 最小值0,最大值2147483647 |
|
security_policy_num |
Integer |
参数解释: 安全镜像策略数 取值范围: 最小值0,最大值2147483647 |
|
data_list |
Array of ClusterPolicyResponseInfo objects |
参数解释: 集群防护策略列表 取值范围: 取值0-10000个ClusterPolicyResponseInfo对象 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
cluster_id |
String |
参数解释: 集群ID 取值范围: 不涉及 |
|
cluster_name |
String |
参数解释: 集群名称 取值范围: 不涉及 |
|
content |
Object |
参数解释: 策略内容 取值范围: 不涉及 |
|
deploy_content |
String |
参数解释: 部署内容 取值范围: 不涉及 |
|
parameters |
String |
参数解释: 参数 取值范围: 不涉及 |
|
policy_name |
String |
参数解释: 策略名称 取值范围: 不涉及 |
|
policy_id |
String |
参数解释: 策略ID 取值范围: 不涉及 |
|
resources |
Array of Resources objects |
参数解释: 资源 取值范围: 不涉及 |
|
template_id |
String |
参数解释: 模板ID 取值范围: 不涉及 |
|
template_name |
String |
参数解释: 模板名称 取值范围: 不涉及 |
|
template_type |
String |
参数解释: 模板类型 取值范围: 不涉及 |
|
description |
String |
参数解释: 策略描述 取值范围: 不涉及 |
|
update_time |
Integer |
参数解释: 更新时间 取值范围: 不涉及 |
|
create_time |
Integer |
参数解释: 创建时间 取值范围: 不涉及 |
|
image_num |
Integer |
参数解释: 防护镜像数量 取值范围: 不涉及 |
|
labels_num |
Integer |
参数解释: 防护标签数量 取值范围: 不涉及 |
|
status |
String |
参数解释: 状态 取值范围: 不涉及 |
|
white_images |
Array of WhiteImageInfo objects |
参数解释: 白名单镜像 取值范围: 不涉及 |
请求示例
获取集群防护默认策略列表
GET https://{endpoint}/v5/{project_id}/cluster-protect/default-policy?limit=200&offset=0&enterprise_project_id=all_granted_eps
响应示例
状态码:200
请求已成功
{
"project_id" : "",
"enterprise_project_id" : "0",
"total_num" : 0,
"data_list" : [ ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。