Domain name for API request: kms.tencentcloudapi.com.
This API is used to modify the description of the specified CMK. CMKs in PendingDelete
status cannot be modified.
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: UpdateKeyDescription. |
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. |
Description | Yes | String | New description of up to 1,024 bytes in length |
KeyId | Yes | String | ID of the CMK for which to modify the description |
Parameter Name | Type | Description |
---|---|---|
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
Modify the description of the specified CMK.
https://kms.tencentcloudapi.com/?Action=UpdateKeyDescription
&KeyId=23e80852-1e38-11e9-b129-5cb9019b4b01
&Description=NewDescription
&<Common request parameters>
{
"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.InvalidKeyId | Invalid KeyId . |
ResourceUnavailable.CmkNotFound | The CMK does not exist. |
UnauthorizedOperation | Unauthorized operation. |
UnsupportedOperation.ServiceTemporaryUnavailable | The service is temporarily unavailable. |
Was this page helpful?