tencent cloud

DescribeDataKeys
Last updated: 2025-12-04 15:44:20
DescribeDataKeys
Last updated: 2025-12-04 15:44:20

1. API Description

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

This API is used to return the key attribute information list.

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: DescribeDataKeys.
Version Yes String Common Params. The value used for this API: 2019-01-18.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
DataKeyIds.N Yes Array of String Specifies the ID list of datakeys to query. supports up to 100 DataKey ids in a batch query.

3. Output Parameters

Parameter Name Type Description
DataKeyMetadatas Array of DataKeyMetadata Response data key attribute information list.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Retrieving Data Key Detail List Example

Input Example

POST / HTTP/1.1
Host: kms.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDataKeys
<Common request parameters>

{
    "DataKeyIds": [
        "7fe31abf-5018-11f0-b672-52540073b995",
        "8042dfcb-5018-11f0-b672-52540073b995"
    ]
}

Output Example

{
    "Response": {
        "DataKeyMetadatas": [
            {
                "CreateTime": 1750672660,
                "CreatorUin": 100000007998,
                "DataKeyId": "7fe31abf-5018-11f0-b672-52540073b995",
                "DataKeyName": "Test6331120",
                "DeletionDate": 0,
                "Description": "",
                "HsmClusterId": "",
                "KeyId": "0397abd8-4029-11f0-aa65-52540064acab",
                "KeyState": "Enabled",
                "NumberOfBytes": 32,
                "Origin": "EXTERNAL",
                "Owner": "user",
                "ResourceId": "creatorUin/100000007998/7fe31abf-5018-11f0-b672-52540073b995"
            },
            {
                "CreateTime": 1750672660,
                "CreatorUin": 100000007998,
                "DataKeyId": "8042dfcb-5018-11f0-b672-52540073b995",
                "DataKeyName": "miNAmDEc09znOK7jw9Yi3L9cmq8xk6z1",
                "DeletionDate": 0,
                "Description": "TestDateKey_01",
                "HsmClusterId": "",
                "KeyId": "0397abd8-4029-11f0-aa65-52540064acab",
                "KeyState": "Enabled",
                "NumberOfBytes": 1024,
                "Origin": "TENCENT_KMS",
                "Owner": "user",
                "ResourceId": "creatorUin/100000007998/8042dfcb-5018-11f0-b672-52540073b995"
            }
        ],
        "RequestId": "33c0c722-09e0-4f19-b16b-187a5898fd66"
    }
}

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.
InvalidParameterValue Incorrect parameter value.
InvalidParameterValue.DuplicatedDataKeyId Duplicate data key ID exists.
InvalidParameterValue.InvalidDataKeyId Invalid data key ID.
InvalidParameterValue.InvalidKeyId Invalid KeyId.
ResourceUnavailable.DataKeyNotFound The data key does not exist.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback