Updated on 2026-09-21 GMT+08:00

Querying the Key Rotation Status

This API is used to query the CMK rotation status.

For details, see Calling APIs.

POST /v1.0/{project_id}/kms/get-key-rotation-status

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

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
key_id	Yes	String	Definition Key ID Constraints The value must be a 36-byte ID. The value must match the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$. Range N/A Default Value N/A
sequence	No	String	Definition A 36-byte serial number of a request message, for example, 919c82d4-8046-4722-9094-35c3c6524cff. Constraints N/A Range N/A Default Value N/A

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
key_rotation_enabled	Boolean	Definition Key rotation status Range N/A
rotation_interval	Integer	Definition Rotation period Range N/A
last_rotation_time	String	Definition Last key rotation time. The value is a timestamp indicating how many milliseconds it has been since January 1, 1970. Range N/A
number_of_rotations	Integer	Definition Number of key rotations Range N/A
key_materials	Array of key_materials objects	Definition Key material Range N/A

**Table 5** key_materials
Parameter	Type	Description
material_id	String	Definition Key material ID Range The value is in UUID format.
charge_id	String	Definition Billing ID Range N/A
create_time	String	Definition Key material creation time Range N/A
expiration_time	String	Definition Key material expiration time Range N/A
state	String	Definition Key material status Range The value can be 0 (pending rotation) or 2 (enabled).

Query the rotation status of the CMK whose ID is 0d0466b0-e727-4d9c-b35d-f84bb474a37f.

{
  "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f"
}

Status code: 200

Request succeeded.

{
  "key_rotation_enabled" : true,
  "rotation_interval" : 30,
  "last_rotation_time" : "1501578672000",
  "number_of_rotations" : 3
}

Status Code	Description
200	Request succeeded.