DescribeDBClusterEncryptionKey - PolarDB: Central de Documentação do Alibaba Cloud

Consulta os detalhes de uso da chave para um cluster PolarDB especificado.

Descrição da operação

Descrição

Consulta os detalhes de uso da chave para um cluster PolarDB, como o ID da chave, o status e o tipo.
O parâmetro DBClusterId é obrigatório. Ele especifica o ID do cluster PolarDB a ser consultado.
Antes de chamar esta operação, certifique-se de que as funções e políticas necessárias do Resource Access Management (RAM) estejam configuradas.

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

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

polardb:DescribeDBClusterEncryptionKey

get

*All Resource

*

Nenhuma

Sintaxe da solicitação

POST  HTTP/1.1

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
ClientToken	string	Não	Um token de cliente para garantir a idempotência da solicitação.	6000170000591aed949d0f******************
DBClusterId	string	Não	O ID do cluster. Nota Chame a operação DescribeDBClusters para consultar os detalhes de todos os clusters em sua conta, incluindo os IDs dos clusters.	pc-***

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O corpo da resposta.
RequestId	string	O ID da solicitação.	137ECCC0-920E-5B3B-9F8E-B81632108BBE
EncryptionKeyList	array<object>	A lista de chaves.
	object	Os detalhes da chave.
AliasName	string	O alias da chave.	alias/your_default_key
Creator	string	O UID da conta Alibaba Cloud que criou a chave.	1****1
DeleteDate	string	O horário agendado para excluir a chave. O formato é yyyy-MM-ddTHH:mm:ssZ (UTC). Este campo estará vazio se a chave não estiver agendada para exclusão.	2026-05-08T08:14:16Z
Description	string	A descrição da chave.	Description of the key
EncryptionKey	string	O ID da chave.	51858179-afb3-4369-8329-*********
EncryptionKeyStatus	string	O status da chave. Valores válidos: Enabled: A chave está ativada. Disabled: A chave não está ativada.	Enabled
KeyType	string	O tipo da chave. Valores válidos: CMK: chave mestra do cliente ServiceKey: chave de serviço	ServiceKey
KeyUsage	string	A finalidade da chave.	ENCRYPT/DECRYPT
MaterialExpireTime	string	O horário de expiração da chave. O formato é yyyy-MM-ddTHH:mm:ssZ (UTC).	2025-10-18T08:14:16Z
Origin	string	A origem da chave.	Aliyun_KMS
UsedBy	string	O serviço que usa a chave. Valores válidos: TDE: criptografia transparente de dados (TDE). DiskEncryption: criptografia de disco.	DiskEncryption

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "137ECCC0-920E-5B3B-9F8E-B81632108BBE",
  "EncryptionKeyList": [
    {
      "AliasName": "alias/your_default_key",
      "Creator": "1****1",
      "DeleteDate": "2026-05-08T08:14:16Z",
      "Description": "Description of the key",
      "EncryptionKey": "51858179-afb3-4369-8329-*********",
      "EncryptionKeyStatus": "Enabled",
      "KeyType": "ServiceKey",
      "KeyUsage": "ENCRYPT/DECRYPT",
      "MaterialExpireTime": "2025-10-18T08:14:16Z",
      "Origin": "Aliyun_KMS",
      "UsedBy": "DiskEncryption"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	IdempotentParameterMismatch	The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	The specified DBClusterId parameter is invalid.
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidDBInstance.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.