edit-icon download-icon

CreateAlias

Last Updated: Apr 17, 2018

Description

Creates a display name for a CMK.

Note:

  • Each CMK can have multiple aliases, but each alias points to only one CMK.
  • The alias name must be unique in one account and region. You can use UpdateAlias to update the mapping between the alias and the key.
  • You can delete and change the aliases of a CMK without affecting the CMK.

Request parameters

Name Type Required Description
AliasName String Yes - The display name of the key. You can use the alias to call APIs such as Encrypt, GenerateDataKey, and DescribeKey.
- Not including the prefix, the minimum length of an alias is 1 and the maximum length is 255.
- The name must start with the word “alias” followed by a forward slash (alias/).
KeyId String Yes Globally unique identifier of the CMK.

Response parameters

Name Type Description
RequestId String ID of the request.

Examples

Request example

  1. https://kms.cn-hangzhou.aliyuncs.com/?Action=CreareAlias
  2. &KeyId=<cmkid>
  3. &AliasName=<alias/example>
  4. &<Common Request Parameters>

Response example

JSON format

  1. //json response
  2. {
  3. "RequestId": "53790170-1096-4ed2-9c3a-244d75c8740a"
  4. }

XML format

  1. //xml response
  2. <KMS>
  3. <RequestId>53790170-1096-4ed2-9c3a-244d75c8740a</RequestId>
  4. </KMS>
Thank you! We've received your feedback.