1. 接口描述
接口请求域名: dbbrain.api3.fincloud.tencent.com。
获取指定时间段内的实例空间使用概览,包括磁盘增长量(MB)、磁盘剩余(MB)、磁盘总量(MB)及预计可用天数。
默认接口请求频率限制:20次/秒。
接口更新时间:2025-05-16 10:18:45。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeDBSpaceStatus |
| Version | 是 | 否 | String | 公共参数,本接口取值:2021-05-27 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceId | 是 | 否 | String | 实例 ID 。 示例值: shard-lm6o3jwi |
| RangeDays | 否 | 是 | Int64 | 时间段天数,截止日期为当日,默认为7天。 示例值: 5 |
| Product | 是 | 否 | String | 服务产品类型,支持值包括: "mariadb" - 数据库 MariaDB, "dcdb" - 数据库 TDSQL MySQL,默认为"mariadb"。 示例值: mariadb |
| ClusterId | 否 | 是 | String | 集群 ID。 示例值: tdsqlshard-70m8bedq |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Growth | Int64 | 磁盘增长量(MB)。 示例值: 231 |
| Remain | Int64 | 磁盘剩余(MB)。 示例值: 23224 |
| Total | Int64 | 磁盘总量(MB)。 示例值: 50000 |
| AvailableDays | Int64 | 预计可用天数。 示例值: 35 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | |
| InvalidParameter | |
| UnauthorizedOperation | |
| UnsupportedOperation | |
| MissingParameter | |
| AuthFailure | |
| InternalError | |
| LimitExceeded | |
| ResourceNotFound | |
| OperationDenied | |
| FailedOperation | |
| UnknownParameter | |
| OperationDenied.UserHasNoStrategy |