1. 接口描述
接口请求域名： sqlserver.tencentcloudapi.com 。
本接口(DescribeBackupMonitor)用于查询备份空间使用详情。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeBackupMonitor。 |
| Version | 是 | String | 公共参数，本接口取值：2018-03-28。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| StartTime | 是 | String | 备份空间使用详情开始时间 示例值：2022-05-05 22:12:27 |
| EndTime | 是 | String | 备份空间使用详情结束时间 示例值：2022-05-05 22:12:27 |
| Type | 否 | String | 备份趋势查询类型，local-本地备份，cross-跨地域备份 示例值：local |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TimeStamp | Array of String | 备份趋势图时间轴 示例值：[10000] |
| FreeSpace | Array of Float | 免费备份空间 示例值：[99.99] |
| ActualUsedSpace | Array of Float | 实际总备份空间 示例值：[99.99] |
| LogBackupSpace | Array of Float | 日志备份空间 示例值：[99.99] |
| DataBackupSpace | Array of Float | 数据备份空间 示例值：[99.99] |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询备份空间使用详情
输入示例
https://sqlserver.tencentcloudapi.com/?Action=DescribeBackupMonitor
&StartTime=2018-03-28 00:00:00
&EndTime=2018-04-20 00:00:00
&<公共请求参数>输出示例
{
"Response": {
"RequestId": "863b2797-858b-49f3-88e9-50159e564cbc",
"ActualUsedSpace": [
1012900,
1012900,
1013190,
1013190,
1013190,
1014280,
1014280,
1014280,
1014570,
1014570,
1015680,
1015680
],
"DataBackupSpace": [
512860,
512860,
512860,
512860,
512860,
512860,
512860,
512860,
512860,
512860,
512860,
512860
],
"FreeSpace": [
1352663040,
1352663040,
1352663040,
1352663040,
1352663040,
1352663040,
1352663040,
1352663040,
1352663040,
1352663040,
1352663040,
1352663040
],
"LogBackupSpace": [
500040,
500040,
500330,
500330,
500330,
501420,
501420,
501420,
501710,
501710,
502820,
502820
],
"TimeStamp": [
"2022-05-06 09:15:00",
"2022-05-06 09:20:00",
"2022-05-06 09:25:00",
"2022-05-06 09:30:00",
"2022-05-06 09:35:00",
"2022-05-06 09:40:00",
"2022-05-06 09:45:00",
"2022-05-06 09:50:00",
"2022-05-06 09:55:00",
"2022-05-06 10:00:00",
"2022-05-06 10:05:00",
"2022-05-06 10:10:00"
]
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation.DBError | 数据库错误。 |
| InvalidParameter.InputIllegal | 输入错误。 |
| InvalidParameterValue.IllegalRegion | 地域错误。 |
| UnauthorizedOperation.PermissionDenied | cam鉴权错误。 |
