tencent cloud

Key Management Service

DocumentationKey Management Service TCCLI Management Guide Viewing Key

Viewing Key

Download
Focus Mode
Font Size
Last updated: 2026-07-30 16:45:13
AI-Translated

Overview

API Name
API Description
Description
ListKeys
List the keys (KeyId information) under your account.
This API operation has no required parameters. For details, see the ListKeys API.
DescribeKey
View the details of the specified CMK. The information includes key details such as the CMK name, ID, status, and region.
The KeyId parameter is required for this API operation. For details, see the DescribeKey API.
The examples in this document use the Tencent Cloud command-line tool TCCLI. Subsequently, you can make calls using any supported programming language.

Examples

Viewing the Key ID List Example

View the first five KeyId entries in the Guangdong region.

Inputs

tccli kms ListKeys --region ap-guangzhou --Limit 5

Output

{
    "Keys": [
        {
            "KeyId": "6xxxxxxx-xxxx-xxxx-xxxx-5xxxxxxxxc09"
        },
        {
            "KeyId": "6xxxxxxx-xxxx-xxxx-xxxx-5xxxxxxxxc09"
        },
        {
            "KeyId": "6xxxxxxx-xxxx-xxxx-xxxx-5xxxxxxxxc09"
        },
        {
            "KeyId":"6xxxxxxx-xxxx-xxxx-xxxx-5xxxxxxxxc09"
        },
        {
            "KeyId": "6xxxxxxx-xxxx-xxxx-xxxx-5xxxxxxxxc09"
        }
    ],
    "TotalCount": 114,
    "RequestId": "afaaeb5e-c97d-4726-8012-6ae337d62928"
}

Viewing the Key ID Details Example

View the details of the specified CMK.

Inputs

tccli kms DescribeKey --region ap-guangzhou --KeyId 521xxxxx-xxxx-xxxx-xxxx-52xxxxd4

Output

When the API is executed successfully, the details of the CMK are returned.
{
 "KeyMetadata": {
        "KeyId": "6xxxxxxx-xxxx-xxxx-xxxx-5xxxxxxxxc09",
        "Description": "this is test for gz key",
        "CreatorUin": 10xxxxxxxxxx,
        "KeyRotationEnabled": false,
        "NextRotateTime": 1603439621,
        "CreateTime": 1571903621,
        "Alias": "test-gz01",
        "KeyUsage": "ENCRYPT_DECRYPT",
        "DeletionDate": 0,
        "KeyState": "Enabled",
        "Type": 4,
        "Owner": "user"
    },
    "RequestId": "608f514c-3279-44ea-8e4c-c00b69e3521c"
}

Previous Topic: Creating KeyNext Topic: Editing Key

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback