Only the Chinese version of this page is provided currently. The English version will be provided soon.
Help & Documentation>灾备中心>API 文档>数据结构

数据结构

Last updated: 2026-08-24 21:39:46

On this page:

AdvancedRetentionPolicy

备份高级保留策略

被如下接口引用：CreateAutoBackupPolicy, DescribeAutoBackupPolicies, ModifyAutoBackupPolicyAttribute。

名称 类型 必选 描述
Days Integer 是 保留设定天数中的每天最新的一个备份
示例值：4
Weeks Integer 是 保留设置周中的每周最新的一个备份
示例值：2
Months Integer 是 保留设置月内的每月最新的一个备份
示例值：9
Years Integer 是 保留设置年内的每年最新的一个备份
示例值：1

ApplyDisk

备份组备份和云盘绑定信息

被如下接口引用：ApplyBackupGroup, DescribeBackupGroups, DescribeCommonBackupPoints。

名称 类型 必选 描述
BackupId String 否 备份ID
示例值：backup-cdsadf12
DiskId String 否 云盘ID
示例值：disk-dare87sw

AspInfo

备份的执行策略信息

被如下接口引用：DescribeFileBackupPlans。

名称 类型 描述
AspId String 备份策略ID
示例值：asp-91kjuank
AspName String 备份策略名称
示例值：backup-policy
AspState String 备份策略状态
示例值：NORMAL
Policy Array of Policy 备份策略执行详情
IsActivated Boolean 备份策略是否使能
示例值：true
IsPermanent Boolean 是否永久保留
示例值：true
RetentionDays Integer 保留时间
注意：此字段可能返回 null，表示取不到有效值。
示例值：30
CreateTime String 创建时间
示例值：2026-01-01T00:00:00

AutoBackupPolicy

定期备份策略的详细信息

被如下接口引用：DescribeAutoBackupPolicies。

名称 类型 描述
IsActivated Boolean 定期备份策略是否激活。
示例值：true
IsPermanent Boolean 使用该定期备份策略创建出来的备份是否永久保留。
注意：此字段可能返回 null，表示取不到有效值。
示例值：false
NextTriggerTime Timestamp ISO8601 使用该定期备份策略创建出来的备份是否永久保留。
示例值：2026-03-27T13:04:45+08:00
AutoBackupPolicyState String NORMAL
示例值：定期备份策略的状态。取值范围：
<li>NORMAL：正常
<li>ISOLATED：已隔离。
AutoBackupPolicyName String 备份策略的名称。
示例值：备份策略1
Policy Array of Policy 定期备份的执行策略。
AutoBackupPolicyId String 备份策略ID。
示例值：abp-4od7o75f
CreateTime Timestamp ISO8601 备份策略的创建时间。
示例值：2026-02-27T13:04:45+08:00
RetentionDays Integer 使用该定期备份策略创建出来的备份保留天数。
示例值：3
AppId Integer 用户AppId。
示例值：1255000110
InstanceIdSet Array of String 定期备份策略绑定的实例ID列表。
示例值：["ins-2kpmcdl4"]
RetentionMonths Integer 该定期快照创建的快照最大保留月数
示例值：3
RetentionAmount Integer 该定期快照创建的快照最大保留数量
示例值：3
AccountName String 创建人。
注意：此字段可能返回 null，表示取不到有效值。
示例值：admin
AccountUin String 主账号uin。
注意：此字段可能返回 null，表示取不到有效值。
示例值："110000000197"
SubAccountUin String 子账号uin。
注意：此字段可能返回 null，表示取不到有效值。
示例值："110000000197"
StorageType String 策略存储类型
示例值：COMMON
VaultId String 备份库ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：vault-qjhn63ku
AdvancedRetentionPolicy AdvancedRetentionPolicy 高级保留策略

AutomationServiceEnabled

描述了 “tat-agent” 相关的信息

被如下接口引用：CreateInstanceCopyPair, CreateInstanceDrillPairs。

名称 类型 必选 描述
Enabled Boolean 否 是否开启该服务。取值范围：TRUE（开启）/FALSE（不开启）。默认取值：TRUE。
示例值：true

BackupDeniedAction

单个备份的操作掩码。

被如下接口引用：DescribeFileBackupsDeniedActions。

名称 类型 描述
BackupId String 备份ID。
示例值：backup-iqihe78f
DeniedActions Array of DeniedAction 具体的备份操作掩码列表。

BackupDetail

备份详情

被如下接口引用：DescribeCommonBackupPoints。

名称 类型 描述
BackupId String 备份组ID
示例值：cbackup-n4cbfo8f
InstanceId String 实例ID
示例值：ins-ozr2fn7w
CreateTime Timestamp ISO8601 创建时间
示例值：2026-03-27T13:04:45+08:00
AutoBackupPolicyId String 备份策略ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：abp-5c5l02gj
BackupBindDisk Array of ApplyDisk 备份和云盘绑定关系
注意：此字段可能返回 null，表示取不到有效值。

BackupGroup

备份组详情

被如下接口引用：DescribeBackupGroups。

名称 类型 描述
BackupGroupId String 备份组ID。
示例值：cbackup-n00m2307
Percent Integer 备份组创建进度。
注意：此字段可能返回 null，表示取不到有效值。
示例值：30
BackupBindDisk Array of ApplyDisk 备份和云盘绑定关系
注意：此字段可能返回 null，表示取不到有效值。
BackupGroupName String 备份组名称。
示例值：backup-group
BackupGroupState String 备份组状态。NORMAL: 正常；CREATING: 创建中；ROLLBACKING: 回滚中
示例值：NORMAL
ModifyTime Timestamp ISO8601 修改时间
示例值：2026-03-27T13:04:45+08:00
CreateTime Timestamp ISO8601 创建时间
示例值：2026-03-27T13:04:35+08:00
AppId Integer 用户AppId。
示例值：260094408
IsPermanent Boolean 是否为永久备份组。
示例值：false
DeadlineTime Timestamp ISO8601 备份组的到期时间。如果为永久备份组，则取值为null。
注意：此字段可能返回 null，表示取不到有效值。
示例值：2026-04-27T13:04:35+08:00
InstanceId String 创建备份组的实例ID。
注意：此字段可能返回 null，表示取不到有效值。
示例值：ins-jul9m59o
InstanceDetails String 创建备份组时刻实例的详情。
注意：此字段可能返回 null，表示取不到有效值。
示例值：detail
AccountName String 创建人名称。
注意：此字段可能返回 null，表示取不到有效值。
示例值：admin
AccountUin String 主账号uin。
注意：此字段可能返回 null，表示取不到有效值。
示例值："110000000197"
SubAccountUin String 创建备份的子账号uin。
注意：此字段可能返回 null，表示取不到有效值。
示例值："110000000197"
AutoBackupPolicyId String 创建当前备份的定期备份策略ID，为null则为手动创建的备份。
注意：此字段可能返回 null，表示取不到有效值。
示例值：abp-4od7o75f

BackupGroupDeniedAction

备份组的操作掩码

被如下接口引用：DescribeBackupGroupsDeniedActions。

名称 类型 描述
BackupGroupId String 备份组ID
示例值：cbackup-bpphx8cj
DeniedActions Array of DeniedAction 拒绝的操作

BackupGroupRollbackTask

备份组回滚任务

被如下接口引用：DescribeBackupGroupRollbackTasks。

名称 类型 描述
TaskId String 备份组回滚任务
示例值：crollback-efad98dd
SourceInstanceId String 源实例ID
示例值：ins-n8y58xoo
TargetInstanceId String 目标实例ID
示例值：ins-n8y58xoo
BackupGroupId String 备份组ID
示例值：cbackup-5gghmy6f
RollbackType String 恢复类型：ORIGINAL-原实例恢复，NEW-新实例恢复
示例值：ORIGINAL
Status String 任务状态。取值包括"init"、"migrating"、"done"、"failed"。
示例值：done
Percent Integer 进度
注意：此字段可能返回 null，表示取不到有效值。
示例值：100
StartTime Timestamp ISO8601 开始时间
注意：此字段可能返回 null，表示取不到有效值。
示例值：2026-03-27T13:04:45+08:00
EndTime Timestamp ISO8601 结束时间
注意：此字段可能返回 null，表示取不到有效值。
示例值：2026-03-27T13:04:59+08:00
AppId Integer APP ID
示例值：1255000110
BackupGroupName String 备份点名称
示例值：backup-0421
FailReason String 恢复失败原因
示例值："disk rollback failed"

BackupInfo

备份点信息

被如下接口引用：DescribeFileBackups。

名称 类型 描述
BackupId String 备份点ID
示例值：fb-i9j0k1l2
BackupName String 备份名称
示例值：file-admin
PlanId String 所属计划ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：fbp-x1y2z3w4
AspInstanceId String 策略ID
示例值：asp-m1n2o3p4
ResourceId String 资源ID
示例值：ins-abc12345
Status Integer 备份状态，取值如下：
0 备份完成
1 创建中（备份进行中）
2 部分成功（指定的备份路径中部分目录不存在）
3 恢复中（该备份点正在被恢复任务使用）
92 已取消
98 创建失败
99 已删除
100 删除中

示例值：1
BackupPaths Array of String 备份路径
示例值：["/"]
IncludeFileTypes Array of String 包含文件类型
注意：此字段可能返回 null，表示取不到有效值。
示例值：[".log"]
ExcludePatterns Array of String 排除路径
注意：此字段可能返回 null，表示取不到有效值。
示例值：["/sys"]
ExcludeSystemDirectories Boolean 是否排除系统目录
示例值：true
VaultId String 备份库ID
示例值：vault-qjhn63ku
ScannedFileCount Integer 扫描文件数
示例值：15000
ScannedSize Integer 扫描大小(字节)
示例值：5368709120
ScannedSizeFormatted String 扫描大小(格式化)
示例值："5.00 GB"
BackupFileCount Integer 已备份文件数量
示例值：14800
BackupSize Integer 已备份大小(字节)
示例值：2147483648
BackupSizeFormatted String 已备份大小(格式化)
示例值："2.00 GB"
Progress Float 备份进度(0-100)
示例值：100
JobId String 任务ID
示例值："job-e5f6g7h8"
StartTime String 开始时间
示例值：2026-03-30T02:00:00
EndTime String 结束时间
示例值：2026-03-30T02:35:00
CreatedTime String 创建时间
示例值：2026-03-30T02:00:00
IsPermanent Boolean 是否为永久保留
示例值：true
Deadline String 到期时间
示例值：2026-12-01 00:00:00
NonExistSourcePaths Array of String 不存在的路径信息
注意：此字段可能返回 null，表示取不到有效值。
示例值：["/data1"]
FailReason String 备份失败原因
示例值：Fatal: nothing to backup, please specify source files/dirs
AppId Integer 备份所属AppId
示例值：260095320
ResourceType String 备份类型
示例值：cvm_agent

BackupInstance

描述实例的备份信息

被如下接口引用：DescribeBackupInstances。

名称 类型 描述
AutoBackupPolicyIdSet Array of String 实例绑定的定期备份策略列表。
示例值：["abp-4od7o75f"]
InstanceId String 实例ID。
示例值：ins-2kpmcdl4
AppId Integer 用户AppId。
示例值：1255000110
LatestBackupTime Timestamp ISO8601 实例最新备份时间。
注意：此字段可能返回 null，表示取不到有效值。
示例值：2026-03-31T12:18:11+08:00
BackupGroupIdSet Array of String 实例的备份组ID列表。
示例值：["cbackup-n00m2307"]
ModifyTime Timestamp ISO8601 修改时间。
注意：此字段可能返回 null，表示取不到有效值。
示例值：2026-03-26T22:19:45+08:00
CreateTime Timestamp ISO8601 创建时间
示例值：2026-03-26T22:19:45+08:00
InstanceName String 实例名称
示例值：admin-cvm

BackupPlan

整机备份计划

被如下接口引用：DescribeBackupPlans。

名称 类型 描述
InstanceId String 实例ID
示例值：ins-n8y58xoo
AutoBackupPolicyId String 备份策略ID
示例值：abp-k5u812zh
ModifyTime Timestamp ISO8601 修改时间
示例值：2026-03-27T13:04:45+08:00
CreateTime Timestamp ISO8601 创建时间
示例值：2026-03-27T13:04:45+08:00
AppId Integer APP ID
示例值：1255000110
BackupCount Integer 备份数量
示例值：10
LastTriggerTime String 上次执行时间
注意：此字段可能返回 null，表示取不到有效值。
示例值：2026-03-27T13:04:45+08:00
LastTriggerError String 上次执行错误信息，如果为空表示上次执行成功。
注意：此字段可能返回 null，表示取不到有效值。
示例值：网络问题

BackupPolicyOverview

备份策略概览

被如下接口引用：DescribeBackupOverviewGeneral。

名称 类型 描述
TotalCount Integer 自动备份策略总数
示例值：1
BoundCount Integer 已绑定资源的策略数
示例值：5
UnboundCount Integer 未绑定任何资源的策略数
示例值：3

BackupVault

备份库信息

被如下接口引用：DescribeBackupVaults。

名称 类型 描述
VaultId String 备份库ID
示例值：vault-19siqkdk
VaultName String 备份库名称
示例值：brc-vault
Description String 备份库描述
注意：此字段可能返回 null，表示取不到有效值。
示例值：vault for brc
Status String 备份库状态：READ_WRITE / READ_ONLY / UNAVAILABLE / DELETING
示例值：READ_WRITE
EncryptType String 加密方式：NONE / SSE-COS / SSE-KMS
注意：此字段可能返回 null，表示取不到有效值。
示例值：NONE
KmsKeyId String KMS密钥ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：agagaiqjrfkal
VaultType String 备份库类型：COMMON
示例值：COMMON
BackupPolicySet Array of TypeCount 关联的备份策略按类型统计
BackupSet Array of TypeCount 备份点按类型统计（不含已删除）
Region String 地域信息
示例值：ap-region1
CreateTime String 创建时间
示例值：2026-10-01 09:00:00
SourceDataSize Integer 源端数据量
示例值：24185191
VaultDataSize Integer 存储库数据量
示例值：9195185

BackupVaultOverview

备份库概览

被如下接口引用：DescribeBackupOverviewGeneral。

名称 类型 描述
TotalCount Integer 备份库总数
示例值：1
TotalSizeMb Integer 备份库总存储量（已用容量），单位 MB
示例值：515

BasicServicesSettings

描述了 “基础” 服务相关的信息

被如下接口引用：CreateInstanceCopyPair, CreateInstanceDrillPairs。

名称 类型 必选 描述
Enabled Boolean 否 是否开启基础服务。取值范围：TRUE（开启）/FALSE（不开启）。默认取值：TRUE。
示例值：true

CommonBackupPoint

共同备份点信息

被如下接口引用：DescribeCommonBackupPoints。

名称 类型 描述
BackupCommonTime Timestamp ISO8601 共同时间点（精确到小时）
示例值：2026-03-27T13:00:00+08:00
BackupDetailSet Array of BackupDetail 共同备份点信息

CopyPair

复制对信息

被如下接口引用：DescribeCopyPairs。

名称 类型 描述
AppId Integer 用户ID
示例值：260110691
CopyPairId String 复制对ID（CVM 类型为 cvmcopypair-xxxxxxxx，DISK/CFS 类型为 copypair-xxxxxxxx）
示例值：cvmcopypair-hd2bhdxd
CopyPairName String 复制对名称
示例值：test-copy-pair
SitePairId String 所属容灾站点对ID
示例值：drsp-xxxxxxxx
SitePairName String 所属容灾站点对名称
示例值：test-site-pair
ProtectGroupId String 保护组ID
示例值：drpg-xxxxxxxx
ProtectGroupName String 保护组名称
示例值：test-protect-group
CopyPairState String 复制对状态。可选值：INIT、RUNNING、FULL_COPYING、INC_COPYING、NORMAL、DOWN、DEGRADE 等
示例值：INC_COPYING
CopyPairType String 复制对类型。可选值：DISK、INSTANCE、CFS
示例值：INSTANCE
SourceRegion String 生产地域
示例值：ap-guangzhou
SourceZone String 生产可用区
示例值：ap-guangzhou-3
SourceVpc String 生产端VPC
示例值：vpc-xxxxxxxx
TargetRegion String 容灾地域
示例值：ap-shanghai
TargetZone String 容灾可用区
示例值：ap-shanghai-2
TargetVpc String 容灾端VPC
示例值：vpc-yyyyyyyy
SourceResourceId String 生产资源ID。CVM 类型为源 InstanceId（ins-xxx）；DISK 类型为源 DiskId（disk-xxx）；CFS 类型为源 FilesystemId（cfs-xxx）
示例值：ins-xxxxxxxx
TargetResourceId String 容灾资源ID。语义同 SourceResourceId（CVM/DISK/CFS）。延迟创建模式且 CVM 未真实创建时为占位符 drp-xxx，CVM 创建后为真实 ins-xxx
注意：此字段可能返回 null，表示取不到有效值。
示例值：ins-yyyyyyyy
InstanceId String 生产站点盘挂载的实例ID（DISK 类型时为挂载的 CVM ins-xxx；INSTANCE 类型时与 SourceResourceId 一致）
注意：此字段可能返回 null，表示取不到有效值。
示例值：ins-xxxxxxxx
InstanceCopyPairId String 所属CVM复制对ID（仅 DISK 类型且其 CVM 复制对存在时返回）
注意：此字段可能返回 null，表示取不到有效值。
示例值：cvmcopypair-hd2bhdxd
Percent Integer 复制进度。CVM 类型为所有挂载磁盘进度的平均值；DISK/CFS 类型为本盘进度
注意：此字段可能返回 null，表示取不到有效值。
示例值：70
LatestProtectionTime String 最新保护时间点。当 CopyPairState=FULL_COPYING 时为 null（首次全量未完成）
注意：此字段可能返回 null，表示取不到有效值。
示例值：2026-04-29 21:30:06
RecoveryPointObjective Integer RPO（秒）
注意：此字段可能返回 null，表示取不到有效值。
示例值：300
DataDirection String 数据方向。可选值：POSITIVE（正向）、REVERSE（反向，failover 后）。后端在 REVERSE 时已自动轮转 src/target 字段
示例值：POSITIVE
CreateFrom String 创建来源。可选值：LOCAL（本地侧创建）、PEER（对端创建）
示例值：LOCAL
DisasterRecoveryType String 容灾类型。可选值：CROSS_ZONE（跨可用区）、CROSS_REGION（跨地域）、CROSS_CLOUD（跨云）
示例值：CROSS_REGION
PeerCloudName String 对端云名称（仅跨云场景）
注意：此字段可能返回 null，表示取不到有效值。
示例值：MOCK_CLOUD
Rollbacking Integer 是否在回滚中（0/1）
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
RollbackPercent Integer 回滚进度
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
CreateTime String 创建时间
示例值：2026-04-29 20:42:18
AccountUin String 创建账户 Uin
注意：此字段可能返回 null，表示取不到有效值。
示例值：1000000001
SubAccountUin String 创建协作者 Uin
注意：此字段可能返回 null，表示取不到有效值。
示例值：1000000002
DrillGroupId String 演练组ID（用于演练组内过滤存量复制对，无演练时为 null）
注意：此字段可能返回 null，表示取不到有效值。
示例值：drillg-xxxxxxxx
ProtectionTimeSet Array of String 保护时间点列表（仅当 QueryProtectionTime=true 时返回）
注意：此字段可能返回 null，表示取不到有效值。
示例值：["2026-04-29 21:30:06"]
DiskCopyPairSet Array of DiskCopyPairForCvm CVM下挂载磁盘的复制对列表（仅 CopyPairType=INSTANCE 时返回）
注意：此字段可能返回 null，表示取不到有效值。
DeferredCreate Boolean 是否为延迟创建模式（创建后固定不变）。仅 CVM 复制对返回
示例值：false
TargetCvmCreated Boolean 目标 CVM 是否已真实创建（首次 failover 完成后置 true）。仅 CVM 复制对返回
示例值：true
CvmCreateParams String CVM 创建参数（JSON 字符串）。仅当请求传 QueryCvmCreateParams=true 且复制对处于 deferred_create=1 AND target_cvm_created=0 时返回
注意：此字段可能返回 null，表示取不到有效值。
示例值：{create}

CopyPairDeniedAction

复制对操作掩码

被如下接口引用：DescribeCopyPairsDeniedActions。

名称 类型 描述
CopyPairId String 复制对ID
示例值：cp-xxxxxxxx
DeniedActions Array of DeniedAction 被禁止的操作列表（Action名称数组）

CopyPairPrice

复制对价格信息

被如下接口引用：DescribePriceCreateCopyPairs。

名称 类型 描述
UnitPrice Float 后付费每小时原价，单位：元
注意：此字段可能返回 null，表示取不到有效值。
示例值：0.225
UnitPriceHigh String 高精度后付费每小时原价，单位：元（字符串形式，避免精度丢失）
注意：此字段可能返回 null，表示取不到有效值。
示例值：0.225
UnitPriceDiscount Float 后付费每小时折扣价，单位：元
注意：此字段可能返回 null，表示取不到有效值。
示例值：0.225
UnitPriceDiscountHigh String 高精度后付费每小时折扣价，单位：元（字符串形式，避免精度丢失）
注意：此字段可能返回 null，表示取不到有效值。
示例值：0.225
Discount Integer 折扣，100 表示无折扣，80 表示 8 折
注意：此字段可能返回 null，表示取不到有效值。
示例值：100
ChargeUnit String 计价单元，固定为 HOUR（按小时计费）
注意：此字段可能返回 null，表示取不到有效值。
示例值：HOUR
DetailPrices Array of CopyPairPriceDetail 计费项目明细列表
注意：此字段可能返回 null，表示取不到有效值。

CopyPairPriceDetail

复制对价格明细项

被如下接口引用：DescribePriceCreateCopyPairs。

名称 类型 描述
PriceName String 计费项目标识名称。取值：InstanceCount（容灾CVM实例数）、InstanceDataCapacity（容灾CVM实例数据量）
注意：此字段可能返回 null，表示取不到有效值。
示例值：InstanceCount
PriceTitle String 计费项目展示名称（跟随语言环境翻译）
注意：此字段可能返回 null，表示取不到有效值。
示例值：容灾CVM实例数
UnitPrice Float 该计费项每小时原价，单位：元
注意：此字段可能返回 null，表示取不到有效值。
示例值：0.2
UnitPriceDiscount Float 该计费项每小时折扣价，单位：元
注意：此字段可能返回 null，表示取不到有效值。
示例值：0.2
Discount Integer 该计费项的折扣，100 表示无折扣
注意：此字段可能返回 null，表示取不到有效值。
示例值：100
ChargeUnit String 计价单元，固定为 HOUR
示例值：HOUR

CreateInstanceModel

创建cvm参数

被如下接口引用：CreateInstanceCopyPair, CreateInstanceDrillPairs。

名称 类型 必选 描述
SourceInstanceId String 是 源CVM ID
示例值：ins-eej84hs4
InstanceChargeType String 是 实例计费模式
示例值：POSTPAID_BY_HOUR
Placement Placement 是 实例所在的位置。通过该参数可以指定实例所属可用区，所属项目等属性。
ImageId String 是 镜像ID
示例值：img-eej84hs4
SystemDisk DiskModel 是 指定系统盘规格
InstanceChargePrepaid InstanceChargePrepaid 否 预付费模式，即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。若指定实例的付费模式为预付费则该参数必传。
InstanceType String 否 实例类型
示例值：S5.MEDIUM4
DataDisks Array of DiskModel 否 指定数据盘规格列表
VirtualPrivateCloud VirtualPrivateCloud 否 私有网络相关信息配置
InternetAccessible InternetAccessible 否 公网带宽相关信息设置
InstanceName String 否 实例显示名称。不传则新实例名为"未命名"。最大长度不能超60个字节。
示例值：my-instance
LoginSettings LoginSettings 否 实例登录设置
EnhancedService EnhancedService 否 增强服务配置
SpotPrice String 否 竞价实例最高出价
示例值：0.5
HostName String 否 实例主机名
示例值：host-abc
UserData String 否 提供给实例使用的用户数据
示例值：IyEvYmluL2Jhc2g=
DisasterRecoverGroupIds Array of String 否 放置群组ID
示例值：["drg-eej84hs4"]
StoppedMode String 否 关机计费模式，默认关机收费（KEEP_CHARGING / STOP_CHARGING），仅 CreateInstanceCopyPair 场景生效
示例值：KEEP_CHARGING
CopyPairId String 否 容灾演练使用的复制对ID，仅 CreateInstanceDrillPairs 场景生效
示例值：cvmcopypair-2zjmpdlb
RecoveryTime String 否 容灾演练的恢复时间点，仅 CreateInstanceDrillPairs 场景生效
示例值：2026-03-31 08:00:00

CrossCloudDetails

跨云信息

被如下接口引用：DescribeDisasterRecoverySitePairs。

名称 类型 描述
SourceCloudName String 源端云名称（跨云对端云名称）
注意：此字段可能返回 null，表示取不到有效值。
示例值：aws
TargetCloudName String 目标端云名称（跨云本端云名称）
注意：此字段可能返回 null，表示取不到有效值。
示例值：tencentcloud
SourceAppId Integer 源端云AppId
注意：此字段可能返回 null，表示取不到有效值。
示例值：1000000000
SourceUin String 源端云主账号 Uin
注意：此字段可能返回 null，表示取不到有效值。
示例值：1000000000
SourceSubAccountUin String 源端云子账号 Uin
注意：此字段可能返回 null，表示取不到有效值。
示例值：2000000000
SourceUserName String 源端云用户名
注意：此字段可能返回 null，表示取不到有效值。
示例值：peer-user
TargetAppId Integer 目标端云AppId
注意：此字段可能返回 null，表示取不到有效值。
示例值：1000000001
TargetUin String 目标端云主账号 Uin
注意：此字段可能返回 null，表示取不到有效值。
示例值：1000000001
TargetSubAccountUin String 目标端云子账号 Uin
注意：此字段可能返回 null，表示取不到有效值。
示例值：2000000001
PeerRegionName String 对端云的地域显示名
注意：此字段可能返回 null，表示取不到有效值。
示例值：us-east-1
PeerZoneName String 对端云的可用区显示名
注意：此字段可能返回 null，表示取不到有效值。
示例值：us-east-1a
PeerVpcName String 对端云的VPC显示名
注意：此字段可能返回 null，表示取不到有效值。
示例值：peer-vpc-name

DeleteDrillPairResult

删除演练对结果

被如下接口引用：DeleteDrillPairs。

名称 类型 描述
DrillPairId String 演练对ID。
示例值：drillpair-5q25189t
Code String 删除结果码。成功为 Success，失败为对应错误码（如 InternalError.ComponentError）。
示例值：Success
Message String 删除结果描述信息，成功时为空串。
示例值：成功

DeniedAction

备份不能执行的接口。

被如下接口引用：DescribeBackupGroupsDeniedActions, DescribeBackupVaultsDeniedActions, DescribeCopyPairsDeniedActions, DescribeDisasterRecoverySitePairsDeniedActions, DescribeDrillPairsDeniedActions, DescribeFileBackupsDeniedActions, DescribeProtectGroupsDeniedActions。

名称 类型 描述
Action String 不能操作的接口名。
示例值："RetryResourceBackups"
Message String 接口不能操作的原因。
示例值："\u5907\u4efd(cosbackup-orslc3i7)\u72b6\u6001\u4e3a\u6b63\u5e38\uff0c\u4e0d\u652f\u6301\u5f53\u524d\u64cd\u4f5c"
Code String 接口不能操作对应提示的错误码。
示例值："ResourceUnavailable.NotSupported"

DisasterRecoveryDrillGroup

容灾演练组

被如下接口引用：DescribeDisasterRecoveryDrillGroups。

名称 类型 描述
Id Integer 资源ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：6
AppId Integer 用户ID
示例值：260110691
AccountUin String 账户uin
注意：此字段可能返回 null，表示取不到有效值。
示例值：100000000001
SubAccountUin String 子账户uin
注意：此字段可能返回 null，表示取不到有效值。
示例值：100000000001
SitePairId String 容灾站点对ID
示例值：sitepair-kau5adt5
ProtectGroupId String 保护组ID
示例值：pg-k6w329ux
DrillGroupId String 演练组ID
示例值：dg-5q25189t
DrillGroupName String 演练组名称
示例值：drill-20260430-eva4
DrillGroupType String 演练组类型。枚举值：DISK / INSTANCE / CFS。
示例值：INSTANCE
RecoveryTime String 恢复时间点
注意：此字段可能返回 null，表示取不到有效值。
示例值：2026-04-30 11:15:00
DrillVpc String 演练VPC
示例值：vpc-ej1zdbz9
DrillSecurityGroup String 演练安全组
注意：此字段可能返回 null，表示取不到有效值。
示例值：sg-xxxxxxxx
CreateTime String 创建时间
示例值：2026-04-30 11:15:00
ModifyTime String 修改时间
示例值：2026-04-30 11:15:00
LifeState String 生命周期状态。枚举值：NORMAL / DELETED。
示例值：NORMAL
DisasterRecoveryType String 容灾类型。枚举值：CROSS_ZONE / CROSS_REGION 等。
示例值：CROSS_ZONE
CopyType String 复制技术。枚举值：SYN（同步）/ ASYN（异步）。
示例值：SYN
PeerCloudName String 对端云名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：tencent
LocalCloudName String 本地云名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：tencent
SourceRegion String 生产地域
示例值：ap-guangzhou
SourceZone String 生产可用区
示例值：ap-guangzhou-2
SourceVpc String 生产端VPC
示例值：vpc-k4t0ylot
DrillRegion String 演练地域
示例值：ap-guangzhou
DrillZone String 演练可用区
示例值：ap-guangzhou-3
DataDirection String 数据方向。枚举值：POSITIVE（正向）/ REVERSE（反向）。
示例值：POSITIVE
BindDrilledResourceCount Integer 绑定的演练资源数量。
示例值：1
DrilledResourceStatusSet Array of DrilledResourceStatus 演练资源状态分布（key 为状态名如 FAILED / SUCCESS，value 为该状态数量）。

DisasterRecoveryOverview

容灾总览数据

被如下接口引用：DescribeDisasterRecoveryOverview。

名称 类型 描述
Region String 地域 ID
示例值：ap-guangzhou
SitePairCount Integer 站点对总数
示例值：3
SitePairCrossRegionCount Integer 跨地域站点对数
示例值：5
SitePairCrossZoneCount Integer 跨可用区站点对数
示例值：1
SitePairCrossCloudCount Integer 跨云站点对数
示例值：5
ProtectGroupCount Integer 保护组总数
示例值：2
ProtectGroupCrossRegionCount Integer 跨地域保护组数
示例值：5
ProtectGroupCrossZoneCount Integer 跨可用区保护组数
示例值：6
ProtectGroupCrossCloudCount Integer 跨云保护组数
示例值：1
CopyPairCount Integer 复制对总数
示例值：5
CopyPairSuccessRPOCount Integer RPO 正常的复制对数
示例值：2
CopyPairErrorRPOCount Integer RPO 异常的复制对数
示例值：7
DrillPairCount Integer 演练对总数
示例值：7
DrillPairDrillingCount Integer 演练中
示例值：2
DrillPairFailedCount Integer 演练失败
示例值：9
DrillPairSuccessCount Integer 演练成功
示例值：2
ProtectedResourceCount Integer 受保护资源总数
示例值：7
ProtectedResourceCopyingCount Integer 受保护资源-复制中
示例值：2
ProtectedResourceStoppedCount Integer 受保护资源-已停止/初始化
示例值：1
FailoverFailedCount Integer 切换失败
示例值：4

DiskCopyPairForCvm

cvm的盘复制对信息

被如下接口引用：DescribeCopyPairs。

名称 类型 描述
CopyPairId String 云硬盘复制对ID
示例值：copypair-xxxxxxxx
CopyPairName String 云硬盘复制对名称
示例值：test-disk-copy-pair
SourceResourceId String 生产端云硬盘ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：disk-xxxxxxxx
TargetResourceId String 容灾端云硬盘ID（延迟创建模式且 CVM 未真实创建时被脱敏为空字符串）
注意：此字段可能返回 null，表示取不到有效值。
示例值：disk-yyyyyyyy
CreateTime String 创建时间
示例值：2026-04-29 20:42:18

DiskInfo

描述容灾云硬盘的详情，如云硬盘的镜像格式。

被如下接口引用：DescribeDisks。

名称 类型 描述
DiskId String 云硬盘ID
示例值：“disk-11112222”
ImageFormat String 云盘的镜像格式。QCOW2: qcow2格式，这种格式的云盘不能用于容灾；RAW：raw格式，可以用于容灾。
示例值：“RAW”

DiskModel

云盘信息

被如下接口引用：CreateInstanceCopyPair, CreateInstanceDrillPairs。

名称 类型 必选 描述
DiskType String 否 云盘类型
示例值：CLOUD_SSD
DiskSize Integer 否 云盘大小（单位GB，范围 (0, 32000]）
示例值：100
DeleteWithInstance Boolean 否 是否随实例删除（仅 DataDisks 元素能传）
示例值：true

DrillPair

演练对

被如下接口引用：DescribeDrillPairs。

名称 类型 描述
AppId Integer 用户ID
示例值：260110691
DrillPairId String 演练对ID
示例值：drillpair-5q25189t
DrillPairName String 演练对名称
示例值：drill-20260430-eva4-0
DrillPairState String 演练对状态。枚举值：RUNNING / SUCCESS / FAILED 等。
示例值：FAILED
SitePairId String 容灾站点对ID
示例值：sitepair-kau5adt5
CopyPairId String 云硬盘复制对ID
示例值：cvmcopypair-hd2bhdxd
SourceRegion String 生产地域
示例值：ap-guangzhou
SourceZone String 生产可用区
示例值：ap-guangzhou-2
TargetRegion String 容灾地域
示例值：ap-guangzhou
TargetZone String 容灾可用区
示例值：ap-guangzhou-3
SourceResourceId String 生产站点盘ID
示例值：ins-b74arko8
TargetResourceId String 演练资源ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：ins-eej84hs4
DrillPairType String 演练对的类型。枚举值：DISK / INSTANCE / CFS。
示例值：INSTANCE
Size Integer 演练资源容量（GB）。
示例值：50
RecoveryTime String 演练的容灾点
注意：此字段可能返回 null，表示取不到有效值。
示例值：2026-04-30 11:10:06
CreateTime String 创建时间
示例值：2026-04-30 11:15:00
EndTime String 演练结束时间
注意：此字段可能返回 null，表示取不到有效值。
示例值：2026-04-30 11:16:05
Rollbacking Integer 是否正在回滚。0 - 未回滚，1 - 回滚中。
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
RollbackPercent Integer 回滚进度百分比（0-100）。
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
AccountUin String 创建定期备份策略的账户uin ID信息
注意：此字段可能返回 null，表示取不到有效值。
示例值：100000000001
SubAccountUin String 创建定期备份策略的子账户uin ID信息
注意：此字段可能返回 null，表示取不到有效值。
示例值：100000000001
ProtectGroupId String 保护组ID
示例值：pg-k6w329ux
DrillGroupId String 演练组ID
示例值：dg-5q25189t
CopyPairName String 复制对名称。
示例值：test2-0
DrillGroupName String 演练组名称。
示例值：drill-20260430-eva4

DrillPairDeniedAction

演练对操作掩码

被如下接口引用：DescribeDrillPairsDeniedActions。

名称 类型 描述
DrillPairId String 演练对ID
示例值：drill-xxxxxxxx
DeniedActions Array of DeniedAction 被禁止的操作列表（Action名称数组）

DrilledResourceStatus

演练组关联的演练资源的状态数量统计

被如下接口引用：DescribeDisasterRecoveryDrillGroups。

名称 类型 描述
ResourceStatus String 演练组关联的演练资源的状态
示例值：NORMAL
ResourceCount Integer 演练组关联演练资源处于某个状态的数量
示例值：1

EnhancedService

描述了实例的增强服务启用情况与其设置，如云安全，云监控等实例 Agent

被如下接口引用：CreateInstanceCopyPair, CreateInstanceDrillPairs。

名称 类型 必选 描述
SecurityService RunSecurityServiceEnabled 否 开启云安全服务。若不指定该参数，则默认开启云安全服务。
MonitorService RunSecurityServiceEnabled 否 开启云监控服务。若不指定该参数，则默认开启云监控服务。
AutomationService AutomationServiceEnabled 否 安装 tat-agent。若不指定该参数，则默认逻辑与 CVM 控制台一致：境外地域不安装、境内非 GPU 机型默认安装、境内 GPU 机型默认不安装。
BasicService BasicServicesSettings 否 开启基础服务。

FileBackupOverview

文件备份概览数据

被如下接口引用：DescribeBackupOverviewGeneral。

名称 类型 描述
BackupCount Integer 整机备份点总数
示例值：2
CreatingBackupCount Integer 创建中数量
示例值：41
FailedBackupCount Integer 失败数量
示例值：4
SuccessBackupCount Integer 已完成数量
示例值：5
RestoringBackupCount Integer 恢复中的总数量
示例值：1
BackupSizeMb Integer 整机备份总容量
示例值：7
BackupResourceCount Integer 受保护 CVM 资源数
示例值：7

FilterModel

过滤条件

被如下接口引用：DescribeAutoBackupPolicies, DescribeBackupGroupRollbackTasks, DescribeBackupGroups, DescribeBackupInstances, DescribeBackupPlans, DescribeBackupVaults, DescribeCopyPairs, DescribeDisasterRecoveryDrillGroups, DescribeDisasterRecoveryProtectGroups, DescribeDisasterRecoverySitePairs, DescribeDrillPairs, DescribeFileBackupPlans, DescribeFileBackups, DescribeFileRestoreTasks, DescribeProtectedInstances, DescribeSecurityGroupMappings, DescribeVpcMappings。

名称 类型 必选 描述
Name String 否 过滤器名
示例值：backup-id
Values Array of String 否 过滤器值
示例值：["fb-qox9q9sk"]

FlowControlRule

流控规则

被如下接口引用：DescribeFileBackupPlans。

名称 类型 描述
StartTime String 流控开始时间
示例值：00:00:00
EndTime String 流控结束时间
示例值：00:08:00
MaxBandwidthMBps Integer 流控规则最大带宽，单位MB/s
示例值：50

InstanceBackupOverview

整机备份（CVM 备份组）概览数据

被如下接口引用：DescribeBackupOverviewGeneral。

名称 类型 描述
BackupCount Integer 整机备份点总数
示例值：2
CreatingBackupCount Integer 创建中数量
示例值：4
FailedBackupCount Integer 失败数量
示例值：5
SuccessBackupCount Integer 已完成数量
示例值：2
RestoringBackupCount Integer 恢复中的总数量
示例值：5
BackupSizeMb Integer 整机备份总容量
示例值：6
BackupResourceCount Integer 受保护 CVM 资源数
示例值：1

InstanceChargePrepaid

描述了实例的计费模式

被如下接口引用：CreateInstanceCopyPair, CreateInstanceDrillPairs。

名称 类型 必选 描述
Period Integer 是 购买实例的时长，单位：月。取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。
示例值：1
RenewFlag String 否 自动续费标识。取值范围：NOTIFY_AND_AUTO_RENEW（通知过期且自动续费）、NOTIFY_AND_MANUAL_RENEW（通知过期不自动续费）、DISABLE_NOTIFY_AND_MANUAL_RENEW（不通知过期不自动续费）。
示例值：NOTIFY_AND_MANUAL_RENEW

InternetAccessible

描述了实例的公网可访问性，声明了实例的公网使用计费模式，最大带宽等

被如下接口引用：CreateInstanceCopyPair, CreateInstanceDrillPairs。

名称 类型 必选 描述
InternetChargeType String 否 网络计费类型。取值范围：BANDWIDTH_PREPAID（预付费按带宽结算）、TRAFFIC_POSTPAID_BY_HOUR（流量按小时后付费）、BANDWIDTH_POSTPAID_BY_HOUR（带宽按小时后付费）、BANDWIDTH_PACKAGE（带宽包用户）。默认取值：非带宽包用户默认与子机付费类型保持一致。
示例值：TRAFFIC_POSTPAID_BY_HOUR
InternetMaxBandwidthOut Integer 否 公网出带宽上限，单位：Mbps。默认值：0Mbps。不同机型带宽上限范围不一致，具体限制详见购买网络带宽。
示例值：20
PublicIpAssigned Boolean 否 是否分配公网IP。取值范围：true（表示分配公网IP）/false（表示不分配公网IP）。当公网带宽大于0Mbps时，可自由选择开通与否，默认开通公网IP；当公网带宽为0，则不允许分配公网IP。该参数仅在 RunInstances 接口中作为入参使用。
示例值：false
InternetServiceProvider String 否 网络模式：移动:"CMCC"、电信:"CTCC"、联通:"CUCC"。
示例值：CTCC

LoginSettings

描述了实例登录相关配置与信息。

被如下接口引用：CreateInstanceCopyPair, CreateInstanceDrillPairs。

名称 类型 必选 描述
Password String 否 实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下：Linux 实例密码必须 8-30 位，推荐使用 12 位以上密码，不能以"/"开头，至少包含以下字符中的三种不同字符，字符种类：小写字母 a-z、大写字母 A-Z、数字 0-9、特殊字符 ()~!@#$%^&*-+=_&#124;{}[]:;'<>,.?/。Windows 实例密码必须 12-30 位，不能以"/"开头且不包括用户名，至少包含以下字符中的三种不同字符，字符种类：小写字母 a-z、大写字母 A-Z、数字 0-9、特殊字符 ()~!@#$%^&*-+=_|{}[]:;' <>,.?/。若不指定该参数，则由系统随机生成密码，并通过站内信方式通知到用户。
示例值：Admin@1256
KeyIds Array of String 否 密钥ID列表。关联密钥后，就可以通过对应的私钥来访问实例；KeyId可通过接口 DescribeKeyPairs 获取，密钥与密码不能同时指定，同时Windows操作系统不支持指定密钥。当前仅支持购买的时候指定一个密钥。
示例值：["skey-3glfc"]
KeepImageLogin String 否 保持镜像的原始设置。该参数与 Password 或 KeyIds.N 不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为 TRUE。取值范围：TRUE（表示保持镜像的登录设置）/FALSE（表示不保持镜像的登录设置）。默认取值：FALSE。
示例值：TRUE

Placement

描述了实例的抽象位置，包括其所在的可用区，所属的项目，宿主机等（仅CDH产品可用）

被如下接口引用：CreateInstanceCopyPair, CreateInstanceDrillPairs。

名称 类型 必选 描述
Zone String 是 实例所属的可用区 ID。该参数也可以通过调用 [DescribeZones]的返回值中的Zone字段来获取。
示例值：ap-guangzhou-2
ProjectId Integer 否 实例所属项目ID。
示例值：0
HostId String 否 实例所属的专用宿主机ID列表。如果您有购买专用宿主机并且指定了该参数，则您购买的实例就会随机的部署在这些专用宿主机上。仅用于出参，当前暂不支持。
示例值：host-o5i742
HostIds Array of String 否 实例所属的专用宿主机ID列表，仅用于入参。如果您有购买专用宿主机并且指定了该参数，则您购买的实例就会随机的部署在这些专用宿主机上。
示例值：["host-o5i742"]
ProjectName String 否 实例所属项目名。
示例值：默认项目

PlanInfo

备份计划详情

被如下接口引用：DescribeFileBackupPlans。

名称 类型 描述
PlanId String 备份计划ID
示例值：fbp-9diaocuk
ResourceIds Array of String 计划关联的实例ID
示例值：["ins-adikqikz"]
PlanName String 计划名称
示例值：backup-plan
BackupPaths Array of String 备份路径列表，1~20 个
注意：此字段可能返回 null，表示取不到有效值。
示例值：["/data", "/home"]
IncludeFileTypes Array of String 包含文件类型，0~20 个
注意：此字段可能返回 null，表示取不到有效值。
示例值：[".log", ".txt"]
ExcludePatterns Array of String 排除文件路径列表，0~20 个
注意：此字段可能返回 null，表示取不到有效值。
示例值：["/sys"]
ExcludeSystemDirectories Boolean 是否排除系统目录
示例值：true
VaultId String 备份库ID
示例值：vault-qjhn63ku
Status String 备份计划状态
示例值：normal
AspId String 策略ID
示例值：asp-19dkdsiq
AspName String 策略名称
示例值：backup-policy
AspPolicy AspInfo 策略详情
LastExecuteTime String 最近一次执行时间
示例值：2026-03-31 08:00:00
NextTriggerTime String 下次触发时间
示例值：2026-04-01 08:00:00
CreatedTime String 创建时间
示例值：2026-03-31 06:00:00
LastTriggerError String 最近一次执行错误信息
示例值："over trade"
BackupCount Integer 备份数量
示例值：5
FlowControlSettings Array of FlowControlRule 流控信息

Policy

备份的执行策略详情

被如下接口引用：CreateAutoBackupPolicy, DescribeAutoBackupPolicies, DescribeFileBackupPlans, ModifyAutoBackupPolicyAttribute。

名称 类型 必选 描述
DayOfWeek Array of Integer 否 选定周一到周日中需要创建备份的日期，取值范围：[0, 6]。0表示周日触发，1表示周一触发，依次类推。
示例值：[0,1]
Hour Array of Integer 否 指定定期备份策略的触发时间。单位为小时，取值范围：[0, 23]。00:00 ~ 23:00 共 24 个时间点可选，1表示 01:00，依此类推。
示例值：[0,23]
DayOfMonth Array of Integer 否 指定每月从月初到月底需要触发定期备份的日期,取值范围：[1, 31]，1-31分别表示每月的具体日期，比如5表示每月的5号。注：若设置29、30、31等部分月份不存在的日期，则对应不存在日期的月份会跳过不打定期备份。
示例值：[1,4]
IntervalDays Integer 否 指定创建定期备份的间隔天数，取值范围：[1, 365]，例如设置为5，则间隔5天即触发定期备份创建。注：当选择按天备份时，理论上第一次备份的时间为备份策略创建当天。如果当天备份策略创建的时间已经晚于设置的备份时间，那么将会等到第二个备份周期再进行第一次备份。
示例值：12

ProtectGroup

容灾保护组信息

被如下接口引用：DescribeDisasterRecoveryProtectGroups。

名称 类型 描述
AppId Integer 用户AppId
示例值：1000000000
ProtectGroupId String 保护组ID
示例值：pg-xxxxxxxx
ProtectGroupName String 保护组名称
示例值：my-protect-group
ProtectGroupType String 保护组类型（产品类型，如 DISK/CFS/INSTANCE）
示例值：INSTANCE
SitePairId String 所属容灾策略ID
示例值：sp-xxxxxxxx
SitePairName String 所属容灾策略名称
示例值：my-site-pair
RecoveryPointObjective Integer RPO时间（单位秒）
示例值：900
SourceRegion String 生产地域（当 DataDirection=REVERSE 时会与 TargetRegion 自动轮转，保持用户视角一致）
示例值：ap-guangzhou
SourceZone String 生产可用区（REVERSE 时与 TargetZone 自动轮转）
示例值：ap-guangzhou-3
SourceVpc String 生产端VPC（REVERSE 时与 TargetVpc 自动轮转）
示例值：vpc-xxxxxxxx
TargetRegion String 容灾地域（REVERSE 时与 SourceRegion 自动轮转）
示例值：ap-guangzhou
TargetZone String 容灾可用区
示例值：ap-guangzhou-4
TargetVpc String 容灾端VPC
示例值：vpc-yyyyyyyy
CopyType String 复制技术（SYN 同步 / ASY 异步）
示例值：SYN
DisasterRecoveryType String 容灾类型（CROSS_ZONE 跨可用区 / CROSS_REGION 跨地域 / CROSS_CLOUD 跨云）
示例值：CROSS_ZONE
DataDirection String 数据复制方向（POSITIVE 正向 / REVERSE 反向）
示例值：POSITIVE
PeerCloudName String 跨云场景对端云名称（仅 DisasterRecoveryType=CROSS_CLOUD 时返回）
注意：此字段可能返回 null，表示取不到有效值。
示例值：aws
CreateFrom String 创建来源（LOCAL 本端创建 / PEER 对端创建）
示例值：LOCAL
LifeState String 生命周期状态
示例值：NORMAL
AccountUin String 创建保护组的账户主账号 Uin
注意：此字段可能返回 null，表示取不到有效值。
示例值：1000000000
SubAccountUin String 创建保护组的子账号 Uin
注意：此字段可能返回 null，表示取不到有效值。
示例值：2000000000
CreateTime String 创建时间
示例值：2026-04-28 10:00:00
ModifyTime String 修改时间
示例值：2026-04-28 10:30:00
BindProtectedResourceCount Integer 绑定的已保护资源数量
注意：此字段可能返回 null，表示取不到有效值。
示例值：3
ErrorRecoveryPointObjectiveCount Integer RPO 异常（超过 15 分钟未同步）的复制对数量
注意：此字段可能返回 null，表示取不到有效值。
示例值：0
ProtectedResourceStatusSet Array of ProtectedResourceStatus 已保护资源状态统计，key 为复制对状态，value 为该状态下的资源数量
注意：此字段可能返回 null，表示取不到有效值。

ProtectGroupDeniedAction

保护组操作掩码

被如下接口引用：DescribeProtectGroupsDeniedActions。

名称 类型 描述
ProtectGroupId String 保护组ID
示例值：pg-xxxxxxxx
DeniedActions Array of DeniedAction 被禁止的操作列表（Action名称数组）

ProtectInstance

受保护实例信息

被如下接口引用：DescribeProtectedInstances。

名称 类型 描述
InstanceId String 实例ID
示例值：ins-abc12345
AgentId String 客户端ID
示例值：ins-abc12345
AgentVersion String 客户端版本
示例值：1.2.0
AgentStatus String 客户端状态
示例值：online
LastHeartbeatTime String 最后心跳时间
示例值：2026-03-31T10:30:00
CreatedTime String 创建时间
示例值：2026-03-31T09:30:00",
ExtraInfo String 最新备份点中记录的 CVM 基础信息
示例值："{"OsType":"linux","OsVersion":"CentOS 7.9","PrivateIp":"10.0.0.1"}"
BackupCount Integer 该实例可用备份点数量
示例值：5
InstanceName String 实例名称
注意：此字段可能返回 null，表示取不到有效值。
示例值：admin-cvm
LatestBackupTime String 最近一次备份时间
示例值：2026-10-02 00:00:00
OfflineReason String 离线原因
示例值：Heartbeat timeout

ProtectedResource

受保护资源信息

被如下接口引用：DescribeDisasterRecoverySitePairs。

名称 类型 描述
ResourceType String 资源类型（与请求 SitePairType 一致，如 DISK/CFS/INSTANCE）
示例值：INSTANCE
ResourceIdSet Array of String 该类型下被保护的源端资源ID列表（DISK:disk-xxx / CFS:cfs-xxx / INSTANCE:ins-xxx）
示例值：["ins-xxxxxxxx"]

ProtectedResourceOverview

受保护资源概览

被如下接口引用：DescribeBackupOverviewGeneral。

名称 类型 描述
TotalProtectedCount Integer 受保护资源总数
示例值：4
TotalResourceCount Integer 总资源数
示例值：5
Cvm ResourceProtectStat CVM 受保护统计
CFS ResourceProtectStat CFS 受保护统计

ProtectedResourceStatus

保护资源类型个数统计

被如下接口引用：DescribeDisasterRecoveryProtectGroups, DescribeDisasterRecoverySitePairs。

名称 类型 描述
Status String 状态
示例值：INC_COPYING
Count Integer 数量
示例值：10

ResourcePlan

实例Id与备份计划映射信息

被如下接口引用：CreateFileBackupPlan。

名称 类型 必选 描述
ResourceId String 是 云服务器实例 ID
示例值：ins-q9xiskqi
BackupPaths Array of String 否 备份路径，[0,20]
示例值：["/var/log", "/etc/nginx"]
IncludeFileTypes Array of String 否 包含文件类型，[0,20]
示例值：["*.log"]
ExcludePatterns Array of String 否 排除路径，[0,20]
示例值：["/home/app/tmp"]
ExcludeSystemDirectories Boolean 否 是否排除系统目录
示例值：true
ExecuteImmediately Boolean 否 是否立即触发全量备份
示例值：false

ResourceProtectStat

产品受保护统计信息

被如下接口引用：DescribeBackupOverviewGeneral。

名称 类型 描述
ProtectedCount Integer 受保护资源数
示例值：4
TotalCount Integer 资源总数
示例值：2

RestoreTask

恢复任务信息

被如下接口引用：DescribeFileRestoreTasks。

名称 类型 描述
TaskId String 恢复任务 ID
示例值：frt-0qu9s8ec
BackupId String 关联备份点 ID
示例值：fb-op7apew4
ResourceId String 源实例 ID
示例值：ins-7630gzfm
TargetResourceId String 目标实例 ID
示例值：ins-eej84hs4
RestorePaths Array of String 恢复路径列表
示例值：["/data"]
TargetLocation String 目标恢复位置
示例值：/data1
Status String 任务状态
示例值：running
TotalFileCount Integer 需恢复文件总数
示例值：1520
TotalSize Integer 需恢复数据总量（字节）
示例值：1073741824
TotalSizeFormatted String 需恢复数据总量（格式化，如 "1.5 GB"）
示例值："1.00 GB"
RestoreFileCount Integer 已恢复文件数
示例值：760
RestoreSize Integer 已恢复数据量（字节）
示例值：536870912
RestoreSizeFormatted String 已恢复数据量（格式化）
示例值："512.00 MB"
Progress Float 恢复进度（0-100）
示例值：50.0
JobId String 关联 Job ID
示例值：j-20260331133609-7fcf71f2
StartTime String 任务开始时间（ISO 格式）
示例值：2026-03-31 21:36:09
EndTime String 任务结束时间
示例值：2026-03-31 21:36:49
CreatedTime String 任务创建时间
示例值：2026-03-31 21:36:08
FailReason String 恢复任务失败原因
示例值：brc-runner process timed out: no status file generated within 600 seconds
ConflictStrategy String 冲突处理策略：skip-跳过/overwrite-覆盖/newer-保留最新版本/if_changed-内容变化时覆盖
示例值：skip

RunSecurityServiceEnabled

描述了 “云安全” 服务相关的信息

被如下接口引用：CreateInstanceCopyPair, CreateInstanceDrillPairs。

名称 类型 必选 描述
Enabled Boolean 否 是否开启该服务。取值范围：TRUE（开启）/FALSE（不开启）。默认取值：TRUE。
示例值：true

SecurityGroupMapping

安全组映射详情

被如下接口引用：DescribeSecurityGroupMappings。

名称 类型 描述
SecurityGroupMappingId String 安全组映射ID
示例值：sgmap-11112222
SitePairId String 安全组映射所属的站点对ID
示例值：sitepair-mhqxamfh
SourceSecurityGroupId String 生产端安全组ID
示例值：sg-flu1kxxx
TargetSecurityGroupId String 容灾端安全组ID
示例值：sg-flu1k222
LifeState String 安全组映射的生命状态；NORMAL:正常。
示例值：NORMAL

SitePair

站点对信息

被如下接口引用：DescribeDisasterRecoverySitePairs。

名称 类型 描述
AppId Integer 用户AppId
示例值：1000000000
SitePairId String 容灾策略ID
示例值：sp-xxxxxxxx
SitePairName String 容灾策略名称
示例值：my-site-pair
SitePairType String 容灾策略类型（产品类型，如 DISK/CFS/INSTANCE 等）
示例值：INSTANCE
SitePairState String 容灾策略状态
示例值：NORMAL
SourceRegion String 生产地域
示例值：ap-guangzhou
SourceZone String 生产可用区
示例值：ap-guangzhou-3
TargetRegion String 容灾地域
示例值：ap-guangzhou
TargetZone String 容灾可用区
示例值：ap-guangzhou-4
SourceVpc String 生产端VPC
示例值：vpc-xxxxxxxx
TargetVpc String 容灾端VPC
示例值：vpc-yyyyyyyy
CopyType String 复制技术（SYN 同步 / ASY 异步）
示例值：SYN
DisasterRecoveryType String 容灾类型（CROSS_ZONE 跨可用区 / CROSS_REGION 跨地域 / CROSS_CLOUD 跨云）
示例值：CROSS_ZONE
CreateFrom String 创建来源（LOCAL 本端创建 / PEER 对端创建）
示例值：LOCAL
AccountUin String 创建容灾策略的账户主账号 Uin
注意：此字段可能返回 null，表示取不到有效值。
示例值：1000000000
SubAccountUin String 创建容灾策略的子账户 Uin
注意：此字段可能返回 null，表示取不到有效值。
示例值：2000000000
CreateTime String 创建时间
示例值：2026-04-28 10:00:00
BindProtectGroupCount Integer 已绑定的保护组数量
示例值：0
ErrorRecoveryPointObjectiveCopyPairSet Array of String RPO 异常的复制对ID列表（最近一次保护点距今超过15分钟的复制对）
注意：此字段可能返回 null，表示取不到有效值。
示例值：["cp-xxxxxxxx"]
ProtectedResourceSet Array of ProtectedResource 已保护的资源列表（按资源类型分组）
注意：此字段可能返回 null，表示取不到有效值。
ProtectedResourceStatusSet Array of ProtectedResourceStatus 已保护资源的状态统计，key 为复制对状态，value 为该状态下的资源数量
注意：此字段可能返回 null，表示取不到有效值。
CrossCloudDetails CrossCloudDetails 跨云场景下的额外信息（仅 IsCrossCloud=true 时返回，非跨云为 null）
注意：此字段可能返回 null，表示取不到有效值。

SitePairDeniedAction

单个容灾策略的禁止操作集合

被如下接口引用：DescribeDisasterRecoverySitePairsDeniedActions。

名称 类型 描述
SitePairId String 容灾策略ID
示例值：sitepair-2zjmpdlb
DeniedActions Array of DeniedAction 该容灾策略当前被禁止执行的操作列表

SupportRegionInfo

支持的生产地域配置详情，包含支持类型与可用区粒度规则。

被如下接口引用：DescribeDisasterRecoverySupportRegion。

名称 类型 描述
SourceRegion String 生产地域。
示例值："ap-guangzhou"
SupportType String 支持类型：REGION（地域级，整个生产地域均支持容灾）；ZONE（可用区级，按 SupportZoneRules 控制粒度）。
示例值："REGION"
Status String 配置状态：valid（生效）/ invalid（停用）。
示例值："valid"
SupportZoneRules Array of SupportZoneRule 可用区级容灾规则列表。仅当 SupportType=ZONE 时有效；REGION 类型时该字段返回空数组。
注意：此字段可能返回 null，表示取不到有效值。

SupportZoneRule

可用区级容灾规则，描述某个生产可用区可容灾到的目标可用区集合。

被如下接口引用：DescribeDisasterRecoverySupportRegion。

名称 类型 描述
SourceZone String 生产可用区。
示例值："ap-guangzhou-3"
IsAllZoneSupport Boolean 是否支持容灾到生产地域内的全部可用区。true 时 TargetZones 可忽略。
示例值：false
TargetZones Array of String 目标可用区列表。当 IsAllZoneSupport=false 时枚举具体可容灾到的可用区。
注意：此字段可能返回 null，表示取不到有效值。
示例值：["ap-guangzhou-4"]

TypeCount

备份库类型统计

被如下接口引用：DescribeBackupVaults。

名称 类型 描述
Type String 备份库类型
示例值：cvm_agent
Count Integer 备份库数量
示例值：30

VaultDeniedAction

备份库操作掩码

被如下接口引用：DescribeBackupVaultsDeniedActions。

名称 类型 描述
VaultId String 备份库实例ID
示例值：vault-a1b2c3d4
DeniedActions Array of DeniedAction 被禁止的操作列表

VirtualPrivateCloud

描述了VPC相关信息，包括子网，IP信息等

被如下接口引用：CreateInstanceCopyPair, CreateInstanceDrillPairs。

名称 类型 必选 描述
VpcId String 是 私有网络ID，形如 vpc-xxxxxxxx。私有网络ID可通过登录控制台查询，也可通过调用接口 [DescribeVpcEx]的返回值中的unVpcId字段获取。
示例值：vpc-2ij
SubnetId String 是 私有网络子网ID，形如 subnet-xxxxxxxx。私有网络子网ID可通过登录控制台查询，也可通过调用接口 DescribeSubnets 的返回值中的 unSubnetId 字段获取。
示例值：subnet-2ks
SubnetName String 否 私有网络子网名称。
示例值：cloud
AsVpcGateway Boolean 否 是否用作公网网关。公网网关只有在实例拥有公网IP以及处于私有网络下时才能正常使用。取值范围：true（用作公网网关）/false（不作为公网网关），默认取值：false。
示例值：false
PrivateIpAddresses Array of String 否 私有网络子网 IP 数组，在创建实例、修改实例 vpc 属性操作中可使用此参数。当前仅批量创建多台实例时支持传入相同子网的多个 IP。
示例值：["10.0.0.1"]
VpcName String 否 私有网络名称，仅做展示用。
示例值：69333vpc-c
Ipv6AddressCount Integer 否 为弹性网卡指定随机生成的 IPv6 地址数量。
示例值：1

VpcMapping

站点对vpc映射信息

被如下接口引用：DescribeVpcMappings。

名称 类型 描述
Id Integer 映射规则主键ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：163
SitePairId String 所属容灾策略ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：sp-xxxxxxxx
SourceVpc String 源端VPC ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：vpc-xxxxxxxx
SourceSubnet String 源端子网ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：subnet-xxxxxxxx
TargetVpc String 目标端VPC ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：vpc-yyyyyyyy
TargetSubnet String 目标端子网ID
注意：此字段可能返回 null，表示取不到有效值。
示例值：subnet-yyyyyyyy
Status String 映射状态
注意：此字段可能返回 null，表示取不到有效值。
示例值：NORMAL
LifeState String 生命周期状态
注意：此字段可能返回 null，表示取不到有效值。
示例值：NORMAL
中国站 - English