ListAliases - Key Management Service - Alibaba Cloud Documentation Center

Queries all aliases in the current region for the current account.

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
PageNumber	integer	No	The number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Valid values: 0 to 100. Default value: 10.	10

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	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 aliases.	1
Aliases	array<object>	The alias of the user.
Alias	object
KeyId	string	The CMK to which the alias belongs.	08c33a6f-4e0a-4a1b-a3fa-7ddfa1d****
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-7ddfa1d****",
        "AliasArn": "acs:kms:cn-hangzhou:123456:alias/ExampleAlias1",
        "AliasName": "alias/ExampleAlias1"
      }
    ]
  }
}

Error codes

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