Domain name for API request: kms.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.
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 | No | String | Common Params. This parameter is not required for this API. |
KeyId | Yes | String | Unique CMK ID |
RotateDays | No | Integer | The interval between each key rotation in days. Value range: 7 - 365 (default). |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
This example shows you how to enable key rotation for a specified CMK.
POST / HTTP/1.1
Host: kms.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: EnableKeyRotation
<Common request parameters>
{
"KeyId": "23e80852-1e38-11e9-b129-5cb9019b4b01"
}
{
"Response": {
"RequestId": "1b580852-1e38-11e9-b129-5cb9019b4b00"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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?