获取MongoDB实例库空间
更新时间：2025-05-07
接口描述
获取MongoDB实例下各个数据库的空间使用情况，包括存储空间、数据空间、索引空间、文档数量等信息。
权限说明
鉴权认证机制的详细内容请参见鉴权认证。
请求结构
Plain
1GET /api/v{version}/diagnosis/mongodb/space/database?appId=appId
2&nodeId=nodeId
3&database=database
4&orderBy=orderBy
5&order=order
6&page=page
7&pageSize=pageSize HTTP/1.1
8Host: dbsc.bj.baidubce.com
9Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 类型 | 必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| appId | string | 是 | Query参数 | 实例ID |
| nodeId | string | 否 | Query参数 | 节点ID |
| database | string | 否 | Query参数 | 数据库名，以模糊匹配方式进行搜索 |
| orderBy | string | 否 | Query参数 | 排序字段，参考返回结果中MongodbDatabaseSpaceItem结构字段 |
| order | string | 否 | Query参数 | 排序方式• 正序：asc• 倒序：desc |
| page | integer | 否 | Query参数 | 分页，默认是1 |
| pageSize | integer | 否 | Query参数 | 每页展示条数，默认是20 |
响应头域
无。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| items | List |
数据库空间信息列表 |
| totalCount | integer | 数据库总数 |
| collectionTime | string | 采集时间 |
MongodbDatabaseSpaceItem 结构
| 字段名 | 类型 | 说明 |
|---|---|---|
| database | string | 数据库名称 |
| collectionCount | int | 集合数量 |
| storageSize | int64 | 存储空间（字节），分配给空间用于存储文档的空间总和，包括可用空间 |
| dataSize | int64 | 数据空间（字节），保存的未压缩数据的总大小，当删除文档时会减小 |
| indexSize | int64 | 索引空间（字节），分配给所有索引的空间总和，包括可用索引空间 |
| objectCount | int64 | 文档数量，对象（文档）数量 |
| indexCount | int | 索引数量，索引总数 |
| avgObjSize | int64 | 平均文档大小（字节），即dataSize/objects |
| views | int | 视图数量，视图的数量 |
| fragmentationRatio | float64 | 碎片率，可回收空间/总空间 |
| indexFragmentationRatio | float64 | 索引碎片率，索引空闲空间/索引空间 |
| totalSize | int64 | 总空间（字节）， 存储大小和索引大小之和 |
| freeStorageSize | int64 | 文档空闲空间（字节），分配给空间用于存储文档的可用空间总和 |
| indexFreeStorageSize | int64 | 索引空闲空间（字节），分配给所有索引的可用空间总和 |
| totalFreeStorageSize | int64 | 总空闲空间（字节），文档空闲空间和索引空闲空间之和 |
请求示例
Plain
1GET /api/v1/diagnosis/mongodb/space/database?appId=***&nodeId=***&page=1&pageSize=10&order=desc&orderBy=totalSize HTTP/1.1
2Host: dbsc.bj.baidu.com
3Content-Type: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2023-07-11T11:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de响应示例
JSON
1{
2 "items": [
3 {
4 "database": "test",
5 "collectionCount": 6,
6 "storageSize": 23117824,
7 "dataSize": 29860222,
8 "indexSize": 24383488,
9 "objectCount": 904853,
10 "indexCount": 23,
11 "avgObjSize": 33,
12 "views": 0,
13 "fragmentationRatio": 0.3472,
14 "indexFragmentationRatio": 0.3504,
15 "compressRatio": 0.7742,
16 "totalSize": 47501312,
17 "freeStorageSize": 7950336,
18 "indexFreeStorageSize": 8544256,
19 "totalFreeStorageSize": 16494592
20 }
21 ],
22 "totalCount": 1,
23 "collectionTime": "2025-04-24T14:58:00Z"
24}