Editing Key

Download

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"
}
﻿

Help and Support

Was this page helpful?

You can also Contact sales or Submit a Ticket for help.

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

Feedback

tencent cloud

Key Management Service

Editing Key

Overview

Examples

Renaming a key

Input

Output

Modifying key description

Input

Output

Help and Support

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.