tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

ListKeys

最后更新时间：2023-03-24 16:02:37

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 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.

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 Params. The value used for this API: ListKeys.
Version Yes String Common Params. The value used for this API: 2019-01-18.
Region No String Common Params. This parameter is not required for this API.
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
HsmClusterId No String ID of the HSM cluster. This field is only valid for Exclusive and Managed KMS instances.

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

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
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue.InvalidHsmClusterId Invalid HSM cluster ID.
UnauthorizedOperation Unauthorized operation.
Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
隐私条款服务条款缓存条款