调用ListDatabases API获取数据库列表-实时数仓 Hologres-阿里云

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

hologram:ListDatabases

list

*全部资源

*

无

请求语法

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

路径参数

名称	类型	必填	描述	示例值
instanceId	string	否	实例 id。	hgpostcn-cn-jfj3zckut008

请求参数

名称	类型	必填	描述	示例值
external	boolean	否	是否单独列出外表。true 是，false/null：否。	false

返回参数

名称	类型	描述	示例值
	object
RequestId	string	Id of the request	0C4935F5-6217-569A-902F-931B2F3E28BA
DatabaseList	array<object>	数据库列表
	object	数据库列表
Name	string	数据库名称。	my_db
PermissionModel	string	权限模型。请参考 Hologres 权限模型	SPM
Privilege	string	权限	developer
External	boolean	是否外表。true：是，false：否。	false
Success	string	请求结果，表示此次请求是否发生异常。	true
ErrorCode	string	错误码。	null
ErrorMessage	string	错误信息。	null
HttpStatusCode	string	http 状态码。	200

示例

正常返回示例

JSON格式

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

错误码

HTTP status code	错误码	错误信息	描述
403	NoPermission	RAM user permission is insufficient, please grant AliyunHologresReadOnlyAccess permission.

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

变更历史

更多信息，参考变更详情。