1. API Description
Domain name for API request: kms.intl.tencentcloudapi.com.
This API is used to disable a master key. The disabled key cannot be used for encryption and decryption operations.
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.
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: DisableKey. |
| 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 |
| MemberAccount |
No |
MemberAccount |
Trusted service member account information. valid at that time when the current account is admin or delegated admin. |
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 Disabling a CMK
Disable the specified CMK.
https:
&KeyId=23e80852-1e38-11e9-b129-5cb9019b4b01
&<Common request parameters>
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.
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 |
| FailedOperation.CmkUsedByCloudProduct |
The CMK is being used by a Tencent Cloud product. |
| InternalError |
Internal error. |
| InvalidParameter |
Invalid parameter. |
| 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.NotRoleOperation |
Unsupported operations for user roles. |
| UnsupportedOperation.ServiceTemporaryUnavailable |
The service is temporarily unavailable. |