Querying the Version of a Specified Identity Policy

Function

This API is used to query the version information, including the identity policy document of a specified identity policy.

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

URI

GET /v5/policies/{policy_id}/versions/{version_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
policy_id	Yes	String	Definition: Identity policy ID. Constraints: The value can contain 1 to 64 characters. Only letters, digits, and hyphens (-) are allowed. Range: N/A Default Value: N/A
version_id	Yes	String	Definition: Identity policy version. Constraints: The value is a string starting with v followed by digits, for example, v5. Range: N/A Default Value: N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 2** Response body parameters
Parameter	Type	Description
policy_version	policy_version object	Definition: Identity policy version. Range: N/A

**Table 3** policy_version
Parameter	Type	Description
document	String	Definition: JSON format of the policy document of a custom or a preset identity policy. Range: N/A
version_id	String	Definition: Identity policy version. Range: N/A
is_default	Boolean	Definition: Indicates whether the version is the default version. Range: N/A
created_at	String	Definition: Time when an identity policy version is created. Range: N/A

Status code: 403

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

Example Requests

Querying the version of a specified identity policy

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

Example Responses

Status code: 200

Successful

{
  "policy_version" : {
    "document" : "{\"Version\":\"5.0\",\"Statement\":[{\"Effect\":\"Allow\",\"Action\":[\"*\"]}]}",
    "version_id" : "v1",
    "is_default" : true,
    "created_at" : "2023-09-25T08:00:51.537Z"
  }
}