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 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	Identity policy ID. The value contains 1 to 64 characters, including only letters, digits, and hyphens (-).

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Language	No	String	Language of the returned message. The value can be zh-cn or en-us and is zh-cn by default. Default: zh-cn

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
policy	Policy object	Identity policy.

**Table 4** Policy
Parameter	Type	Description
policy_type	String	Identity policy type. The value can be custom or system-defined.
policy_name	String	Identity policy name. The value contains 1 to 128 characters, including only letters, digits, and the following special characters: _+=.@-
policy_id	String	Identity policy ID. The value contains 1 to 64 characters, including only letters, digits, and hyphens (-).
urn	String	Uniform resource name.
path	String	Resource path, which is an empty string by default. It consists of multiple character strings. Each character string must end with a slash (/) and can only contain letters, digits, and the following special characters: .,+@=_-, for example, foo/bar/.
default_version_id	String	Default version number.
attachment_count	Integer	Number of entities to which an identity policy is attached.
description	String	Identity policy description.
created_at	String	Time when an identity policy was created.
updated_at	String	Time when the default version of an identity policy was last updated.

Status code: 403

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Request ID.
encoded_authorization_message	String	Encrypted authentication failure information, which can be decrypted using the STS5 decryption API.

Status code: 404

**Table 6** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error message.
request_id	String	Request ID.

Example Requests

Obtaining an identity policy based on the identity policy ID

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

Example Responses

Status code: 200

Successful

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