帮你快速理解、总结文档立即下载

查询容灾保护组

最近更新时间:2026-08-24 21:39:23
我的收藏

1. 接口描述

接口请求域名: bdrc.tencentcloudapi.com 。

本接口用来查询容灾保护组

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeDisasterRecoveryProtectGroups。
Version String 公共参数,本接口取值:2026-03-30。
Region String 公共参数,详见产品支持的 地域列表
ProtectGroupType String 要查询的容灾保护组产品类型,枚举值:DISK / INSTANCE / CFS。
示例值:INSTANCE
ProtectGroupIds.N Array of String 要查询的容灾保护组ID列表。
示例值:["pg-xxxxxxxx"]
Filters.N Array of FilterModel 过滤条件(过滤项由 core handler 定义,如 disaster-recovery-protect-group-id 等)。
Offset Integer 偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节。
示例值:0
Limit Integer 返回数量,默认为20,最大值为100。关于Limit的更进一步介绍请参考 API 简介中的相关小节。
示例值:20
Order String 输出结果按升序还是降序
示例值:DESC
OrderField String 输出结果的排序字段
示例值:CREATE_TIME

3. 输出参数

参数名称 类型 描述
TotalCount Integer 符合条件的容灾保护组总数
示例值:1
ProtectGroupSet Array of ProtectGroup 容灾保护组列表
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询保护组

输入示例

POST / HTTP/1.1
Host: bdrc.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeDisasterRecoveryProtectGroups
<公共请求参数>

{
    "ProtectGroupType": "INSTANCE",
    "Limit": 1
}

输出示例

{
    "Response": {
        "ProtectGroupSet": [
            {
                "AccountUin": "700002579593",
                "AppId": 260132668,
                "BindProtectedResourceCount": 1,
                "CopyType": "ASY",
                "CreateFrom": "LOCAL",
                "CreateTime": "2026-06-09 11:25:39",
                "DataDirection": "POSITIVE",
                "DisasterRecoveryType": "CROSS_ZONE",
                "ErrorRecoveryPointObjectiveCount": 0,
                "LifeState": "NORMAL",
                "ModifyTime": "2026-06-09 11:25:39",
                "ProtectGroupId": "pg-awh08zgp",
                "ProtectGroupName": "pg5-new",
                "ProtectGroupType": "INSTANCE",
                "ProtectedResourceStatusSet": [
                    {
                        "Count": 1,
                        "Status": "INIT"
                    }
                ],
                "RecoveryPointObjective": 15,
                "SitePairId": "sitepair-0wxbktxr",
                "SitePairName": "scenario-lifecycle-test-sitepair",
                "SourceRegion": "ap-guangzhou",
                "SourceVpc": "vpc-i9pwklpn",
                "SourceZone": "ap-guangzhou-2",
                "SubAccountUin": "700002579593",
                "TargetRegion": "ap-guangzhou",
                "TargetVpc": "vpc-ap4fkwyt",
                "TargetZone": "ap-guangzhou-3"
            }
        ],
        "TotalCount": 294,
        "RequestId": "3e397705-f35f-4cdd-83f5-e02ba22aa567"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
InternalError 内部错误。
InvalidFilter 无效的过滤器
InvalidParameter.Invalid 参数不合法
InvalidParameter.InvalidValue 参数错误
MissingParameter.MissingRequired 必填参数缺失
UnauthorizedOperation.HasNoStrategy 未授权操作
UnauthorizedOperation.MFAExpired MFA认证过期