DisableKey

Last updated: 2019-09-09 21:26:46

PDF

1. API Description

API domain name: kms.tencentcloudapi.com

This API disables a customer master key (CMK). Disabled CMKs cannot be used for encryption and decryption.

API request rate limit: 100 requests/sec.

2. Input Parameters

The following parameters are required for requesting this API, including action-specific parameters and common parameters. For more information about common parameters for all requests, see Common Request Parameters.

Parameter name Required Type Description
Action Yes String Common parameter. The value used for this API: DisableKey
Version Yes String Common parameter. The version of this API: 2019-01-18
Region Yes String Common parameter. For more information, see the List of Regions supported by the product.
KeyId Yes String Unique ID of the CMK

3. Output Parameters

Parameter name Type Description
RequestId String Unique ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Examples

Example 1. Disabling a CMK

Disable the specified CMK.

Input Sample Code

https://kms.tencentcloudapi.com/?Action=DisableKey
&KeyId=23e80852-1e38-11e9-b129-5cb9019b4b01
&<Common request parameter>

Output Sample Code

{
  "Response": {
    "RequestId": "1b580852-1e38-11e9-b129-5cb9019b4b00"
  }
}

5. Developer Resources

API Explorer

This tool makes it easy for you to call Tencent Cloud APIs, authenticate signature, generate SDK codes, and search for APIs

SDK

TencentCloud API 3.0 is integrated with software development toolkits (SDKs) for various programming languages, which makes it easier for you to call the APIs.

TCCLI

6. Error Codes

The following only lists the error codes related to this API. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue.InvalidKeyId Invalid KeyId.
ResourceUnavailable.CmkNotFound The CMK does not exist.
UnauthorizedOperation Unauthorized operation.