Todos os produtos
Search
Central de documentação

:ListAliases

Última atualização: Jul 08, 2026

Consulta todos os aliases de chave do Key Management Service (KMS) na região e na conta atuais.

Depuração

Execute esta interface no OpenAPI Explorer sem precisar calcular assinaturas. Após a execução, o OpenAPI Explorer gera automaticamente amostras de código SDK.

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Exemplo

Descrição

Action

String

Sim

ListAliases

Operação a executar. Defina o valor como ListAliases.

PageNumber

Integer

Não

1

Número da página a retornar. Valores válidos: inteiro maior que 0.

Valor padrão: 1.

PageSize

Integer

Não

10

Número máximo de resultados por página. Valores válidos: 0 a 100.

Valor padrão: 20.

Parâmetros de resposta

Parâmetro

Tipo

Exemplo

Descrição

RequestId

String

1b57992c-834b-4811-a889-f8bac1ba0353

ID da solicitação. Use-o para localizar e solucionar problemas.

PageNumber

Integer

1

Número da página retornada.

PageSize

Integer

10

Número máximo de resultados retornados por página.

TotalCount

Integer

1

Número total de aliases retornados.

Aliases

Array of Alias

Alias da chave.

Alias

KeyId

String

key-hzz6****

ID da chave mestra do cliente (CMK) associada ao alias especificado.

AliasArn

String

acs:kms:cn-hangzhou:123456:alias/ExampleAlias1

Alibaba Cloud Resource Name (ARN) do alias.

AliasName

String

alias/ExampleAlias1

Nome do alias.

Exemplos

Solicitações de exemplo

http(s)://[Endpoint]/?Action=ListAliases
&PageNumber=1
&PageSize=10
&<Common request parameters>

Respostas de sucesso de exemplo

Formato XML

HTTP/1.1 200 OK
Content-Type:application/xml

<ListAliasesResponse>
    <RequestId>1b57992c-834b-4811-a889-f8bac1ba0353</RequestId>
    <PageNumber>1</PageNumber>
    <PageSize>10</PageSize>
    <TotalCount>1</TotalCount>
    <Aliases>
        <KeyId>key-hzz6****</KeyId>
        <AliasArn>acs:kms:cn-hangzhou:123456:alias/ExampleAlias1</AliasArn>
        <AliasName>alias/ExampleAlias1</AliasName>
    </Aliases>
</ListAliasesResponse>

Formato JSON

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "1b57992c-834b-4811-a889-f8bac1ba0353",
  "PageNumber" : 1,
  "PageSize" : 10,
  "TotalCount" : 1,
  "Aliases" : [ {
    "KeyId" : "key-hzz6****",
    "AliasArn" : "acs:kms:cn-hangzhou:123456:alias/ExampleAlias1",
    "AliasName" : "alias/ExampleAlias1"
  } ]
}

Código de erro

HttpCode

Código de erro

Mensagem de erro

Descrição

400

InvalidParameter

The specified parameter is not valid.

O parâmetro especificado é inválido.

Para obter mais códigos de erro, consulte Códigos de erro do serviço.