Querying All Identity Policies

Function

This API is used to query all identity policies, including system-defined identity policies and custom identity policies.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
iam:policies:listV5	List	policy *	-	-	-

URI

GET /v5/policies

**Table 1** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Definition: Number of records displayed per page. Constraints: N/A Range: The value ranges from 1 to 200. Default Value: The default value is 100.
marker	No	String	Definition: Pagination marker automatically generated by the service to mark the start position of this request. The value can be obtained from next_marker in the response body of the previous pagination request. Constraints: The value contains 4 to 400 characters. Only letters, digits, plus signs (+), slashes (/), equal signs (=), hyphens (-), and underscores (_) are allowed. Range: N/A Default Value: N/A
policy_type	No	String	Definition: Identity policy type. Constraints: N/A Range: custom or system. Default Value: N/A
path_prefix	No	String	Definition: Resource path prefix, which consists of several character strings. Constraints: Each segment contains one or more letters, digits, periods (.), commas (,), plus signs (+), at signs (@), equal signs (=), underscores (_), or hyphens (-) and ends with a slash (/), for example, foo/bar/. Range: N/A Default Value: The default value is an empty string.
only_attached	No	Boolean	Definition: Whether to list only identity policies that have additional entities. Constraints: N/A Range: The value can be true or false. Default Value: The default value is false.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Language	No	String	Definition: Language of the returned results. Constraints: N/A Range: Chinese ("zh-cn") or English ("en-us"). Default Value: The default value is zh-cn.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
policies	Array of policies objects	Definition: Identity policy list. Range: N/A
page_info	page_info object	Definition: Pagination information. Range: N/A

**Table 4** policies
Parameter	Type	Description
policy_type	String	Definition: Identity policy type. Range: custom or system.
policy_name	String	Definition: Name of an identity policy. Range: N/A
policy_id	String	Definition: Identity policy ID. Range: N/A
urn	String	Definition : Uniform Resource Name (URN). For details, see Reference. Range: N/A.
path	String	Definition: Resource path. Range: N/A
default_version_id	String	Definition: Default version number, which indicates the version number of the policy that is currently in effect. Range: N/A
attachment_count	Integer	Definition: Number of entities to which an identity policy is attached. Range: N/A
description	String	Definition: Identity policy description. Range: N/A
created_at	String	Definition: Time when an identity policy is created. Range: N/A
updated_at	String	Definition: Time when the identity policy was last updated. Range: N/A

**Table 5** page_info
Parameter	Type	Description
next_marker	String	Definition: Start position marker for the next pagination invoking, which is automatically generated by the service. Range: N/A
current_count	Integer	Definition: Number of records returned on this page. Range: N/A

Status code: 403

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Definition : Error code. For details, see Error Code. Range: The format is PAP5.XXXX, for example, PAP5.0012.
error_msg	String	Definition : Error message. For details, see Error Message. Range: N/A.
request_id	String	Definition: Unique identifier of an API request, which is used to locate API calling exceptions. Range: N/A
encoded_authorization_message	String	Definition : Encrypted details returned when the authentication fails, which are used to locate authentication problems. The STS5 decryption API can be used for decryption. For details, see API link. Range: N/A.

Example Requests

Querying all identity policies

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

Example Responses

Status code: 200

Successful

{
  "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
  }
}