Updated on 2026-08-25 GMT+08:00

Querying a Key Policy

This API is used to query a key policy.

For details, see Calling APIs.

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

kms:policy:get

Read

policy *

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
kms:policy:get	Read	policy *	-	-	-

GET /v1.0/{project_id}/kms/key-policies/{policy_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details, see Obtaining a Project ID. Constraints N/A Range The value returned by the IAM API is used, which contains 32 characters. Default Value N/A
policy_id	Yes	String	Definition Key policy ID Constraints N/A Range The value must be in UUID format consisting of 36 characters. Default Value N/A

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range Obtain the value by calling the IAM API for obtaining the user token. Default Value N/A

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
policy_id	String	Definition Key policy ID Range N/A
policy_name	String	Definition Key policy name Range N/A
keyspace_id	String	Definition Key space ID Range N/A
policy	policy object	Definition Key policy Range N/A
description	String	Definition Key policy description Range N/A
created_by	String	Definition Key policy creator Range N/A
create_time	String	Definition Key policy creation time Range N/A
last_modify_time	String	Definition Last modification time of the key policy Range N/A
last_access_time	String	Definition Last access time of the key policy Range N/A

**Table 4** policy
Parameter	Type	Description
version	String	Definition Key policy version Range N/A
validity_period	validity_period object	Definition Key policy validity period Range N/A
allowed_access_point	Array of strings	Definition Allowed access point ID list Range N/A
allowed_data_security_zone	Array of strings	Definition Allowed data security zone ID list Range N/A

**Table 5** validity_period
Parameter	Type	Description
start_time	String	Definition Effective time of a key policy Range N/A
end_time	String	Definition Key policy expiration time Range N/A

None

None

Status Code	Description
200	Request succeeded.

Parent Topic: Key Space