- Product Introduction
- Purchase Guide
- Console Guide
- TCCLI Management Guide
- Best Practices
- API documentation
- Release History
- API Category
- Making API Requests
- Key APIs
- UpdateKeyDescription
- UpdateAlias
- Ciphertext refresh
- Get master key list
- ListKeyDetail
- Query service status
- Query key rotation status
- Generate data key
- Encrypt
- EnableKeys
- EnableKeyRotation
- EnableKey
- DisableKeys
- Disable key rotation
- DisableKey
- Gets attributes of multiple CMKs
- Gets CMK attributes
- Decrypt
- CreateKey
- ScheduleKeyDeletion
- CancelKeyDeletion
- ImportKeyMaterial
- GetParametersForImport
- DeleteImportedKeyMaterial
- Generates a random number
- Lists encryption methods supported in the current region
- UnbindCloudResource
- BindCloudResource
- GetRegions
- CancelKeyArchive
- ArchiveKey
- Asymmetric Key APIs
- White-Box Key APIs
- Creates a white-box key
- Deletes a white-box key
- Gets the device fingerprint list of a specified key
- Gets a white-box decryption key
- Displays white-box key information
- Gets the white-box key list
- Gets the white-box key service status
- Disables a white-box key
- Disables white-box keys in batches
- Enables a white-box key
- Enables white-box keys in batches
- Encrypts data with a white-box key
- OverwriteWhiteBoxDeviceFingerprints
- Data Types
- Error Codes
- Service Level Agreement
- FAQs
- Glossary
- Product Introduction
- Purchase Guide
- Console Guide
- TCCLI Management Guide
- Best Practices
- API documentation
- Release History
- API Category
- Making API Requests
- Key APIs
- UpdateKeyDescription
- UpdateAlias
- Ciphertext refresh
- Get master key list
- ListKeyDetail
- Query service status
- Query key rotation status
- Generate data key
- Encrypt
- EnableKeys
- EnableKeyRotation
- EnableKey
- DisableKeys
- Disable key rotation
- DisableKey
- Gets attributes of multiple CMKs
- Gets CMK attributes
- Decrypt
- CreateKey
- ScheduleKeyDeletion
- CancelKeyDeletion
- ImportKeyMaterial
- GetParametersForImport
- DeleteImportedKeyMaterial
- Generates a random number
- Lists encryption methods supported in the current region
- UnbindCloudResource
- BindCloudResource
- GetRegions
- CancelKeyArchive
- ArchiveKey
- Asymmetric Key APIs
- White-Box Key APIs
- Creates a white-box key
- Deletes a white-box key
- Gets the device fingerprint list of a specified key
- Gets a white-box decryption key
- Displays white-box key information
- Gets the white-box key list
- Gets the white-box key service status
- Disables a white-box key
- Disables white-box keys in batches
- Enables a white-box key
- Enables white-box keys in batches
- Encrypts data with a white-box key
- OverwriteWhiteBoxDeviceFingerprints
- Data Types
- Error Codes
- Service Level Agreement
- FAQs
- Glossary
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-52xxxxx4Output
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-52xxxxx4Output
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-52xxxxx4Output
If the feature is disabled normally, the request information as shown below will be returned.
{
"RequestId": "c8b73c8b-1ee5-4b23-b800-7cccc58e7ffb"
}
Yes
No
Was this page helpful?