Tencent Cloud

search by keyword

Recent Pages

Documentation

ListKeys

Last updated: 2020-07-03 17:28:19

1. API Description

Domain name for API request: kms.tencentcloudapi.com.

This API is used to list the KeyIds of CMKs in Enabled, Disabled, and PendingImport status under the account.

A maximum of 50 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.

2. Input Parameters

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 parameter. The value used for this API: ListKeys.
Version	Yes	String	Common parameter. The value used for this API: 2019-01-18.
Region	Yes	String	Common parameter. For more information, please see the list of regions supported by the product.
Offset	No	Integer	This parameter has the same meaning of the `Offset` in an SQL query, indicating that this acquisition starts from the "No. Offset value" element of the array arranged in a certain order. The default value is 0
Limit	No	Integer	This parameter has the same meaning of the `Limit` in an SQL query, indicating that up to `Limit` value elements can be obtained in this request. The default value is 10 and the maximum value is 200
Role	No	Integer	Filter by creator role. 0 (default value): the CMK is created by the user; 1: the CMK is created automatically by an authorized Tencent Cloud service

3. Output Parameters

Parameter Name	Type	Description
Keys	Array of Key	CMK list array
TotalCount	Integer	Total number of CMKs
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting CMK list

This example shows you how to get the list of CMKs.

Input Example

https://kms.tencentcloudapi.com/?Action=ListKeys
&Offset=0
&Limit=2
&<common request parameters>

Output Example

{
  "Response": {
    "RequestId": "1b580852-1e38-11e9-b129-5cb9019b4b00",
    "Keys": [
      {
        "KeyId": "23e80852-1e38-11e9-b129-5cb9019b4b01"
      },
      {
        "KeyId": "23e80852-1e38-11e9-b129-5cb9019b4b02"
      }
    ],
    "TotalCount": 100
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.