接口功能介绍
查询RDS实例空间使用信息。
接口约束
无
URI
GET /v1/open-api/instance/usage-information
路径参数
无
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
outerProdInstId | 是 | String | 实例ID |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
statusCode | 是 | Integer | 返回码取值范围:0 成功 | 0 | |
message | 是 | String | 返回消息 | ||
returnObj | 是 | Object | 返回对象 | returnObj |
表 returnObj
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
totalSize | 是 | String | 磁盘大小单位G | ||
usedSize | 是 | String | 磁盘使用大小单位G | ||
availSize | 是 | String | 磁盘可用大小 | ||
diskUsedRated | 是 | Integer | 磁盘空间使用率% | ||
backupDiskSize | 是 | Integer | 备份磁盘大小 单位G | ||
backupUsedDiskSize | 是 | Integer | 备份磁盘使用大小 | ||
backupDiskUsedRated | 是 | Integer | 备份空间使用率% | ||
backupStoreType | 是 | Integer | 备份类型0: 没有设置备份1: 主机挂盘备份 2: 对象存储(不展示备份空间信息)3: 只读实例(不展示备份空间信息) | ||
machineId | 是 | Integer | 机器ID | ||
prodInstId | 是 | Integer | 内部实例ID |
请求示例
请求头header
无
请求体body
无
响应示例
{
"statusCode": 0,
"message": "success",
"returnObj": {
"machineId": 1,
"totalSize": "100",
"backupDiskUsedRated": 5,
"usedSize": "1",
"backupUsedDiskSize": 1,
"prodInstId": 3,
"availSize": "99",
"backupDiskSize": 20,
"backupStoreType": 1,
"diskUsedRated": 99
}
}
状态码
状态码 | 描述 |
---|---|
0 | 请求响应成功 |
错误码
错误码 | 描述 |
---|---|
2001 | 参数异常,失败原因见message |
3001 | 业务异常,失败原因见message |
5001 | 请求响应失败,失败原因见message |