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

No exemplo a seguir, a consulta retorna informações da chave com ID key-hzz630494463ejqjx****. Os dados incluem o criador, a data de criação, o status da chave e o status da proteção contra exclusão.

Depuração

O OpenAPI Explorer calcula automaticamente o valor da assinatura. Recomendamos usar esta ferramenta para chamar a operação. O OpenAPI Explorer também gera dinamicamente códigos de exemplo para diferentes SDKs.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Exemplo	Descrição
Action	String	Sim	DescribeKey	Operação a ser executada. Defina o valor como DescribeKey.
KeyId	String	Sim	key-hzz630494463ejqjx****	ID, alias ou Alibaba Cloud Resource Name (ARN) da chave. Para mais informações, consulte Gerenciar um alias de 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}`.

Parâmetros de resposta

Parâmetro	Tipo	Exemplo	Descrição
RequestId	String	f1fdfa9d-bd49-418b-942f-8f3e3ec00a4f	ID da solicitação. Use este valor para localizar e solucionar problemas.
KeyMetadata	Object		Metadados da chave.
DeletionProtection	String	Enabled	Indica se a proteção contra exclusão está ativada. Valores válidos: Enabled Disabled
KeyId	String	key-hzz630494463ejqjx****	ID da chave. Se KeyId for definido como alias ou ARN, a resposta retornará o ID real da chave.
NextRotationDate	String	2021-07-06T18:22:03Z	Data e hora da próxima rotação. Nota Este parâmetro é retornado apenas quando AutomaticRotation é Enabled ou Suspended.
KeyState	String	Enabled	Status da chave. Para mais informações, consulte Impactos do status da chave nas operações de API.
RotationInterval	String	31536000s	Intervalo de rotação automática. Unidade: segundos. Por exemplo, o valor 604800s indica rotação automática a cada 7 dias. Nota Este parâmetro é retornado apenas quando AutomaticRotation é Enabled ou Suspended.
Arn	String	acs:kms:cn-hangzhou:154035569884**:key/key-hzz630494463ejqjx**	ARN da chave.
Creator	String	154035569884****	Conta Alibaba Cloud que criou a chave.
LastRotationDate	String	2024-05-20T06:34:21Z	Data e hora da última rotação (UTC). Para chaves novas, corresponde ao momento de geração da versão inicial.
DeleteDate	String	2024-05-26T18:22:03Z	Data e hora agendada para exclusão da chave (UTC). Para mais informações, consulte ScheduleKeyDeletion. Nota Este parâmetro é retornado apenas quando KeyState é PendingDeletion.
PrimaryKeyVersion	String	515e0b0a-624f-45ab-92b5-54f9b551****	ID da versão atual da chave primária simétrica.
Description	String	key description example	Descrição da chave.
KeySpec	String	Aliyun_AES_256	Tipo da chave.
Origin	String	Aliyun_KMS	Origem do material da chave.
MaterialExpireTime	String	2024-07-06T18:22:03Z	Data e hora de expiração do material da chave (UTC). Se vazio, o material não expira.
DeletionProtectionDescription	String	The key is being used by XXX. Deletion protection is set.	Descrição da proteção contra exclusão.
AutomaticRotation	String	Disabled	Indica se a rotação automática está ativada. Valores válidos: Enabled Disabled Suspended Para mais informações, consulte Rotação automática de chaves. Nota Apenas chaves simétricas suportam rotação automática.
ProtectionLevel	String	HSM	Nível de proteção da chave.
KeyUsage	String	ENCRYPT/DECRYPT	Uso da chave.
CreationDate	String	2024-05-20T06:34:21Z	Data e hora de criação da chave (UTC).
DKMSInstanceId	String	kst-bjj62d8f5e0sgtx8h****	ID da instância do Key Management Service (KMS).

Exemplos

Exemplos de solicitações

http(s)://[Endpoint]/?Action=DescribeKey
&KeyId=key-hzz630494463ejqjx****
&Common request parameters

Exemplos de respostas de sucesso

Formato XML

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

<DescribeKeyResponse>
    <RequestId>f1fdfa9d-bd49-418b-942f-8f3e3ec00a4f</RequestId>
    <KeyMetadata>
        <DeletionProtection>Enabled</DeletionProtection>
        <KeyId>key-hzz630494463ejqjx****</KeyId>
        <NextRotationDate>2021-07-06T18:22:03Z</NextRotationDate>
        <KeyState>Enabled</KeyState>
        <RotationInterval>31536000s</RotationInterval>
        <Arn>acs:kms:cn-hangzhou:154035569884****:key/key-hzz630494463ejqjx****</Arn>
        <Creator>154035569884****</Creator>
        <LastRotationDate>2024-05-20T06:34:21Z</LastRotationDate>
        <DeleteDate>2024-05-26T18:22:03Z</DeleteDate>
        <PrimaryKeyVersion>515e0b0a-624f-45ab-92b5-54f9b551****</PrimaryKeyVersion>
        <Description>key description example</Description>
        <KeySpec>Aliyun_AES_256</KeySpec>
        <Origin>Aliyun_KMS</Origin>
        <MaterialExpireTime>2024-07-06T18:22:03Z</MaterialExpireTime>
        <DeletionProtectionDescription>The key is being used by XXX. Deletion protection is set. </DeletionProtectionDescription>
        <AutomaticRotation>Disabled</AutomaticRotation>
        <ProtectionLevel>HSM</ProtectionLevel>
        <KeyUsage>ENCRYPT/DECRYPT</KeyUsage>
        <CreationDate>2024-05-20T06:34:21Z</CreationDate>
        <DKMSInstanceId>kst-bjj62d8f5e0sgtx8h****</DKMSInstanceId>
    </KeyMetadata>
</DescribeKeyResponse>

Formato JSON

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

{
  "RequestId" : "f1fdfa9d-bd49-418b-942f-8f3e3ec00a4f",
  "KeyMetadata" : {
    "DeletionProtection" : "Enabled",
    "KeyId" : "key-hzz630494463ejqjx****",
    "NextRotationDate" : "2021-07-06T18:22:03Z",
    "KeyState" : "Enabled",
    "RotationInterval" : "31536000s",
    "Arn" : "acs:kms:cn-hangzhou:154035569884****:key/key-hzz630494463ejqjx****",
    "Creator" : "154035569884****",
    "LastRotationDate" : "2024-05-20T06:34:21Z",
    "DeleteDate" : "2024-05-26T18:22:03Z",
    "PrimaryKeyVersion" : "515e0b0a-624f-45ab-92b5-54f9b551****",
    "Description" : "key description example",
    "KeySpec" : "Aliyun_AES_256",
    "Origin" : "Aliyun_KMS",
    "MaterialExpireTime" : "2024-07-06T18:22:03Z",
    "DeletionProtectionDescription" : "The key is being used by XXX. Deletion protection is set.",
    "AutomaticRotation" : "Disabled",
    "ProtectionLevel" : "HSM",
    "KeyUsage" : "ENCRYPT/DECRYPT",
    "CreationDate" : "2024-05-20T06:34:21Z",
    "DKMSInstanceId" : "kst-bjj62d8f5e0sgtx8h****"
  }
}

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.
404	Forbidden.KeyNotFound	The specified Key is not found.	A chave não existe.
404	Forbidden.AliasNotFound	The specified Alias is not found.	O alias especificado não foi encontrado.

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