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

查询容灾复制对

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

1. 接口描述

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

本接口用来查询容灾复制对

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeCopyPairs。
Version String 公共参数,本接口取值:2026-03-30。
Region String 公共参数,详见产品支持的 地域列表
CopyPairType String

要查询复制对的类型,可选值:DISK、INSTANCE、CFS


示例值:INSTANCE
CopyPairIds.N Array of String

要查询复制对ID列表


示例值:["copypair-xxxxxxxx"]
Filters.N Array of FilterModel

过滤条件,详见过滤条件表。支持的Name:disaster-recovery-site-pair-id、target-resource-id、source-resource-id、copy-pair-id、copy-pair-name

Offset Integer

偏移量,默认为0。关于Offset的更进一步介绍请参考 API 简介中的相关小节


示例值:0
Limit Integer

返回数量,默认为20,最大值为100。


示例值:20
Order String

输出结果按升序还是降序,可选值:ASC、DESC


示例值:DESC
OrderField String

输出结果的排序字段,可选值:CREATE_TIME


示例值:CREATE_TIME
QueryProtectionTime Boolean

是否要查询保护时间点列表,默认 false。当设置为 true 时,必须同时传入 CopyPairIds 参数。


示例值:false
GetAllCopyPair Boolean

是否查询跨云+非跨云全部复制对,默认 false


示例值:false
QueryCvmCreateParams Boolean

是否要查询 CVM 创建参数(仅对延迟创建模式且目标 CVM 未创建的复制对生效),默认为true。为 true 时,每条 deferred_create=1 AND target_cvm_created=0 的 CVM 复制对出参会附带 CvmCreateParams 字段


示例值:false
CreateFrom String

复制对创建来源过滤。不传则查询所有;传 LOCAL 仅查本端创建的复制对,传 PEER 仅查对端创建的复制对。

枚举值:

  • LOCAL: 仅查本端创建的复制对
  • PEER: 仅查对端创建的复制对

示例值:LOCAL

3. 输出参数

参数名称 类型 描述
TotalCount Integer

符合条件的复制对总数


示例值:1
CopyPairSet Array of CopyPair

复制对列表。

RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询复制对

输入示例

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

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

输出示例

{
    "Response": {
        "CopyPairSet": [
            {
                "AccountUin": "700002579593",
                "AppId": 260132668,
                "CopyPairId": "cvmcopypair-ibd2jvbj",
                "CopyPairName": "t5-0",
                "CopyPairState": "INIT",
                "CopyPairType": "INSTANCE",
                "CreateFrom": "LOCAL",
                "CreateTime": "2026-06-09 12:00:16",
                "DataDirection": "POSITIVE",
                "DeferredCreate": true,
                "DisasterRecoveryType": "CROSS_ZONE",
                "DiskCopyPairSet": [
                    {
                        "CopyPairId": "copypair-9wgl3suj",
                        "CopyPairName": "t5-0-0",
                        "CreateTime": "2026-06-09 12:00:16",
                        "SourceResourceId": "disk-a8ys45xk",
                        "TargetResourceId": ""
                    }
                ],
                "DrillGroupId": null,
                "InstanceCopyPairId": "cvmcopypair-ibd2jvbj",
                "InstanceId": "ins-ggpv137w",
                "LatestProtectionTime": null,
                "PeerCloudName": null,
                "Percent": null,
                "ProtectGroupId": "pg-awh08zgp",
                "ProtectGroupName": "pg5-new",
                "ProtectionTimeSet": null,
                "RecoveryPointObjective": 15,
                "RollbackPercent": 0,
                "Rollbacking": 0,
                "SitePairId": "sitepair-0wxbktxr",
                "SitePairName": "scenario-lifecycle-test-sitepair",
                "SourceRegion": "ap-guangzhou",
                "SourceResourceId": "ins-ggpv137w",
                "SourceVpc": "vpc-i9pwklpn",
                "SourceZone": "ap-guangzhou-2",
                "SubAccountUin": "700002579593",
                "TargetCvmCreated": false,
                "TargetRegion": "ap-guangzhou",
                "TargetResourceId": "drp-17ixt9oj",
                "TargetVpc": "vpc-ap4fkwyt",
                "TargetZone": "ap-guangzhou-3"
            }
        ],
        "TotalCount": 5,
        "RequestId": "58fa46d6-954d-45dd-a2ee-4422e77d5c34"
    }
}

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 参数不合法
InvalidParameterValue.LimitExceeded 不合法的参数值,超过限制
MissingParameter.MissingRequired 必填参数缺失
UnauthorizedOperation.HasNoStrategy 未授权操作
UnauthorizedOperation.MFAExpired MFA认证过期