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

Consulta uma conta de banco de dados de um cluster PolarDB.

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

get

*dbcluster

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

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
DBClusterId	string	Sim	O ID do cluster.	pc-***************
AccountName	string	Não	O nome da conta.	test_acc
NodeType	string	Não	O tipo de nó. Obrigatório ao consultar a conta do nó de pesquisa do PolarDB Search	Search
PageNumber	integer	Não	O número da página retornada. O valor deve ser um número inteiro maior que 0. O valor padrão é 1.	1
PageSize	integer	Não	O número de entradas retornadas por página. Valores válidos: 30 50 100 O valor padrão é 30.	30

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
PageRecordCount	integer	O número de entradas retornadas por página.	1
RequestId	string	O ID da solicitação.	155462B9-205F-4FFC-BB43-4855FE******
PageNumber	integer	O número da página. As páginas começam na página 1.	1
Accounts	array<object>	Os detalhes da conta.
	array<object>
AccountDescription	string	A descrição da conta de banco de dados.	test
AccountStatus	string	O status da conta de banco de dados. Valores válidos: Creating: A conta está sendo criada. Available: A conta está disponível. Deleting: A conta está sendo excluída.	Available
AccountLockState	string	O status de bloqueio da conta. Valores válidos: UnLock: A conta não está bloqueada. Lock: A conta está bloqueada.	UnLock
AccountPasswordValidTime	string	O período de validade da senha.	undefined
AccountType	string	O tipo da conta. Valores válidos: Normal: conta padrão. Super: conta privilegiada. ReadOnly: conta global somente leitura.	Normal
DatabasePrivileges	array<object>	A lista de permissões de banco de dados concedidas à conta.
	object
AccountPrivilege	string	The permissions of the account.	ReadOnly
DBName	string	The database name.	DBtest
AccountName	string	O nome da conta de banco de dados.	test_acc

Exemplos

Resposta de sucesso

JSON formato

{
  "PageRecordCount": 1,
  "RequestId": "155462B9-205F-4FFC-BB43-4855FE******",
  "PageNumber": 1,
  "Accounts": [
    {
      "AccountDescription": "test",
      "AccountStatus": "Available",
      "AccountLockState": "UnLock",
      "AccountPasswordValidTime": "undefined",
      "AccountType": "Normal",
      "DatabasePrivileges": [
        {
          "AccountPrivilege": "ReadOnly",
          "DBName": "DBtest"
        }
      ],
      "AccountName": "test_acc"
    }
  ]
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	The specified PageSize parameter is invalid.
400	InvalidPageNumber.Malformed	The specified parameter PageNumber is not valid.	The specified PageNumber parameter is invalid.
400	Database.ConnectError	db instance %s connect failed, please check instance status and database processlist	Failed to connect to the database cluster. Check the cluster status and database process list.
400	Account.QueryError	Instance %s query account error	Failed to query accounts for cluster %s.
400	Connect.Timeout	Service can not connect to instance temporarily.	Failed to connect to the cluster.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
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.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.