DescribeKmsKeys - ApsaraDB for MongoDB: Central de Documentação do Alibaba Cloud

Descrição da operação

As chaves consultadas estão disponíveis apenas para criptografia de disco.

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

dds:DescribeKmsKeys

get

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
RegionId	string	Não	O ID da região. Você pode chamar a operação DescribeRegions para consultar a lista de regiões mais recente.	cn-hangzhou

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	60EEBD77-227C-5B39-86EA-D89163C5****
KmsKeys	array<object>	As chaves KMS.
	object
KeyAlias	string	O alias da chave.	key-shh656820f4mh9qxxxxx alias/test1
KeyId	string	O ID da chave.	37291352-xxxx-xxxx-adbf-fd0630a95583

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "60EEBD77-227C-5B39-86EA-D89163C5****",
  "KmsKeys": [
    {
      "KeyAlias": "key-shh656820f4mh9qxxxxx     alias/test1",
      "KeyId": "37291352-xxxx-xxxx-adbf-fd0630a95583"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
404	EntityNotExistUser	The User does not exist.
404	EntityNotExistService	The Service mongodb.aliyuncs.com does not exist.
404	NoPermissionService	The Account NoPermission Error! Please Authorize The Account! Service Name: mongodb.aliyuncs.com, SLR Role:AliyunServiceRoleForMongoDB.
409	EntityAlreadyExistsRole	The Role already exists:AliyunServiceRoleForMongoDB.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.