Querying the Rotation Status of a CMK

Function

This API enables you to query the rotation status of a CMK.

URI

  • URI format

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

  • Parameter description

    Table 1 Parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID

Requests

Table 2 Request parameters

Parameter

Mandatory

Type

Description

key_id

Yes

String

36-byte ID of a CMK that matches the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$

Example: 0d0466b0-e727-4d9c-b35d-f84bb474a37f

sequence

No

String

36-byte serial number of a request message

Example: 919c82d4-8046-4722-9094-35c3c6524cff

Responses

Table 3 Response parameters

Parameter

Mandatory

Type

Description

key_rotation_enabled

Yes

String

Key rotation status. The default value is false, indicating that key rotation is disabled.

rotation_interval

Yes

Integer

Rotation interval. The value is an integer ranging from 30 to 365.

Set the interval based on how often a CMK is used. If it is frequently used, set a short interval; otherwise, set a long one.

last_rotation_time

Yes

String

Last key rotation time. The value is a timestamp expressed in the number of seconds since 00:00:00 UTC on January 1, 1970.

number_of_rotations

Yes

String

Number of key rotations

Examples

  • Example request

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

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

    or

    {
        "error": {
            "error_code": "KMS.XXXX",
            "error_msg": "XXX"
        }
    }
    

Status Codes

Table 4 lists the normal status code returned by the response.

Table 4 Status codes

Status Code

Status

Description

200

OK

Request processed successfully.

Exception status code. For details, see Status Codes.