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

Consulta as informações da conta do banco de dados de uma instância do ApsaraDB for MongoDB.

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

get

*Instância.

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBInstanceId	string	Sim	O ID da instância.	dds-bp1fd530f271****
AccountName	string	Não	O nome da conta.	root

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Accounts	object
Account	array<object>	A lista de informações da conta.
	array<object>
AccountDescription	string	A descrição da conta. Nota Este parâmetro é retornado somente após você chamar a operação ModifyAccountDescription para definir a descrição da conta.	Administrator
AccountName	string	O nome da conta.	root
AccountStatus	string	O status da conta. Valores válidos: Unavailable: A conta está indisponível. Available: A conta está disponível.	Available
CharacterType	string	O tipo de função da conta. Valores válidos: db: A função de shard. cs: A função de config server. mongos: A função de mongos. logic: A instância de cluster sharded. normal: A instância de replica set.	mongos
DBInstanceId	string	O ID da instância à qual a conta pertence.	dds-bp1fd530f271****
DBName	string	O banco de dados ao qual a conta pertence.	admin
Roles	object
Role	array<object>	A lista de permissões da conta.
	object	A permissão da conta.
DBName	string	O banco de dados autorizado para a função.	admin
Role	string		read
RequestId	string	O ID da solicitação.	B562A65B-39AB-4EE8-8635-5A222054FB35

Exemplos

Resposta de sucesso

JSON formato

{
  "Accounts": {
    "Account": [
      {
        "AccountDescription": "管理员",
        "AccountName": "root",
        "AccountStatus": "Available",
        "CharacterType": "mongos",
        "DBInstanceId": "dds-bp1fd530f271****",
        "DBName": "admin",
        "Roles": {
          "Role": [
            {
              "DBName": "admin",
              "Role": "read"
            }
          ]
        }
      }
    ]
  },
  "RequestId": "B562A65B-39AB-4EE8-8635-5A222054FB35"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
403	ResponseEmptyError	The Response is empty, maybe server request timeout.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.