更新时间:2025-09-23 GMT+08:00

查询策略组列表

功能介绍

查询策略组列表

URI

GET /v5/{project_id}/policy/groups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

租户项目ID

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

租户企业项目ID,查询所有企业项目时填写:all_granted_eps

group_name

String

策略组名

offset

Integer

偏移量:指定返回记录的开始位置,必须为数字,取值范围为大于或等于0,默认0

limit

Integer

每页显示个数

container_mode

Boolean

是否查询容器版策略

group_id

String

策略组id

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

x-auth-token

String

用户Token。

通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

total_num

Integer

总数

data_list

Array of PolicyGroupResponseInfo objects

策略组列表

表5 PolicyGroupResponseInfo

参数

参数类型

描述

group_name

String

策略组名

group_id

String

策略组ID

description

String

描述信息

deletable

Boolean

是否允许删除该策略组

host_num

Integer

关联服务器数

default_group

Boolean

是否是默认策略组

support_os

String

支持的操作系统,包含如下:

  • Linux :支持Linux系统

  • Windows : 支持Windows系统

support_version

String

支持的版本,包含如下:

  • hss.version.basic :基础版策略组

  • hss.version.advanced : 专业版策略组

  • hss.version.enterprise : 企业版策略组

  • hss.version.premium : 旗舰版策略组

  • hss.version.wtp : 网页防篡改版策略组

  • hss.version.container.enterprise : 容器版策略组

请求示例

查询所有企业项目下的策略组列表。

GET https://{endpoint}/v5/{project_id}/policy/groups?offset=0&limit=100&enterprise_project_id=all_granted_eps

响应示例

状态码: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

策略组列表

错误码

请参见错误码