1. 接口描述
接口请求域名: cdb.tencentcloudapi.com 。
本接口(DescribeBinlogBackupOverview)用于查询用户在当前地域总的日志备份概览。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeBinlogBackupOverview。 |
Version | 是 | String | 公共参数,本接口取值:2017-03-20。 |
Region | 是 | String | 公共参数,详见产品支持的 地域列表。 |
Product | 是 | String | 需要查询的云数据库产品类型,目前仅支持 "mysql"。 示例值:mysql |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
BinlogBackupVolume | Integer | 总的日志备份容量,包含异地日志备份(单位为字节)。 示例值:6000 |
BinlogBackupCount | Integer | 总的日志备份个数,包含异地日志备份。 示例值:15 |
RemoteBinlogVolume | Integer | 异地日志备份容量(单位为字节)。 示例值:6000 |
RemoteBinlogCount | Integer | 异地日志备份个数。 示例值:1 |
BinlogArchiveVolume | Integer | 归档日志备份容量(单位为字节)。 示例值:1 |
BinlogArchiveCount | Integer | 归档日志备份个数。 示例值:1 |
BinlogStandbyVolume | Integer | 标准存储日志备份容量(单位为字节)。 示例值:1 |
BinlogStandbyCount | Integer | 标准存储日志备份个数。 示例值:1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 DescribeBinlogBackupOverview
输入示例
POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBinlogBackupOverview
<公共请求参数>
{
"Product": "mysql"
}
输出示例
{
"Response": {
"BinlogBackupCount": 15,
"BinlogBackupVolume": 6000,
"RemoteBinlogCount": 5,
"RemoteBinlogVolume": 2000,
"BinlogArchiveCount": 5,
"BinlogArchiveVolume": 2000,
"BinlogStandbyCount": 5,
"BinlogStandbyVolume": 2000,
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}
}
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.SubAccountDenied | 子账号无权限。 |
InternalError.CdbError | 系统错误。 |
InvalidParameter.ControllerNotFoundError | 未找到该接口。 |
InvalidParameterValue.InvalidParameterValueError | 参数值无效。 |
OperationDenied.SubAccountOperationDenied | 腾讯云子账号权限不足,不允许执行当前操作。 |