ListDatabases - 展示已有数据库_智能开放搜索 OpenSearch(Open Search)-阿里云帮助中心

展示已有数据库。

接口说明

方法

GET

URI

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

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
searchengine:ListDatabases	list	Instance acs:searchengine:{#regionId}:{#accountId}:instance/{#instanceId}	无	无

请求语法

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

请求参数

名称	类型	必填	描述	示例值
instanceId	string	是	实例 id	ha-cn-pl32rf0****

返回参数

名称	类型	描述	示例值
	object
requestId	string	请求 ID。	E45380E8-994A-5402-9806-F114B3295FCF
result	object	返回结果。
databases	array<object>	数据库信息列表
database	object	数据库信息列表
database	string	数据库名称	general
sqlInstances	array<object>	sql 实例信息
sqlInstance	object	sql 实例信息
id	long	主键 id	12190
name	string	sql 实例名称	general
type	string	table, instance, template, function	instance
parent	long	父任务 id。	-1
children	array	子目录信息
children	any	子目录信息	1
isDir	integer	是否为目录。取值：-true：是-false：否	true
instanceId	long	实例 id	1
templateId	long	模板 ID。	1
templates	array<object>	模板信息
template	object	模版信息
id	long	主键 id	1
name	string	模版名称	c26_schema
type	string	table, instance, template, function	template
parent	long	父节点 id。	-1
children	array	子目录信息
children	any	子目录信息	1
isDir	integer	是否为目录。取值：-true：是-false：否	true
instanceId	long	实例 id	1
templateId	long	模板 ID。	1
functions	object	函数信息。
	array<object>	函数信息。
item	object	函数信息。
name	string	函数名称	test
signatures	string	签名	gfasdds2****2wfrkv
tables	array<object>	表信息。
table	object	表信息。
id	long	主键 id	56
name	string	表名	general
type	string	table, instance, template, function	table
parent	long	父节点 id。	-1
children	array	子目录信息
children	any	子目录信息	1
isDir	integer	是否为目录。取值：-true：是-false：否	true
instanceId	long	实例 ID	1
templateId	long	模板 ID。	1

示例

正常返回示例

JSON格式

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

错误码

访问错误中心查看更多错误码。