tencent cloud

Key Management Service

DocumentationKey Management Service TCCLI Management Guide Editing Key

Editing Key

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

Overview

The operation to modify a key's name and description consists of two functions, as follows:
API Name
API Description
Description
UpdateAlias
Modify the key name.
The KeyId and Alias parameters are required for this API operation. For details, see the UpdateAlias API documentation.
UpdateKeyDescription
Modify the key description.
The KeyId and Description parameters are required for this API operation. For details, see the UpdateKeyDescription API documentation.
The examples in this document use the Tencent Cloud command-line tool TCCLI. Subsequently, you can make calls using any supported programming language.

Examples

Example of Modifying a Key Name

Inputs

tccli kms UpdateAlias --region ap-guangzhou --KeyId 52xxxx-xxxx-xxxx-xxxx-5xxxx4 --Alias test-gz-01-d

Output

If the modification is successful, the following related information will be returned.
{
    "RequestId": "489a4274-0b81-4db7-8160-542c5c5bed68"
}

Example of Modifying Key Description Information

Inputs

tccli kms UpdateKeyDescription --region ap-guangzhou --KeyId 5xxxxx-xxxx-xxxx-xxxx-52xxxxx4 --Description 'this is change message for test'

Output

If the modification is successful, the following related information will be returned.
{
    "RequestId": "31134207-5de8-44f2-8c00-8bd0e88f95a6"
}

Previous Topic: Viewing KeyNext Topic: Enabling/Disabling Key

Help and Support

Was this page helpful?

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

Feedback