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

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:DescribeUserEncryptionKeyList

get

*DBCluster.

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
PageSize	integer	Não	O tamanho da página. Valores válidos: 10 : 10 entradas por página. 30 : 30 entradas por página. 50 : 50 entradas por página. 100 : 100 entradas por página.	30
PageNumber	integer	Não	O número da página.	1
DBClusterId	string	Não	O ID do cluster. Nota Você pode chamar a operação DescribeDBClusters para consultar informações sobre todos os clusters na região especificada, incluindo o ID do cluster.	pc-************
RegionId	string	Não	O ID da região. Nota Você pode chamar a operação DescribeRegions para consultar as regiões disponíveis para a conta atual, incluindo o ID da região.	cn-hangzhou
TDERegion	string	Não	A região onde a chave TDE está localizada.	cn-beijing

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	A7E6A8FD-C50B-46B2-BA85-D8B8D3******
KeyList	array	A lista de chaves do cluster.
	string	A lista de chaves.	0275bd3f-fdbb-4d8c-846b-71b211******
TotalRecordCount	integer	O número total de registros.	1
PageRecordCount	integer	O número de registros na página atual.	1
PageNumber	integer	O número da página.	1
PageSize	integer	O tamanho da página.	30
DBClusterId	string	O ID do cluster.	pc-************

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "A7E6A8FD-C50B-46B2-BA85-D8B8D3******",
  "KeyList": [
    "0275bd3f-fdbb-4d8c-846b-71b211******"
  ],
  "TotalRecordCount": 1,
  "PageRecordCount": 1,
  "PageNumber": 1,
  "PageSize": 30,
  "DBClusterId": "pc-************"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	ByokRoleArnNotFound	The roleArn can't be null.
401	ByokNotAuthorizedToRds	This user is not Authorized Rds.	Este usuário não está autorizado pelo RDS.
403	UnsupportedKmsService.NotEnabled	KMS service is not enabled.	O serviço KMS não está ativado.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	A operação falhou. O ID da instância do cluster especificado não existe.
404	InvalidDBClusterId.NotFound	The DBClusterId provided does not exist in our records.	O DBClusterId especificado não existe nos registros atuais.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	O DBClusterId especificado não existe em nossos registros.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.