Obtaining an Identity Policy Based on the Identity Policy ID

Function

This API is used to obtain an identity policy based on the identity policy ID.

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:getV5	Read	policy *	-	-	-

URI

GET /v5/policies/{policy_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
policy_id	Yes	String	Definition Identity policy ID. For details about how to obtain the value, see the API for querying identity policies (ListPoliciesV5) or check the identity policy list page of the IAM console. Constraints N/A Range The value can contain 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed. Default Value N/A

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
policy	policy object	Definition: Identity policy. Range: N/A

**Table 4** policy
Parameter	Type	Description
policy_type	String	Definition: Identity policy type. Range: custom or system.
policy_name	String	Definition Name of an identity policy. Range The value contains 1 to 128 characters, including only letters, digits, underscores (_), plus signs (+), equal signs (=), periods (.), at signs (@), and hyphens (-).
policy_id	String	Definition Identity policy ID. For details about how to obtain the value, see the API for querying identity policies (ListPoliciesV5) or check the identity policy list page of the IAM console. Range The value can contain 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed.
urn	String	Definition: Uniform Resource Name (URN). For details, see Reference. Range: N/A.
path	String	Definition Resource path. A resource path is a hierarchical path used to organize and classify resources, which is similar to the directory structure in a file system. Range The value consists of one or more concatenated string segments, with a total length of 0 to 512 characters. 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/.
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 The value contains 0 to 1,000 characters.
created_at	String	Definition Time when the identity policy was created. The UTC+0 time zone is used. The format is yyyy-MM-ddTHH:mm:ss.SSSZ, for example, 2023-09-13T06:51:20.550Z. Range N/A
updated_at	String	Definition Time when the identity policy was last updated. The UTC+0 time zone is used. The format is yyyy-MM-ddTHH:mm:ss.SSSZ, for example, 2023-09-13T06:51:20.550Z. Range N/A

Status code: 403

**Table 5** 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.

Status code: 404

**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

Example Requests

Obtaining an identity policy based on the identity policy ID

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

Example Responses

Status code: 200

{
  "policy" : {
    "policy_type" : "custom",
    "policy_name" : "name",
    "policy_id" : "string",
    "urn" : "iam::123456789012:policy:example-policy",
    "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"
  }
}