查询策略组列表 - ListPolicyGroup

功能介绍

查询策略组概要信息列表，不包含策略信息以及应用对象信息。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

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

如果使用角色与策略授权，具体权限要求请参见权限和授权项。
如果使用身份策略授权，需具备如下身份策略权限。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

workspace:policyGroups:list

List

policyGroup *

-

-

-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
workspace:policyGroups:list	List	policyGroup *	-	-	-

URI

GET /v2/{project_id}/policy-groups

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID。

表2 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	用于分页查询，返回策略组数量的限制。如果不指定，则返回所有符合条件的策略组。范围0~100。
offset	否	Integer	用于分页查询，查询的起始记录序号，范围0~1000。
policy_group_id	否	String	根据策略组ID过滤结果。
policy_group_name	否	String	根据策略组名字过滤结果。
priority	否	Integer	根据优先级过滤结果。所带的值需要满足现有策略组已有最大优先级值。
update_time	否	String	根据更新时间过滤结果。时间格式满足：yyyy-MM-dd HH:mm:ss。
description	否	String	策略组描述。
is_group_name_accurate	否	Boolean	策略组名字精确查询。

请求参数

无

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
policy_groups	Array of PolicyGroupForBaseList objects	策略组。
total_count	Integer	总数。

表4 PolicyGroupForBaseList
参数	参数类型	描述
policy_group_id	String	策略组ID。
policy_group_name	String	策略组名称。
priority	Integer	优先级。
update_time	String	更新日期。
description	String	策略组描述。

状态码：400

表5 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：401

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：403

表7 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：404

表8 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：405

表9 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：500

**表10** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

状态码：503

**表11** 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误描述。
error_detail	String	错误详情。
encoded_authorization_message	String	加密后的详细拒绝原因，用户可以自行调用STS服务的decode-authorization-message接口进行解密。

请求示例

GET /v2/089b2f9a3d80d3062f24c00ca4ed5cbd/policy-groups

响应示例

状态码：200

查询策略组信息的响应。

{
  "total_count" : 2,
  "policy_groups" : [ {
    "priority" : 1,
    "description" : "策略组描述1。",
    "policy_group_id" : "8ac225c2781f230a01781f29b2e7xxxx",
    "policy_group_name" : "策略组1",
    "update_time" : "2021-03-12 12:02:01"
  }, {
    "priority" : 2,
    "description" : "策略组描述2。",
    "policy_group_id" : "8ac225c2781edb0d01781edde3f4xxxx",
    "policy_group_name" : "策略组2",
    "update_time" : "2021-03-12 09:06:44"
  } ]
}

状态码

状态码	描述
200	查询策略组信息的响应。
400	由于包含语法错误，当前请求无法被服务器理解。
401	鉴权失败。
403	没有操作权限。
404	找不到资源。
405	请求中指定的方法不被允许。
500	服务内部错误，具体返回错误码请参见错误码说明。
503	服务不可用。