Todos os produtos
Search
Central de documentação

:ListAliasesByKeyId

Última atualização: Jul 08, 2026

Consulta todos os aliases de uma chave.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos usar esta operação no OpenAPI Explorer para maior conveniência. A ferramenta também gera dinamicamente códigos de exemplo da operação para diferentes SDKs.

Parâmetros de solicitação

Parâmetro

Tipo

Obrigatório

Exemplo

Descrição

Action String Sim ListAliasesByKeyId

Operação a ser executada. Defina o valor como ListAliasesByKeyId.

KeyId String Sim key-hzz630494463ejqjx****

ID ou Alibaba Cloud Resource Name (ARN) da chave.

Nota Para acessar uma chave em outra conta Alibaba Cloud, insira o ARN da chave. O ARN segue o formato acs:kms:${region}:${account}:key/${keyid}.
PageNumber Integer Não 1

Número da página.

Valores válidos: inteiro maior que 0.

Valor padrão: 1.

PageSize Integer Não 10

Número de entradas por página.

Valores válidos: 0 a 101.

Valor padrão: 10.

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.

PageSize

Integer

10

Número de entradas por página.

TotalCount

Integer

1

Total de entradas retornadas.

Aliases

Array of Alias

Lista de aliases.

Alias

KeyId

String

key-hzz630494463ejqjx****

ID da chave. Se o KeyId na solicitação for definido como o ARN da chave, a resposta retornará o ID da chave.

AliasArn

String

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

ARN do alias.

AliasName

String

alias/ExampleAlias1

ID do alias.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=ListAliasesByKeyId
&KeyId=key-hzz630494463ejqjx****
&PageNumber=1
&PageSize=10
&Common request parameters

Exemplos de respostas de sucesso

Formato XML

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

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

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-hzz630494463ejqjx****",
    "AliasArn" : "acs:kms:cn-hangzhou:123456:alias/ExampleAlias1",
    "AliasName" : "alias/ExampleAlias1"
  } ]
}

Códigos de erro

Código de status HTTP

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 uma lista de códigos de erro, consulte Códigos de erro do serviço.