1. 接口描述
接口请求域名： bdrc.tencentcloudapi.com 。
查询容灾资源概览
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：DescribeDisasterRecoveryOverview。 |
| Version | 是 | String | 公共参数，本接口取值：2026-03-30。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| CopyPairType | 否 | String | 要查询的产品/复制对的类型，枚举值：• DISK：云硬盘类型复制对• INSTANCE：CVM 实例复制对• CFS：文件存储复制对• ALL：聚合当前支持的类型；默认为CFS 示例值：INSTANCE |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DisasterRecoveryOverview | DisasterRecoveryOverview | 跨所有地域聚合后的容灾总览数据 |
| OverviewInRegionSet | Array of DisasterRecoveryOverview | 按地域拆分的容灾总览列表 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 查询当前容灾概览
输入示例
POST / HTTP/1.1
Host: bdrc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDisasterRecoveryOverview
<公共请求参数>
{
"CopyPairType": "ALL"
}输出示例
{
"Response": {
"DisasterRecoveryOverview": {
"CopyPairCount": 5,
"CopyPairErrorRPOCount": 2,
"CopyPairSuccessRPOCount": 3,
"DrillPairCount": 2,
"DrillPairDrillingCount": 0,
"DrillPairFailedCount": 0,
"DrillPairSuccessCount": 2,
"FailoverFailedCount": 0,
"ProtectGroupCount": 296,
"ProtectGroupCrossCloudCount": 0,
"ProtectGroupCrossRegionCount": 0,
"ProtectGroupCrossZoneCount": 296,
"ProtectedResourceCopyingCount": 2,
"ProtectedResourceCount": 5,
"ProtectedResourceStoppedCount": 3,
"SitePairCount": 2,
"SitePairCrossCloudCount": 0,
"SitePairCrossRegionCount": 0,
"SitePairCrossZoneCount": 2
},
"OverviewInRegionSet": [
{
"CopyPairCount": 5,
"CopyPairErrorRPOCount": 2,
"CopyPairSuccessRPOCount": 3,
"DrillPairCount": 2,
"DrillPairDrillingCount": 0,
"DrillPairFailedCount": 0,
"DrillPairSuccessCount": 2,
"FailoverFailedCount": 0,
"ProtectGroupCount": 296,
"ProtectGroupCrossCloudCount": 0,
"ProtectGroupCrossRegionCount": 0,
"ProtectGroupCrossZoneCount": 296,
"ProtectedResourceCopyingCount": 2,
"ProtectedResourceCount": 5,
"ProtectedResourceStoppedCount": 3,
"Region": "ap-guangzhou",
"SitePairCount": 2,
"SitePairCrossCloudCount": 0,
"SitePairCrossRegionCount": 0,
"SitePairCrossZoneCount": 2
}
],
"RequestId": "9fd291d3-19d9-4214-b53f-10f438959210"
}
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.ComponentError | 第三方组件错误 |
| InvalidFilter | 无效的过滤器 |
| InvalidParameter.Invalid | 参数不合法 |
| InvalidParameter.InvalidFilter | 过滤参数非法 |
| InvalidParameter.InvalidValue | 参数错误 |
| MissingParameter.MissingRequired | 必填参数缺失 |
| UnauthorizedOperation.HasNoStrategy | 未授权操作 |