查询数据库列表 - QueryingDatabases

功能介绍

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

调用接口前，您需要了解API 认证鉴权。
调用接口前，您需要提前获取到地区和终端节点。

调试

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

URI

GET /v3/{project_id}/instances/{instance_id}/databases

表1 参数说明
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：租户在某一Region下的项目ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及。
instance_id	是	String	参数解释：实例ID。约束限制：不涉及。取值范围：只能由英文字母、数字组成，且长度为32个字符。默认取值：不涉及。
offset	否	Integer	参数解释：分页符。从第一条数据偏移offset页数据后开始查询。例如：该参数指定为1，limit指定为10，则只展示第11-20条数据。约束限制：必须为数字，不能为负数。取值范围： [0, 2^31-1] 默认取值：默认为0（偏移0页数据，表示从第一条数据开始查询）。
limit	否	Integer	参数解释：每页显示的条目数量。约束限制：不涉及。取值范围： [1, 100] 默认取值：默认为10。

请求参数

无。

响应参数

表2 参数说明
参数	参数类型	描述
databases	Array of objects	参数解释：列表中每个元素表示一个数据库。详情参见表3。
total_count	Integer	参数解释：总记录数。取值范围： [0, 2^31 - 1]，实际总数取决于实例个数。

表3 databases字段数据结构说明
参数	参数类型	描述
name	String	参数解释：数据库名称。取值范围：不涉及。
owner	String	参数解释：数据库所属用户。取值范围：不涉及。
character_set	String	参数解释：数据库使用的字符集，例如UTF8。取值范围：不涉及。
collate_set	String	参数解释：数据库排序集，例如en_US.UTF-8等。取值范围：不涉及。
size	String	参数解释：数据库大小，单位MB。取值范围：不涉及。
datctype	String	参数解释：数据库使用的字符分类。取值范围： en_US.UTF-8：使用 UTF-8 编码，并且按照美式英语的排序规则对字符进行排序和比较。 zh_CN.UTF-8：使用 UTF-8 编码，并且按照简体中文的排序规则对字符进行排序和比较。
compatibility_type	String	参数解释：数据库兼容的类型。取值范围 GaussDB：GaussDB数据库兼容性。 ORA：Oracle兼容性。 MYSQL：MySQL数据库兼容性。 M：MySQL兼容性M-Compatibility模式。 TD：Teradata兼容性。 PG：PostgreSQL兼容性。

请求示例

查询数据库列表。

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

响应示例

查询数据库列表成功。

{
    "databases": [
        {
            "name": "gaussdb_test",
            "owner": "root",
            "size": "25 MB",
            "datctype": "en_US.UTF-8",
            "character_set": "UTF8",
            "collate_set": "en_US.UTF-8",
            "compatibility_type": "GaussDB"
        },
        {
            "name": "gaussdb_test1",
            "owner": "root",
            "size": "25 MB",
            "datctype": "en_US.UTF-8",
            "character_set": "UTF8",
            "collate_set": "en_US.UTF-8",
            "compatibility_type": "GaussDB"
        },
        {
            "name": "gaussdb_test2",
            "owner": "root",
            "size": "25 MB",
            "datctype": "en_US.UTF-8",
            "character_set": "UTF8",
            "collate_set": "en_US.UTF-8",
            "compatibility_type": "GaussDB"
        }
    ],
    "total_count": 3
}