ListAliasesByKeyId - Key Management Service - Alibaba Cloud Documentation Center

Queries all aliases that are bound to a key.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
KeyId	string	Yes	The globally unique ID of the CMK.	1234abcd-12ab-34cd-56ef-12345678****
PageNumber	integer	No	The number of the page to return. Valid values: an integer that is greater than 0. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 0 to 101. Default value: 10	10

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request, which is used to locate and troubleshoot issues.	1b57992c-834b-4811-a889-f8bac1ba0353
PageNumber	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of returned CMKs.	1
Aliases	array<object>	An array that consists of aliases.
Alias	object
KeyId	string	The CMK to which an alias is bound.	08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****
AliasArn	string	The Alibaba Cloud Resource Name (ARN) of the alias.	acs:kms:cn-hangzhou:123456:alias/ExampleAlias1
AliasName	string	The ID of the alias.	alias/ExampleAlias1

Examples

Sample success responses

JSONformat

{
  "RequestId": "1b57992c-834b-4811-a889-f8bac1ba0353",
  "PageNumber": 1,
  "PageSize": 10,
  "TotalCount": 1,
  "Aliases": {
    "Alias": [
      {
        "KeyId": "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
        "AliasArn": "acs:kms:cn-hangzhou:123456:alias/ExampleAlias1",
        "AliasName": "alias/ExampleAlias1"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	The specified parameter is not valid.	An invalid value is specified for the parameter.
404	InvalidAccessKeyId.NotFound	The Access Key ID provided does not exist in our records.	-

For a list of error codes, visit the Service error codes.