Obtaining the Key Policy List

This API is used to obtain the key policy list.

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:list

List

policy *

-

-

-

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

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

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
keyspace_id	Yes	String	Definition Key space ID Constraints The value must match the regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$. Range N/A Default Value N/A
limit	No	String	Definition Pagination parameter, which specifies the number of records displayed on each page. Constraints The value must be a number. Range 1-100 Default Value 50
marker	No	String	Definition Pagination parameter, which indicates the next page. Constraints The value must match the regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$. Range N/A Default Value N/A

**Table 3** 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 4** Response body parameters
Parameter	Type	Description
page_info	page_info object	Definition Pagination information Range N/A
keyspace_policies	Array of keyspace_policies objects	Definition Key policy list Range N/A

**Table 5** page_info
Parameter	Type	Description
next_marker	String	Definition Marker of the next page Range N/A
current_count	Integer	Definition Number of records displayed on the current page Range N/A

**Table 6** keyspace_policies
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 7** policy
Parameter	Type	Description
version	String	Definition Key policy version Range N/A
validityPeriod	validityPeriod object	Definition Key policy validity period Range N/A
allowedAccessPoint	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 8** validityPeriod
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