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

Consulta os metadados de uma CMK, como o estado da chave, o uso e a configuração de rotação.

Descrição da operação

Você pode consultar as informações sobre a CMK 05754286-3ba2-4fa6-8d41-4323aca6**** usando as configurações de parâmetros fornecidas neste tópico. As informações incluem o criador, a hora de criação, o status e o status de proteção contra exclusão da CMK.

Para obter mais informações sobre a política de acesso necessária para que um usuário RAM ou uma função 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
KeyId	string	Sim	O ID da CMK. O ID deve ser globalmente exclusivo. Você também pode definir este parâmetro como um alias vinculado à CMK. Para obter mais informações, consulte Visão geral dos aliases.	key-hzz630494463ejqjx****

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	f1fdfa9d-bd49-418b-942f-8f3e3ec00a4f
KeyMetadata	object	Os metadados da CMK.
DeletionProtection	string	Indica se a proteção contra exclusão está ativada. Valores válidos: Enabled Disabled	Enabled
KeyId	string	O ID da CMK. O ID deve ser globalmente exclusivo.	key-hzz630494463ejqjx****
NextRotationDate	string	A hora em que a próxima rotação será realizada. Nota Este parâmetro é retornado apenas quando o valor do parâmetro AutomaticRotation é Enabled ou Suspended.	2021-07-06T18:22:03Z
KeyState	string	O status da CMK. Para obter mais informações, consulte Impacto do status da CMK nas operações de API.	Enabled
RotationInterval	string	O intervalo para rotação automática de chaves. Unidade: segundos. Por exemplo, se o valor for 604800s, a rotação automática de chaves será realizada em um intervalo de 7 dias. Nota Este parâmetro é retornado apenas quando o valor do parâmetro AutomaticRotation é Enabled ou Suspended.	31536000s
Arn	string	O Alibaba Cloud Resource Name (ARN) da CMK.	acs:kms:cn-hangzhou:154035569884**:key/key-hzz630494463ejqjx**
Creator	string	A conta Alibaba Cloud usada para criar a CMK.	154035569884****
LastRotationDate	string	A hora em que a última rotação foi realizada. A hora é exibida em UTC. Para uma nova CMK, o valor deste parâmetro é a hora em que a versão inicial da CMK foi gerada.	2024-05-20T06:34:21Z
DeleteDate	string	A hora em que a CMK está programada para exclusão. A hora é exibida em UTC. Para obter mais informações, consulte ScheduleKeyDeletion. Nota Este parâmetro é retornado apenas quando o valor do parâmetro KeyState é PendingDeletion.	2024-05-26T18:22:03Z
PrimaryKeyVersion	string	O ID da versão atual da chave primária para a CMK simétrica.	515e0b0a-624f-45ab-92b5-54f9b551****
Description	string	A descrição da CMK.	key description example
KeySpec	string	O tipo da CMK.	Aliyun_AES_256
Origin	string	A origem do material da chave para a CMK.	Aliyun_KMS
MaterialExpireTime	string	A hora em que o material da chave expira. A hora é exibida em UTC. Se o valor deste parâmetro estiver vazio, o material da chave não expira.	2024-07-06T18:22:03Z
DeletionProtectionDescription	string	A descrição da proteção contra exclusão.	The CMK is being used by XXX. Deletion protection is set.
AutomaticRotation	string	Indica se a rotação automática de chaves está ativada. Valores válidos: Enabled Disabled Suspended Para obter mais informações, consulte Rotação automática de chaves. Nota Apenas CMKs simétricas suportam rotação automática de chaves.	Disabled
ProtectionLevel	string	O nível de proteção da CMK.	HSM
KeyUsage	string	O uso da CMK.	ENCRYPT/DECRYPT
CreationDate	string	A hora em que a CMK foi criada. A hora é exibida em UTC.	2024-05-20T06:34:21Z
DKMSInstanceId	string	O ID da instância dedicada do KMS.	kst-bjj62d8f5e0sgtx8h****

Exemplos

Resposta de sucesso

JSON formato

{
  "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 CMK 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.	An invalid value is specified for the parameter.
404	Forbidden.KeyNotFound	The specified Key is not found.	The error message returned because the specified CMK does not exist.
404	Forbidden.AliasNotFound	The specified Alias is not found.	The error message returned because the specified alias does not exist.
404	InvalidAccessKeyId.NotFound	The Access Key ID provided does not exist in our records.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.