检索指定主机上运行的所有数据库。
基本 URL： https://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/hosts/{HOST-ID}/databases
请求路径参数
Parameter | 类型 | 说明 |
|---|---|---|
PROJECT-ID | 字符串 | （必需。） 拥有此 MongoDB 进程的项目的唯一标识符。 |
HOST-ID | 字符串 | （必需。） 运行 MongoDB 进程的主机的唯一标识符。 |
请求查询参数
以下查询参数为可选参数：
名称 | 类型 | 必要性 | 说明 | 默认 |
|---|---|---|---|---|
pageNum | 数字 | Optional | 从一开始的整数，用于返回结果的一部分。 |
|
itemsPerPage | 数字 | Optional | 每页要返回的项目数，最多 500 个。 |
|
pretty | 布尔 | Optional |
| |
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些API客户端无法访问HTTP响应标头或状态代码。 要修复此问题，请在查询中设置 对于返回结果列表的端点， |
|
backupJobsEnabledOnly | 布尔 | Optional | 指示是否从响应中排除未启用备份数据库的守护进程的标志。 将其设置为 |
|
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应
响应文档
响应 JSON 文档包含一个 result 对象数组、一个 link 对象数组以及检索到的 result 对象总数。
名称 | 类型 | 说明 |
|---|---|---|
| 阵列 | 数组为 |
| 阵列 | 数组包含一个或多个指向子资源和/或相关资源的链接。URL之间的关系在Web 链接规范中进行了解释。 |
| 数字 | 结果集中项目总数的整数计数。 如果对整个结果集进行分页，则它可能大于results数组中的对象数。 |
results 嵌入式文档
每个结果都是一个数据库。
名称 | 类型 | 说明 |
|---|---|---|
| 字符串 | 数据库的名称。 |
| 阵列 | 指向数据库所属群组、运行数据库的MongoDB托管以及数据库测量值的链接。URL 之间的关系在Web 链接规范中进行了解释。 |
请求示例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/533c5895b910306f21033a/hosts/fd5b59188dc13ad142493/databases"
响应示例
响应标头
401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes} X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
响应体
{ "links" : [], "results" : [ { "databaseName" : "local", "links" : [] }, { "databaseName" : "production", "links" : [] }, { "databaseName" : "test", "links" : [] }, ], "totalCount" : 3 }