Todos os produtos
Search
Central de documentação

Key Management Service:ListKeys

Última atualização: Jun 28, 2026

Consulta os IDs e ARNs de todas as CMKs na região atual.

Descrição da operação

Para obter mais informações sobre a política de acesso necessária para que um usuário do RAM ou uma função do RAM chame esta API, consulte Resource Access Management.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

PageNumber

integer

Não

O número da página.
Valores válidos: maior que 0.
Valor padrão: 1.

1

PageSize

integer

Não

O número de entradas a serem retornadas em cada página.
Valores válidos: 1 a 100.
Valor padrão: 10.

10

Filters

string

Não

Um filtro para chaves mestras. O filtro consiste em 0 a 10 pares chave-valor.

  • Key

    • Descrição: A propriedade a ser filtrada.

    • Tipo: String.

  • Values

    • Descrição: O valor a ser incluído após a filtragem.

    • Tipo: Array de strings.

    • Comprimento: 0 a 10.

Valores válidos:

  • Se `Key` estiver definido como `KeyState`, especifica o status da chave. Os valores válidos para `Value` são `Enabled`, `Disabled`, `PendingDeletion` e `PendingImport`.

  • Se `Key` estiver definido como `KeySpec`, especifica o tipo de chave. Os valores válidos para `Value` são `Aliyun_AES_256`, `Aliyun_SM4`, `RSA_2048`, `EC_P256`, `EC_P256K`, `EC_SM2` e `Aliyun_SM4`.
    Observação: Você pode criar chaves dos tipos `EC_SM2` e `Aliyun_SM4` apenas em regiões que suportam HSMs gerenciados e que passaram na avaliação de conformidade do Office of State Commercial Cryptography Administration (OSCCA). Para obter mais informações sobre as regiões suportadas, consulte Regiões suportadas. Se você especificar `EC_SM2` ou `Aliyun_SM4` em uma região que não suporta esses tipos de chave, os parâmetros serão ignorados.

  • Se `Key` estiver definido como `KeyUsage`, especifica o uso da chave. Os valores válidos para `Value` são `ENCRYPT/DECRYPT` (para criptografia e descriptografia de dados) e `SIGN/VERIFY` (para geração e verificação de assinaturas digitais).

  • Se `Key` estiver definido como `ProtectionLevel`, especifica o nível de proteção da chave. Os valores válidos para `Value` são `SOFTWARE` e `HSM`.
    Observação: O nível de proteção HSM é suportado apenas em regiões específicas. Para obter mais informações sobre as regiões suportadas, consulte Regiões suportadas. Se você especificar `HSM` em uma região que não o suporta, o parâmetro será ignorado.

  • Se `Key` estiver definido como `CreatorType`, especifica o tipo de criador. Os valores válidos para `Value` são `User` (retorna chaves mestras criadas por usuários) e `Service` (retorna chaves mestras que são criadas automaticamente por outros serviços do Alibaba Cloud com base na sua autorização).

  • Se `Key` estiver definido como `DKMSInstanceId`, especifica o ID da instância do KMS. Defina `Value` conforme necessário.

  • Se `Key` estiver definido como `keyId`, especifica o ID da chave. Defina `Value` conforme necessário.

  • Se `Key` estiver definido como `AliasName`, especifica o alias da chave. Defina `Value` conforme necessário.

  • Se `Key` estiver definido como `Creator`, especifica o criador da chave. Defina `Value` conforme necessário.

  • Se `Key` estiver definido como `TagKey`, especifica a chave de uma tag de chave. Defina `Value` conforme necessário.

  • Se `Key` estiver definido como `TagValue`, especifica o valor de uma tag de chave. Defina `Value` conforme necessário.

A relação lógica entre diferentes chaves em `Filters` é `AND`. A relação lógica entre vários valores para a mesma chave é `OR`. Por exemplo, se você inserir [ {"Key":"KeyState", "Values":["Enabled","Disabled"]}, {"Key":"KeyState", "Values":["PendingDeletion"]}, {"Key":"KeySpec", "Values":["Aliyun_AES_256"]} ], a semântica será: (KeyState=Enabled OR KeyState=Disabled OR KeyState=PendingDeletion) AND (KeySpec=Aliyun_AES_256).

[{"Key":"KeyState", "Values":["Enabled","Disabled"]}]

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

PageNumber

integer

O número da página.

1

PageSize

integer

O número de entradas retornadas por página.

10

RequestId

string

O ID da solicitação. É um identificador exclusivo global (GUID) gerado pelo Alibaba Cloud. Você pode usar o ID da solicitação para solucionar problemas.

8252db58-2036-408c-a3d5-56e656dc2551

TotalCount

integer

O número total de chaves mestras.

3

Keys

object

Key

array<object>

As chaves mestras.

object

A chave mestra.

KeyId

string

The globally unique identifier of the master key.

08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****

KeyArn

string

The Alibaba Cloud Resource Name (ARN) of the master key.

acs:kms:cn-hangzhou:123456:key/80e9409f-78fa-42ab-84bd-83f40c81****

Exemplos

Resposta de sucesso

JSON formato

{
  "PageNumber": 1,
  "PageSize": 10,
  "RequestId": "8252db58-2036-408c-a3d5-56e656dc2551",
  "TotalCount": 3,
  "Keys": {
    "Key": [
      {
        "KeyId": "08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****",
        "KeyArn": "acs:kms:cn-hangzhou:123456:key/80e9409f-78fa-42ab-84bd-83f40c81****"
      }
    ]
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.