Updated on 2025-12-02 GMT+08:00

Changing the Alias and Description of a Key

Scenario

Key aliases help you find custom keys more easily.

This section describes how to change the alias and description of a custom key on the KMS management console.

  • The alias and description of the default master key cannot be modified. The alias of the default master key ends with /default.
  • The alias and description of a key cannot be changed if the key is in Pending deletion status.

Prerequisites

  • The custom key is in Enabled, Disabled, or Pending import status.

Procedure

  1. Log in to the management console.
  2. Click in the upper left corner of the management console and select a region or project.
  3. Choose Security > Data Encryption Workshop. The key management page is displayed.
  4. Click the alias or description of the target key to access its details page.
  5. To change the alias or description of a key, click next to Alias or Description.

    Figure 1 Key details
    • The alias can contain 1 to 255 characters. Only digits, letters, underscores (_), hyphens (-), colons (:), and forward slashes (/) are allowed.
    • Length of the description cannot exceed 255 characters.

  6. Click to save the changes.