ListDatabases - OpenSearch - Alibaba Cloud Documentation Center

Lists the existing databases.

Operation description

Method

GET

URI

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

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

searchengine:ListDatabases

list

*Instance

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

None

Request syntax

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

Path Parameters

Parameter	Type	Required	Description	Example
instanceId	string	Yes	The instance ID.	ha-cn-pl32rf0****

Request parameters

Parameter

Type

Required

Description

Example

No parameters required.

Response elements

Element	Type	Description	Example
	object
requestId	string	The request ID.	E45380E8-994A-5402-9806-F114B3295FCF
result	object	The returned result.
databases	array<object>	A list of databases.
	array<object>	A list of databases.
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

Examples

Success response

JSON format

{
  "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
          }
        ]
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.