Obtaining List of CMKs Hosted by KMS for the Current Tenant

This API is used to obtain the list of client master keys (CMKs) hosted by KMS for the current tenant.

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

No identity policy-based permission required for calling this API.

GET https://{hostURL}/v4/tenants/{tenant_id}/repo-encryption/cmks

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
tenant_id	Yes	String	Definition Tenant ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
offset	No	Integer	Definition Offset, which starts from 0. Value range: 0~2147483647 Default value: 0
limit	No	Integer	Definition Number of returned records. Value range: 1~100 Default value: 20

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. You can obtain the token by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range A string that can contain 1 to 100,000 characters. Default Value N/A

Status code: 202

**Table 4** Response body parameters
Parameter	Type	Description
cmk_key_name	String	Definition Name of the encryption master key. Range The value must contain 1 to 1,000 characters.
cmk_key_id	String	Definition ID of the encryption master key. Range The value must contain 1 to 1,000 characters.
key_state	Integer	Definition Status of the encryption master key. Range 1: To-be-activated. 2: Enabled. 3: Disabled. 4: Pending deletion. 5: Pending import. Enumeration values: 1 2 3 4 5

Status code: 401

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error message.

Status code: 403

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

GET https://{endpoint}/v4/tenants/{tenant_id}/repo-encryption/cmks?offset=0&limit=10

Status code: 202

Obtain the list of CMKs hosted by KMS for the current tenant.

{
  "cmk_key_name" : "test111",
  "cmk_key_id" : "7308c1b8-557f-453a-aef7-28643f49cf1e",
  "key_state" : 2
}

Status code: 401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "Authentication information expired."
}

Status code: 403

Bad Request

{
  "error_code" : "CH.004403",
  "error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
}

Status Code	Description
202	Obtain the list of CMKs hosted by KMS for the current tenant.
401	Unauthorized
403	Bad Request

Parent topic: Tenant

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

For any further questions, feel free to contact us through the chatbot.