获取MongoDB实例集合空间趋势
更新时间:2025-05-07
接口描述
获取MongoDB实例下指定集合的空间使用趋势信息,包括存储空间、数据空间、索引空间、文档数量等各项指标的历史变化情况。
权限说明
鉴权认证机制的详细内容请参见鉴权认证。
请求结构
Plain
1GET /api/v{version}/diagnosis/mongodb/space/collection/trend?appId=appId
2&nodeId=nodeId
3&database=database
4&collection=collection
5&period=period
6&start=start
7&end=end
8&metrics=metrics
9&statistics=statistics HTTP/1.1
10Host: dbsc.bj.baidubce.com
11Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
参数名称 | 类型 | 必选 | 参数位置 | 描述 |
---|---|---|---|---|
appId | string | 是 | Query参数 | 实例ID |
nodeId | string | 否 | Query参数 | 节点ID |
database | string | 是 | Query参数 | 数据库名称 |
collection | string | 是 | Query参数 | 集合名称 |
period | integer | 是 | Query参数 | 时间间隔(秒),如3600表示按小时聚合数据 |
start | string | 否 | Query参数 | 开始时间,格式:2023-11-01T00:00:00Z |
end | string | 否 | Query参数 | 结束时间,格式:2023-11-07T00:00:00Z |
metrics | string | 否 | Query参数 | 指标列表,多个指标用逗号分隔,支持的指标参考下表 |
statistics | string | 否 | Query参数 | 统计类型,多个类型用逗号分隔。支持的类型包括:avg:平均值max:最大值min:最小值sum:累加值count:总数 |
支持的指标(metrics)
指标名称 | 描述 |
---|---|
totalSize | 总大小(存储大小+索引大小) |
storageSize | 存储大小(分配给空间用于存储文档的空间总和) |
dataSize | 数据大小(保存的未压缩数据的总大小) |
indexSize | 索引大小(分配给所有索引的空间总和) |
objectCount | 文档数量 |
indexCount | 索引数量 |
avgObjSize | 平均文档大小(字节) |
freeStorageSize | 文档空闲空间 |
totalFreeStorageSize | 总空闲空间 |
indexFreeStorageSize | 索引空闲空间 |
fragmentationRatio | 碎片率 |
indexFragmentationRatio | 索引碎片率 |
响应头域
无。
响应参数
参数名称 | 类型 | 描述 |
---|---|---|
result | TrendResultBase | 趋势数据结果 |
TrendResultBase 结构
字段名 | 类型 | 说明 |
---|---|---|
category | List |
时间列表,例如:["2023-11-01T00:00:00Z", "2023-11-01T01:00:00Z", ...] |
series | List |
各个指标的数据列表 |
TrendResultSeries 结构
字段名 | 类型 | 说明 |
---|---|---|
name | string | 指标名称,如 totalSize、storageSize 等 |
data | Array |
各个时间点的指标数据列表 |
TrendResultData 结构
字段名 | 类型 | 说明 |
---|---|---|
avg | float64 | 平均值 |
sum | float64 | 累加值 |
max | float64 | 最大值 |
min | float64 | 最小值 |
count | uint64 | 数量 |
请求示例
Plain
1GET /api/v1/diagnosis/mongodb/space/collection/trend?appId=***&nodeId=***&database=admin&collection=users&period=18600&start=2023-11-01T00:00:00Z&end=2023-11-04T00:00:00Z&metrics=totalSize,storageSize&statistics=avg,max 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 "result": {
3 "category": [
4 "2023-11-01T00:00:00Z",
5 "2023-11-02T00:00:00Z",
6 "2023-11-03T00:00:00Z"
7 ],
8 "series": [
9 {
10 "name": "totalSize",
11 "data": [
12 {
13 "avg": 512000,
14 "sum": 512000,
15 "max": 512000,
16 "min": 512000,
17 "count": 1
18 },
19 {
20 "avg": 512500,
21 "sum": 512500,
22 "max": 512500,
23 "min": 512500,
24 "count": 1
25 },
26 {
27 "avg": 513000,
28 "sum": 513000,
29 "max": 513000,
30 "min": 513000,
31 "count": 1
32 }
33 ]
34 },
35 {
36 "name": "storageSize",
37 "data": [
38 {
39 "avg": 256000,
40 "sum": 256000,
41 "max": 256000,
42 "min": 256000,
43 "count": 1
44 },
45 {
46 "avg": 256500,
47 "sum": 256500,
48 "max": 256500,
49 "min": 256500,
50 "count": 1
51 },
52 {
53 "avg": 257000,
54 "sum": 257000,
55 "max": 257000,
56 "min": 257000,
57 "count": 1
58 }
59 ]
60 }
61 ]
62 }
63}