查询所有身份策略 - ListPoliciesV5

功能介绍

该接口可以用于查询所有身份策略，包含系统预置身份策略和自定义身份策略。

调试

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

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
iam:policies:listV5	List	policy *	-	-	-

URI

GET /v5/policies

表1 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	每页显示的条目数量，范围为1到200条，默认为100条。最小值：1 最大值：200 缺省值：100
marker	否	String	分页标记，长度为4到400个字符，只包含字母、数字、"+"、"/"、"="、"-"和"_"的字符串。最小长度：4 最大长度：400
policy_type	否	String	身份策略类型，可以为“自定义”（custom）或“系统预置”（system）。
path_prefix	否	String	资源路径前缀，由若干段字符串拼接而成，每段先包含一个或多个字母、数字、"."、","、"+"、"@"、"="、"_"或"-"，并以"/"结尾，例如"foo/bar/"。最大长度：512
only_attached	否	Boolean	是否仅列举存在附加实体的身份策略。缺省值：false

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
X-Language	否	String	选择接口返回的信息的语言，可以为中文（"zh-cn"）或英文（"en-us"），默认为中文。缺省值：zh-cn

响应参数

状态码：200

表3 响应Body参数
参数	参数类型	描述
policies	Array of Policy objects	身份策略列表。
page_info	PageInfo object	分页信息。

表4 Policy
参数	参数类型	描述
policy_type	String	身份策略类型，可以为“自定义”（custom）或“系统预置”（system）。
policy_name	String	身份策略名称，长度为1到128个字符，只包含字母、数字、"_"、"+"、"="、"."、"@"和"-"的字符串。
policy_id	String	身份策略ID，长度为1到64个字符，只包含字母、数字和"-"的字符串。
urn	String	统一资源名称。
path	String	资源路径，默认为空串。由若干段字符串拼接而成，每段先包含一个或多个字母、数字、"."、","、"+"、"@"、"="、"_"或"-"，并以"/"结尾，例如"foo/bar/"。
default_version_id	String	默认版本号。
attachment_count	Integer	附加了本身份策略的实体数量。
description	String	身份策略描述。
created_at	String	身份策略创建时间。
updated_at	String	身份策略默认版本最近一次的更新时间。

表5 PageInfo
参数	参数类型	描述
next_marker	String	如果存在，则表示还有后续的条目未显示在当前返回体中。请使用该值作为下一次请求的分页标记参数以获得下一页信息。请反复调用该接口直至该字段不存在。
current_count	Integer	本页返回条目数量。

状态码：403

表6 响应Body参数
参数	参数类型	描述
error_code	String	错误码。
error_msg	String	错误信息。
request_id	String	请求ID。
encoded_authorization_message	String	加密后的认证失败信息，可以通过STS5解密接口进行解密。

请求示例

查询所有身份策略。

GET https://{endpoint}/v5/policies

响应示例

状态码：200

请求成功。

{
  "policies" : [ {
    "policy_type" : "custom",
    "policy_name" : "name",
    "policy_id" : "string",
    "urn" : "iam::accountid:policy:name",
    "path" : "",
    "default_version_id" : "v1",
    "attachment_count" : 0,
    "description" : "description",
    "created_at" : "2023-09-25T07:49:11.582Z",
    "updated_at" : "2023-09-25T07:49:11.582Z"
  } ],
  "page_info" : {
    "next_marker" : "marker",
    "current_count" : 1
  }
}