查询策略组列表 - ListPolicyGroup
功能介绍
查询策略组列表
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/policy/groups
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 默认取值: 默认为0 |
|
limit |
否 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
|
group_name |
否 |
String |
参数解释: 策略组名称 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
container_mode |
否 |
Boolean |
参数解释: 是否只查询容器版策略组 约束限制: 不涉及 取值范围:
默认取值: false |
|
group_id |
否 |
String |
参数解释: 策略组ID 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
参数解释: 总数 取值范围: 最小值0，最大值2147483647 |
|
data_list |
Array of PolicyGroupResponseInfo objects |
参数解释： 策略组列表 取值范围： 不涉及 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
group_name |
String |
参数解释: 策略组名称 取值范围: 字符长度1-256位 |
|
group_id |
String |
参数解释: 策略组ID 取值范围: 字符长度1-256位 |
|
description |
String |
参数解释: 策略组描述 取值范围: 字符长度0-64位 |
|
host_num |
Integer |
参数解释: 关联服务器数 取值范围: 取值0-1000000 |
|
default_group |
Boolean |
参数解释: 是否是默认策略组 取值范围:
|
|
deletable |
Boolean |
参数解释: 是否可以删除，只有default_group为false且host_num为0时可以删除 取值范围:
|
|
support_os |
String |
参数解释: 支持的操作系统 取值范围:
|
|
support_version |
String |
参数解释: 支持的版本 取值范围:
|
|
protect_mode |
String |
参数解释: 防护模式 取值范围:
|
请求示例
查询默认企业项目下的策略组列表。
GET https://{endpoint}/v5/{project_id}/policy/groups?offset=0&limit=100&enterprise_project_id=0
响应示例
状态码：200
请求已成功
{
"data_list" : [ {
"default_group" : true,
"deletable" : false,
"description" : "container policy group for linux",
"group_id" : "c831f177-226d-4b91-be0f-bcf98d04ef5d",
"group_name" : "tenant_linux_container_default_policy_group ",
"host_num" : 0,
"support_version" : "hss.version.container.enterprise",
"support_os" : "Linux"
}, {
"default_group" : true,
"deletable" : false,
"description" : "enterprise policy group for windows",
"group_id" : "1ff54b90-1b3e-42a9-a1da-9883a83385ce",
"group_name" : "tenant_windows_enterprise_default_policy_group ",
"host_num" : 0,
"support_version" : "hss.version.enterprise",
"support_os" : "Windows"
}, {
"default_group" : true,
"deletable" : false,
"description" : "enterprise policy group for linux",
"group_id" : "1069bcc0-c806-4ccd-a35d-f1f7456805e9",
"group_name" : "tenant_linux_enterprise_default_policy_group ",
"host_num" : 1,
"support_version" : "hss.version.enterprise",
"support_os" : "Linux"
}, {
"default_group" : true,
"deletable" : false,
"description" : "premium policy group for windows",
"group_id" : "11216d24-9e91-4a05-9212-c4c1d646ee79",
"group_name" : "tenant_windows_premium_default_policy_group ",
"host_num" : 0,
"support_version" : "hss.version.premium",
"support_os" : "Linux"
}, {
"default_group" : true,
"deletable" : false,
"description" : "premium policy group for linux",
"group_id" : "e6e1228a-7bb4-424f-a42b-755162234da7",
"group_name" : "tenant_linux_premium_default_policy_group ",
"host_num" : 0,
"support_version" : "hss.version.premium",
"support_os" : "Windows"
} ],
"total_num" : 5
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
