文档首页/ 文档数据库服务 DDS/ API参考/ API v3（推荐）/ 管理数据库和用户/ 查询数据库列表
更新时间：2024-10-24 GMT+08:00
查看PDF
分享

查询数据库列表

接口说明

查询数据库列表。

约束说明

  • 该接口只支持DDS社区版。
  • 实例在创建、规格变更、修改端口、冻结、重启等过程中以及状态为非“normal”时，不允许执行该操作。

调试

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

URI

  • URI格式

    GET https://{Endpoint}/v3/{project_id}/instances/{instance_id}/databases?offset={offset}&limit={limit}

  • URI样例

    https://dds.cn-north-1.myhuaweicloud.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/659914406d2c4c76bce6a028ce8d8e0din02/databases?offset=1&limit=10

表1 请求参数

名称

类型

IN

是否必选

描述

X-Auth-Token

string

header

是

从IAM服务获取的用户Token。请参考认证鉴权。

project_id

string

path

是

租户在某一Region下的项目ID。请参考获取项目ID章节获取项目编号。

instance_id

string

path

是

实例ID，可以调用“查询实例列表和详情”接口获取。如果未申请实例，可以调用“创建实例”接口创建。

offset

Integer

path

否

索引位置偏移量。

取值大于或等于0。不传该参数时，查询偏移量默认为0。

limit

Integer

path

否

查询个数上限值。

取值范围：1~100。不传该参数时，默认查询前100条实例信息。

请求消息

无。

响应消息

响应示例

{ 
  "databases" : [ { 
    "name" : "dds-test", 
    "data_size" : "3593", 
    "storage_size" : "256", 
    "collection_num" : "5" 
  } ], 
  "total_count" : 1 
}

SDK

单击文档数据库服务 DDS SDK，下载SDK或查看SDK文档。SDK的安装、认证方式等在SDK文档中对应语言类型的【使用】目录下。

状态码

详情请参见状态码。

错误码

详情请参见错误码。

相关文档