ListDatabases - OpenSearch: Central de Documentação do Alibaba Cloud

Lista os bancos de dados existentes.

Descrição da operação

Método

GET

URI

/openapi/ha3/instances/{instanceId}/sql-studio/databases

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

searchengine:ListDatabases

list

*Instance

acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}

Nenhuma

Sintaxe da solicitação

GET /openapi/ha3/instances/{instanceId}/sql-studio/databases HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
instanceId	string	Sim	O ID da instância.	ha-cn-pl32rf0****

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Nenhum parâmetro necessário.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
requestId	string	O ID da solicitação.	E45380E8-994A-5402-9806-F114B3295FCF
result	object	O resultado retornado.
databases	array<object>	Uma lista de bancos de dados.
	array<object>	Uma lista de bancos de dados.
database	string	The name of the database.	general
sqlInstances	array<object>	The information about the SQL instances.
	object	The information about the SQL instances.
id	integer	The primary key ID.	12190
name	string	The name of the SQL instance.	general
type	string	table, instance, template, function	instance
parent	integer	The ID of the parent node.	-1
children	array	The information about the subdirectories.
	any	The information about the subdirectories.	1
isDir	integer	Indicates whether the item is a folder. A value of 1 indicates that the item is a folder. A value of 0 indicates that it is not a folder.	true
instanceId	integer	The instance ID.	1
templateId	integer	The template ID.	1
templates	array<object>	The information about the templates.
	object	The information about the template.
id	integer	The primary key ID.	1
name	string	The name of the template.	c26_schema
type	string	table, instance, template, function	template
parent	integer	The ID of the parent node.	-1
children	array	The information about the subdirectories.
	any	The information about the subdirectories.	1
isDir	integer	Indicates whether the item is a folder. A value of 1 indicates that the item is a folder. A value of 0 indicates that it is not a folder.	true
instanceId	integer	The instance ID.	1
templateId	integer	The template ID.	1
functions	object	The information about the functions.
	array<object>	The information about the functions.
	object	The information about the functions.
name	string	The name of the function.	test
signatures	string	The signature.	gfasdds2****2wfrkv
tables	array<object>	The information about the tables.
	object	The information about the tables.
id	integer	The primary key ID.	56
name	string	The name of the table.	general
type	string	table, instance, template, function	table
parent	integer	The ID of the parent node.	-1
children	array	The information about the subdirectories.
	any	The information about the subdirectories.	1
isDir	integer	Indicates whether the item is a folder. A value of 1 indicates that the item is a folder. A value of 0 indicates that it is not a folder.	true
instanceId	integer	The instance ID.	1
templateId	integer	The template ID.	1

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "E45380E8-994A-5402-9806-F114B3295FCF",
  "result": {
    "databases": [
      {
        "database": "general",
        "sqlInstances": [
          {
            "id": 12190,
            "name": "general",
            "type": "instance",
            "parent": -1,
            "children": [
              "1"
            ],
            "isDir": 0,
            "instanceId": 1,
            "templateId": 1
          }
        ],
        "templates": [
          {
            "id": 1,
            "name": "c26_schema",
            "type": "template",
            "parent": -1,
            "children": [
              "1"
            ],
            "isDir": 0,
            "instanceId": 1,
            "templateId": 1
          }
        ],
        "functions": {
          "key": [
            {
              "name": "test",
              "signatures": "gfasdds2****2wfrkv"
            }
          ]
        },
        "tables": [
          {
            "id": 56,
            "name": "general",
            "type": "table",
            "parent": -1,
            "children": [
              "1"
            ],
            "isDir": 0,
            "instanceId": 1,
            "templateId": 1
          }
        ]
      }
    ]
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.