ListKeys - : Central de Documentação do Alibaba Cloud

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Para sua conveniência, recomendamos chamar esta operação no OpenAPI Explorer. O OpenAPI Explorer 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	ListKeys	Operação a ser executada. Defina o valor como ListKeys.
PageNumber	Integer	Não	1	Número da página. A numeração começa em 1. Valor padrão: 1.
PageSize	Integer	Não	10	Número de entradas por página. Valores válidos: 1 a 100. Valor padrão: 10.
Filters	String	Não	[{"Key":"KeyState", "Values":["Enabled","Disabled"]}]	Filtro de CMK composto por um ou mais pares chave-valor. É possível especificar até 10 pares. Key Descrição: propriedade a filtrar. Tipo: string. Values Descrição: valor a incluir após a filtragem. Formato: array de strings. Comprimento: 0 a 10. Valores válidos: Se Key for KeyState, defina o valor como um estado de chave. Valores válidos: Enabled, Disabled, PendingDeletion ou PendingImport. Se Key for KeySpec, defina o valor como um tipo de chave. Valores válidos: Aliyun_AES_256, Aliyun_SM4, RSA_2048, EC_P256, EC_P256K, EC_SM2 e Aliyun_SM4. Observação: Chaves EC_SM2 ou Aliyun_SM4 só podem ser criadas em regiões com módulos de segurança de hardware (HSMs) gerenciados e certificados pela State Cryptography Administration (SCA). Para mais informações, consulte Regiões suportadas. Caso a região não suporte EC_SM2 e Aliyun_SM4, esses valores serão ignorados se especificados. Se Key for KeyUsage, defina o valor como a finalidade da chave. Valores válidos: ENCRYPT/DECRYPT e SIGN/VERIFY. ENCRYPT/DECRYPT indica uso para criptografia e descriptografia de dados. SIGN/VERIFY indica uso para assinatura de dados e verificação de assinaturas digitais. Se Key for ProtectionLevel, defina o valor como o nível de proteção da chave. Valores válidos: SOFTWARE ou HSM. ProtectionLevel só pode ser definido como HSM em regiões específicas. Para mais informações, consulte Regiões suportadas. Se a região não suportar HSM, o valor será ignorado caso especificado. Se Key for CreatorType, defina o valor como o tipo de criador. Valores válidos: User e Service. User consulta CMKs criadas pela conta atual. Service consulta CMKs criadas automaticamente por outros serviços de nuvem autorizados pela conta atual. Se Key for DKMSInstanceId, defina o valor como o ID da instância do Key Management Service (KMS). Se Key for keyId, defina o valor como um ID de chave. Se Key for AliasName, defina o valor como um alias de chave. Se Key for Creator, defina o valor como o criador da chave. Se Key for TagKey, defina o valor como uma chave de tag. Se Key for TagValue, defina o valor como um valor de tag. A relação lógica entre chaves diferentes é AND. A relação lógica entre os valores do campo Values em um par chave-valor é OR. Exemplo: `[ {"Key":"KeyState", "Values":["Enabled","Disabled"]}, {"Key":"KeyState", "Values":["PendingDeletion"]}, {"Key":"KeySpec", "Values":["Aliyun_AES_256"]} ]` . Neste exemplo, a semântica é: `(KeyState=Enabled OR KeyState=Disabled OR KeyState=PendingDeletion) AND (KeySpec=Aliyun_AES_ 256)`.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
PageNumber	Integer	1	Número da página.
PageSize	Integer	10	Número de entradas por página.
RequestId	String	8252db58-2036-408c-a3d5-56e656dc2551	ID da solicitação.
TotalCount	Integer	3	Número total de CMKs.
Keys	Array of Key		Array composto por CMKs.
Key
KeyId	String	08c33a6f-4e0a-4a1b-a3fa-7ddfa1d4****	ID da CMK. Deve ser globalmente único.
KeyArn	String	acs:kms:cn-hangzhou:123456:key/80e9409f-78fa-42ab-84bd-83f40c81****	Alibaba Cloud Resource Name (ARN) da CMK.

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=ListKeys
&PageNumber=1
&PageSize=10
&Filters=[{"Key":"KeyState", "Values":["Enabled","Disabled"]}]
&<Common request parameters>

Exemplos de respostas de sucesso

Formato XML

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

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

Formato JSON

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

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

Códigos de erro

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