查看用户数据库列表
更新时间:2024-12-31
查询指定MongoDB实例所有的用户数据库。
说明
- 只能针对实例状态是RUNNING的实例进行操作。
请求结构
GET /v{version}/instance/{instanceId}?marker={marker}&maxKeys={maxKeys}&listDatabases HTTP/1.1
HOST: mongodb.bj.baidubce.com
Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
---|---|---|---|---|
version | String | 是 | URL参数 | API版本号 |
instanceId | String | 是 | URL参数 | 指定实例Id |
marker | String | 否 | Query参数 | 批量获取列表的查询的起始位置 |
maxKeys | int | 否 | Query参数 | 每页包含的最大数量,最大数量通常不超过1000,缺省值为10 |
返回头域
除公共头域,无其它特殊头域。
返回参数
参数名称 | 类型 | 描述 |
---|---|---|
marker | String | 批量获取列表的查询的起始位置。 |
maxKeys | int | 每页包含的最大数量。 |
isTruncated | boolean | true表示后面还有数据,false表示已经是最后一页 |
nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现 |
result | List Database | 用户数据库列表。 |
Database
参数名称 | 类型 | 描述 |
---|---|---|
name | String | 数据库名称 |
description | String | 数据库备注信息 |
请求示例
GET /v1/instance/m-qNlWTz?maxKeys=2&marker=db2&listDatabases HTTP/1.1
HOST: mongodb.bj.baidubce.com
Authorization: authorization string
返回示例
HTTP/1.1 200 OK
x-bce-request-id: 7869616F-7A68-6977-656E-406261696475
Content-Type: application/json
Content-Length: 0
{
"result": [
{
"name": "db2",
"description": ""
}
],
"marker": "db2",
"isTruncated": false,
"nextMarker": null,
"maxKeys": 2
}