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
EnableKeyRotation
Last updated: 2025-04-23 14:29:45
1. API Description
Domain name for API request: kms.intl.tencentcloudapi.com.
Turn on the key rotation function for the specified CMK.
A maximum of 100 requests can be initiated per second for this API.
We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.
2. Input Parameters
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: EnableKeyRotation. |
| Version | Yes | String | Common Params. The value used for this API: 2019-01-18. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| KeyId | Yes | String | Unique CMK ID |
| RotateDays | No | Integer | The interval between each key rotation in days. Value range: 7 - 365 (default). |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
4. Example
Example1 Enabling key rotation
This example shows you how to enable key rotation for a specified CMK.
Input Example
POST / HTTP/1.1
Host: kms.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: EnableKeyRotation
<Common request parameters>
{
"KeyId": "23e80852-1e38-11e9-b129-5cb9019b4b01"
}
Output Example
{
"Response": {
"RequestId": "1b580852-1e38-11e9-b129-5cb9019b4b00"
}
}
5. Developer Resources
SDK
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
Command Line Interface
6. Error Code
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| InternalError | Internal error. |
| InvalidParameter | Invalid parameter. |
| InvalidParameterValue | Incorrect parameter value. |
| InvalidParameterValue.InvalidKeyId | Invalid KeyId. |
| ResourceUnavailable.CmkNotFound | The CMK does not exist. |
| ResourceUnavailable.CmkStateNotSupport | This operation cannot be performed under the current CMK status. |
| UnauthorizedOperation | Unauthorized operation. |
| UnsupportedOperation.ExternalCmkCanNotRotate | External CMKs cannot be rotated. |
| UnsupportedOperation.ServiceTemporaryUnavailable | The service is temporarily unavailable. |
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No