Editing Key

Last updated: 2019-11-28 18:35:49

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

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help