Last updated: 2019-12-14 11:53:22

1. API Description

API domain name:

This API describes the attributes of the customer master key (CMK) based on the specified KeyId.

API request rate limit: 100 requests/sec.

2. Input Parameters

The list below contains only the API request parameters and certain common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeKey
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 Globally unique ID of the CMK

3. Output Parameters

Parameter name Type Description
KeyMetadata KeyMetadata Key attribute information
Note: This field may return null, indicating that no valid values can be obtained.
RequestId String Unique ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues.

4. Examples

Example 1. Getting Attributes of a CMK

Get the attribute details of the specified CMK.

Input Sample Code
&<Common request parameter>

Output Sample Code

  "Response": {
    "KeyMetadata": {
      "KeyId": "23e80852-1e38-11e9-b129-5cb9019b4b01",
      "Alias": "myalias",
      "CreateTime": 1548210729,
      "Description": "test cmk",
      "KeyState": "Enabled",
      "KeyUsage": "ENCRYPT_DECRYPT",
      "Type": 1,
      "CreatorUin": 1001,
      "KeyRotationEnabled": true,
      "Owner": "user",
      "NextRotateTime": 1553151489
    "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. *

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.