云数据库GaussDB如何查询数据库列表?

功能介绍

查询GaussDB指定实例中的数据库列表。

调用接口前,您需要了解API 认证鉴权

调用接口前,您需要提前获取到地区和终端节点,即下文中的Endpoint值。

调试

您可以在API Explorer中调试该接口。

请求消息

无。

URI

URI格式:GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/databases

URI样例:https://gaussdb-opengauss.cn-north-4.myhuaweicloud.com/v3/054b61972980d4552f0bc00ac8d3f5cd/instances/{instance_id}/databases

GaussDB查询数据库列表的参数说明

参数

是否必选

参数类型

描述

project_id

String

项目ID。

instance_id

String

实例ID。

offset

Integer

偏移量表示从此偏移量开始查询, offset大于等于0,默认0。

limit

Integer

每页显示的条目数量,取值范围[1, 100],默认10。

project_id

是否必选

参数类型

String

描述

项目ID。

instance_id

是否必选

参数类型

String

描述

实例ID。

offset

是否必选

参数类型

Integer

描述

偏移量表示从此偏移量开始查询, offset大于等于0,默认0。

limit

是否必选

参数类型

Integer

描述

每页显示的条目数量,取值范围[1, 100],默认10。

GaussDB查询数据库列表的响应消息-参数说明

以下为正常响应要素说明,异常响应请参见异常请求结果


参数

参数类型

描述

databases

Array of objects

列表中每个元素表示一个数据库。详情参见下面表格,databases字段数据结构说明。

total_count

Integer

总记录数。

databases

参数类型

Array of objects

描述

列表中每个元素表示一个数据库。详情参见下面表格,databases字段数据结构说明。

total_count

参数类型

Integer

描述

总记录数。

GaussDB查询数据库列表的响应消息-databases字段数据结构说明

参数

参数类型

描述

name

String

数据库名称。

owner

String

数据库所属用户。

character_set

String

数据库使用的字符集,例如UTF8。

collate_set

String

数据库排序集,例如en_US.UTF-8等。

size

String

数据库大小。

name

参数类型

String

描述

数据库名称。

owner

参数类型

String

描述

数据库所属用户。

character_set

参数类型

String

描述

数据库使用的字符集,例如UTF8。

collate_set

参数类型

String

描述

数据库排序集,例如en_US.UTF-8等。

size

参数类型

String

描述

数据库大小。

GaussDB查询数据库列表的正常响应样例

参数模板列表

{
"databases" : [ {
"name" : "rds-test",
"character_set" : "utf8",
"owner" : "root",
"collate_set" : "en_US.UTF-8",
"size" : 10777247
}, {
"name" : "testdb1",
"character_set" : "utf8",
"owner" : "root",
"collate_set" : "en_US.UTF-8",
"size" : 10777247
}, {
"name" : "tt",
"character_set" : "utf8",
"owner" : "root",
"collate_set" : "en_US.UTF-8",
"size" : 10777247
} ],
"total_count" : 3
}


GaussDB查询数据库列表的状态码及错误码

参数

参数类型

状态码

正常202。


错误码

请参见错误码

状态码

参数类型

正常202。


错误码

参数类型

请参见错误码

GaussDB优质文章锦集