DescribeKeys

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

1. API Description

API domain name: kms.tencentcloudapi.com

This API describes the attribute information of the specified customer master keys (CMKs) in batches.

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: DescribeKeys
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.
KeyIds.N Yes Array of String ID of CMKs to be queried in batches. Up to 100 KeyIds are supported for each query

3. Output Parameters

Parameter name Type Description
KeyMetadatas Array of KeyMetadata Returned attribute information list
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 Multiple CMKs

Get attributes of multiple CMKs.

Input Sample Code

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

Output Sample Code

{
  "Response": {
    "KeyMetadatas": [
      {
        "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
      },
      {
        "KeyId": "23e80852-1e38-11e9-b129-5cb9019b4b02",
        "Alias": "testalias",
        "CreateTime": 1548210730,
        "Description": "test cmk",
        "KeyState": "Disabled",
        "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.

SDK

TencentCloud API 3.0 integrates software development toolkits (SDKs) for various programming languages, facilitating API calls.

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.DuplicatedKeyId The KeyId is duplicated.
InvalidParameterValue.InvalidKeyId Invalid KeyId.
ResourceUnavailable.CmkNotFound The CMK does not exist.
UnauthorizedOperation Unauthorized operation.