tencent cloud

Key Management Service

Product Introduction
Product Overview
Product Strengths
Use Cases
Concepts
Purchase Guide
Billing Overview
Purchase Method
Renewal Instructions
Payment Overdue
Console Guide
Getting Started
Key Management
Access Control
Audit
TCCLI Management Guide
Operation Overview
Creating Key
Viewing Key
Editing Key
Enabling/Disabling Key
Key Rotation
Encryption and Decryption
Asymmetric key decryption
Deleting Key
Practical Tutorial
Symmetrical Encryption and Decryption
Asymmetric Encryption and Decryption
Post-Quantum Cryptography Practice In KMS
Importing External Key
Implementing Exponential Backoff to Deal with Service Frequency
Cloud Product Integration with KMS for Transparent Encryption
API documentation
History
Introduction
API Category
Key APIs
Making API Requests
Asymmetric Key APIs
Data Types
Error Codes
Service Level Agreement
FAQS
FAQs
General
KMS Policy
Privacy Policy
Data Processing And Security Agreement
Contact Us
Glossary
DocumentationKey Management Service TCCLI Management Guide Editing Key

Editing Key

PDF
Focus Mode
Font Size
Last updated: 2024-01-11 16:28:54

Overview

The operations of renaming a key and modifying key description involve the following two functions:
API Name
Description
Note
UpdateAlias
Renames a key
The KeyId and Alias parameters are required for this API. For more information, please see the UpdateAlias API document.
UpdateKeyDescription
Modifies key description
The KeyId and Description parameters are required for this API. For more information, please see the UpdateKeyDescription API document.
The examples below are called with TCCLI, which can also be called with any supported programming languages.

Examples

Renaming a key

Input

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 information will be returned.
{
    "RequestId": "489a4274-0b81-4db7-8160-542c5c5bed68"
}

Modifying key description

Input

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