ListDatabases - Hologres: 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

hologram:ListDatabases

list

*All Resource

*

Nenhuma

Sintaxe da solicitação

GET /api/v1/instances/{instanceId}/listDatabases HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
instanceId	string	Não	O ID da instância.	hgpostcn-cn-jfj3zckut008

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
external	boolean	Não	Especifica se devem ser listadas apenas tabelas externas. Se você definir este parâmetro como true, apenas tabelas externas serão listadas. Se você definir este parâmetro como false ou não o especificar, todas as tabelas serão listadas.	false

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	The response parameters.
RequestId	string	O ID da solicitação.	0C4935F5-6217-569A-902F-931B2F3E28BA
DatabaseList	array<object>	A lista de bancos de dados.
	object	A lista de bancos de dados.
Name	string	O nome do banco de dados.	my_db
PermissionModel	string	O modelo de permissão. Para obter mais informações, consulte Modelos de permissão do Hologres.	SPM
Privilege	string	A permissão.	developer
External	boolean	Indica se a tabela é uma tabela externa. true: A tabela é uma tabela externa. false: A tabela não é uma tabela externa.	false
Success	string	Indica se a solicitação foi bem-sucedida.	true
ErrorCode	string	O código de erro.	null
ErrorMessage	string	A mensagem de erro.	null
HttpStatusCode	string	O código de status HTTP.	200

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "0C4935F5-6217-569A-902F-931B2F3E28BA",
  "DatabaseList": [
    {
      "Name": "my_db",
      "PermissionModel": "SPM",
      "Privilege": "developer",
      "External": false
    }
  ],
  "Success": "true",
  "ErrorCode": "null",
  "ErrorMessage": "null",
  "HttpStatusCode": "200"
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro	Descrição
403	NoPermission	RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.