获取MySQL实例库空间
更新时间:2025-05-07
接口描述
获取MySQL实例下各个数据库的空间使用情况。
权限说明
鉴权认证机制的详细内容请参见鉴权认证。
请求结构
Plain
1GET /api/v{version}/diagnosis/mysql/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参数 | 排序字段,参考返回结果中MysqlDatabaseSpaceModel结构字段 |
| order | string | 否 | Query参数 | 排序方式• 正序:asc• 倒序:desc |
| page | integer | 否 | Query参数 | 分页,默认是1 |
| pageSize | integer | 否 | Query参数 | 每页展示条数,默认是20 |
响应头域
无。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| items | List | 数据库空间信息列表 |
| totalCount | integer | 数据库总数 |
MysqlDatabaseSpaceModel 结构
| 字段名 | 类型 | 说明 |
|---|---|---|
| databaseName | string | 数据库名称 |
| totalSpace | integer | 数据库总空间 |
| dataSpace | integer | 数据库数据空间 |
| indexSpace | integer | 数据库索引空间 |
| freeSpace | integer | 数据库可用空间 |
| freeRate | float64 | 数据库可用空间占比(如"0.0004") |
| usageRate | float64 | 数据库已用空间占比(如"0.9996") |
| rows | integer | 数据库总行数 |
| physicalSpace | integer | 数据库物理空间 |
| tableCount | integer | 数据库表数量 |
请求示例
Plain
1GET /api/v1/diagnosis/mysql/space/database?appId=***&nodeId=***&page=1&pageSize=10&order=desc&orderBy=totalSpace 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 "databaseName": "testdb",
5 "totalSpace": 45424197632,
6 "dataSpace": 18436063232,
7 "indexSpace": 26971357184,
8 "freeSpace": 16777216,
9 "freeRate": "0.0004",
10 "usageRate": "0.9996",
11 "rows": 113272668,
12 "physicalSpace": 47001444352,
13 "tableCount": 128
14 }
15 ],
16 "totalCount": 1
17}
