Creates an alias for a CMK.

When you create an alias, take note of the following points:

  • Each CMK can have only one alias.
  • The aliases of cmks must be unique in a region.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes CreateAlias

The operation that you want to perform. Set the value to CreateAlias.

AliasName String Yes alias/example

The alias to be modified.

It must be 1 to 255 characters in length and contain a prefix. alias/.

KeyId String Yes 1234abcd-12ab-34cd-56ef-12345678****

The globally unique ID of the CMK.

Response parameters

Parameter Type Example Description
RequestId String Cost

The ID of the request.

Examples

Sample requests

https://kms.cn-hangzhou.aliyuncs.com/? Action=CreateAlias
&KeyId=<cmkid>
&AliasName=<alias/example>
&<Common request parameters>

Sample success responses

XML format

//xml response
<KMS>
        <RequestId>1d2baaf3-d357-46c2-832e-13560c2bd9cd</RequestId>
</KMS>

JSON format

//json response
{
        "RequestId": "1d2baaf3-d357-46c2-832e-13560c2bd9cd"
}

Error codes

HTTP status code Error code Error message Description
400 Throttling Request was denied due to request throttling. This message returned because your traffic in this period has exceeded the limit. If your business requirements are not met, submit a ticket.

For a list of error codes, visit the API Error Center.