DescribeAccounts - ApsaraDB for MongoDB: 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

dds:DescribeAccounts

get

*Instance

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. Defina o valor como root.	root

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
RequestId	string	O ID da solicitação.	B562A65B-39AB-4EE8-8635-5A222054FB35
Accounts	object
Account	array<object>	Os detalhes da conta.
	object
CharacterType	string	The role of the account. Valid values: db: shard node cs: Configserver node mongos: mongos node logic: sharded cluster instance normal: replica set instance	mongos
AccountStatus	string	The status of the account. Valid values: Unavailable Available	Available
AccountDescription	string	The description of the account.	管理员
DBInstanceId	string	The ID of the instance to which the account belongs.	dds-bp1fd530f271****
AccountName	string	The name of the account.	root

Exemplos

Resposta de sucesso

JSON formato

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

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.