Key Management Service
- Product Introduction
- Purchase Guide
- Console Guide
- Key Management
- TCCLI Management Guide
- Practical Tutorial
- Symmetrical Encryption and Decryption
- Encrypting/Decrypting Sensitive Data
- Envelope Encryption/Decryption
- Asymmetric Encryption and Decryption
- Asymmetric Signature Verification
- Importing External Key
- API documentation
- Making API Requests
- Key APIs
- Asymmetric Key APIs
Key Rotation
Last updated: 2024-01-11 16:28:54
Overview
The key rotation feature involves three APIs:
API Name | Description | Note |
GetKeyRotationStatus | Views key rotation status | The KeyId parameter is required for this API. For more information, please see the GetKeyRotationStatus API document. |
EnableKeyRotation | Enables key rotation | The KeyId parameter is required for this API. For more information, please see the EnableKeyRotation API document. |
DisableKeyRotation | Disables key rotation | The KeyId parameter is required for this API. For more information, please see the DisableKeyRotation API document. |
The examples below are called with TCCLI, which can also be called with any supported programming languages.
Examples
Viewing key rotation status
Input
tccli kms GetKeyRotationStatus --region ap-guangzhou --KeyId 5xxxxx-xxxx-xxxx-xxxx-52xxxxx4
Output
If the API is called successfully, the key rotation status of the CMK will be returned.
{"KeyRotationEnabled": false,"RequestId": "e1432224-4dc2-48da-a8e8-e84d30afd9ef"}
Enabling key rotation
Input
tccli kms EnableKeyRotation --region ap-guangzhou --KeyId 5xxxxx-xxxx-xxxx-xxxx-52xxxxx4
Output
If the feature is enabled normally, the request information as shown below will be returned.
{"RequestId": "4e0fa96f-e86e-4517-af27-3dfe6e5b2a72"}
Disabling key rotation
Input
tccli kms DisableKeyRotation --region ap-guangzhou --KeyId 5xxxxx-xxxx-xxxx-xxxx-52xxxxx4
Output
If the feature is disabled normally, the request information as shown below will be returned.
{"RequestId": "c8b73c8b-1ee5-4b23-b800-7cccc58e7ffb"}
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No