租户端 存储 备份中心（BRC） 数据结构

数据结构

最近更新时间: 2024-09-03 18:49:42

DataDisk

描述云服务器的数据盘信息。

被如下接口引用：RunInstancesWithBackupGroup

名称 必选 允许NULL 类型 描述
DiskType 否 否 String 系统盘类型。取值范围：<br><li>CLOUD_BASIC：普通云硬盘<br><li>CLOUD_SSD：SSD云硬盘<br><li>CLOUD_PREMIUM：高性能云盘
DiskSize 是 否 Int64 数据盘大小，单位：GB。最小调整步长为10G，不同数据盘类型取值范围不同。默认值为0，表示不购买数据盘。更多限制详见产品文档。
DiskStoragePoolGroup 否 否 String 数据盘指定的资源池。
BackupId 否 否 String 指定回滚到盘上的备份ID。

ProjectSpecification

平台项目ID

被如下接口引用：

名称 必选 允许NULL 类型 描述
ResourceType 是 否 String 资源类型,默认instance
PlatformProjectId 是 否 String 项目Id

FileSystemBackup

描述文件系统备份详情

被如下接口引用：DescribeCfsBackups

名称 必选 允许NULL 类型 描述
BackupName 是 否 String 备份名称。
CopyFromRemote 是 否 Bool 是否为远程复制的备份。
IsPermanent 是 否 Bool 是否永久保留。
BackupState 是 否 String 备份的状态。取值范围：<br><li>NORMAL：正常<br><li>CREATING：创建中<br><li>ROLLBACKING：回滚中<br><li>COPYING_FROM_REMOTE：跨地域复制拷贝中。
DeadlineTime 否 是 Datetime 备份的到期时间。
Percent 是 否 Uint64 备份创建的进度。
ShareReference 否 是 Uint64 备份被共享的次数。
BackupType 是 否 String 备份类型，目前该项取值可以为PRIVATE_BACKUP或者SHARED_BACKUP。
DiskSize 是 否 Uint64 创建备份的云硬盘大小，单位GB。
DiskId 是 否 String 创建备份的云硬盘ID。
PlatformProjectId 否 是 String 备份所属项目ID。
BackupId 是 否 String 备份ID。
CopyingToRegions 否 否 Array of String 备份当前正在远程复制的目标地域列表。
Encrypt 否 是 String 备份是否为加密备份。
CreateTime 是 否 Datetime 备份的创建时间。
DiskUsage 是 否 String 创建此备份的云硬盘类型。取值范围：<br><li>SYSTEM_DISK：系统盘<br><li>DATA_DISK：数据盘。
Placement 否 否 Placement 备份所在的位置。
Tags 否 否 Array of Tag 备份绑定的标签列表。
AppId 是 否 Uint64 用户AppId。
DiskName 是 是 String 云盘名称。
FileSystemDetails 否 是 String 创建备份时刻，文件系统各属性的详情。
BackupClass 否 是 String 全量、增量备份信息；FULL表示全量备份，INC表示增量备份。
FileSystemId 是 否 String 创建备份的文件系统ID。

SubTaskStatistic

描述操作日志子任务执行情况

被如下接口引用：DescribeBackupOperations

名称 必选 允许NULL 类型 描述
SucceedCount 是 是 Uint64 子任务成功数量，null表示没有子任务。
FailedCount 是 是 Uint64 子任务失败数量，null表示没有子任务。

LoginSettings

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

被如下接口引用：RunInstancesWithBackupGroup

名称 必选 允许NULL 类型 描述
Password 否 是 String 实例登录密码。不同操作系统类型密码复杂度限制不一样，具体如下：<br><li>Linux机器密码需10到30位，至少包括三项([a-z],[A-Z],[0-9]和[()~!@#$%^&amp;*-+=_|{}[]:;&#39;&lt;&gt;,.?/]的特殊符号)。&lt;br&gt;&lt;li&gt;Windows机器密码需12到30位，至少包括三项([a-z],[A-Z],[0-9]和[()~!@#$%^&*-+=_|{}[]:;'<>,.?/]的特殊符号),密码不允许包含用户名密码不允许以/符号开头。<br><li>如果实例即包含Linux实例又包含Windows实例，则密码复杂度限制按照Windows实例的限制
KeyIds 否 是 Array of String 密钥ID列表。关联密钥后，就可以通过对应的私钥来访问实例；KeyId可通过接口DescribeKeyPairs获取，密钥与密码不能同时指定，同时Windows操作系统不支持指定密钥。当前仅支持购买的时候指定一个密钥。
KeepImageLogin 否 是 String 保持镜像的原始设置。该参数与Password或KeyIds.N不能同时指定。只有使用自定义镜像、共享镜像或外部导入镜像创建实例时才能指定该参数为TRUE。取值范围：<br><li>TRUE：表示保持镜像的登录设置<br><li>FALSE：表示不保持镜像的登录设置<br><br>默认取值：FALSE。

RunSecurityServiceEnabled

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

被如下接口引用：RunInstancesWithBackupGroup

名称 必选 允许NULL 类型 描述
Enabled 否 否 Bool 是否开启云安全服务。取值范围：<br><li>TRUE：表示开启云安全服务<br><li>FALSE：表示不开启云安全服务<br><br>默认取值：TRUE。

TagSpecification

创建云主机实例时同时绑定的标签对说明

被如下接口引用：

名称 必选 允许NULL 类型 描述
ResourceType 是 否 String 标签绑定的资源类型。
Tags 是 否 Array of Tag 标签对列表。

BackupFileSystem

描述文件系统的备份信息。

被如下接口引用：DescribeBackupCfsFileSystems

名称 必选 允许NULL 类型 描述
AutoBackupPolicyIdSet 否 否 Array of String 实例绑定的定期备份策略列表。
FileSystemId 否 否 String 文件系统ID。
AppId 否 否 Uint64 用户AppId。
LatestBackupTime 否 否 Datetime 文件系统的最新备份时间。
BackupIdSet 否 否 Array of String 文件系统的备份ID列表。
ModifyTime 否 否 Datetime 修改时间。
CreateTime 否 否 Datetime 文件系统当前存在的最早备份的时间。
DiskId 否 否 String 文件系统关联的云盘ID。

DeniedAction

备份不能执行的接口。

被如下接口引用：DescribeBackupGroupsDeniedActions、DescribeBackupsDeniedActions

名称 必选 允许NULL 类型 描述
Action 是 否 String 不能操作接口名。
Message 是 否 String 接口不能操作的原因。
Code 是 否 String 接口不能操作对应提示的错误码。

RunMonitorServiceEnabled

描述了 “云监控” 服务相关的信息

被如下接口引用：RunInstancesWithBackupGroup

名称 必选 允许NULL 类型 描述
Enabled 否 否 Bool 是否开启云监控服务。取值范围：<br><li>TRUE：表示开启云监控服务<br><li>FALSE：表示不开启云监控服务<br><br>默认取值：TRUE。

Backup

描述云盘备份详情

被如下接口引用：DescribeBackups

名称 必选 允许NULL 类型 描述
BackupName 是 是 String 备份名称。
CopyFromRemote 是 否 Bool 是否为远程复制的备份。
IsPermanent 是 否 Bool 是否永久保留。
BackupState 是 否 String 备份的状态。取值范围：<br><li>NORMAL：正常<br><li>CREATING：创建中<br><li>ROLLBACKING：回滚中<br><li>COPYING_FROM_REMOTE：跨地域复制拷贝中。
DeadlineTime 否 是 Datetime 备份的到期时间。
Percent 是 否 Uint64 备份创建的进度。
ShareReference 否 否 Uint64 备份被共享的次数。
BackupType 是 否 String 备份类型，目前该项取值可以为PRIVATE_BACKUP或者SHARED_BACKUP。
DiskSize 是 否 Uint64 创建备份的云硬盘大小，单位GB。
DiskId 是 否 String 创建备份的云硬盘ID。
PlatformProjectId 否 否 String 备份所属项目ID。
BackupId 是 否 String 备份ID。
CopyingToRegions 否 否 Array of String 备份当前正在远程复制的目标地域列表。
Encrypt 否 否 Bool 备份是否为加密备份。
CreateTime 是 否 Datetime 备份的创建时间。
DiskUsage 是 否 String 创建此备份的云硬盘类型。取值范围：<br><li>SYSTEM_DISK：系统盘<br><li>DATA_DISK：数据盘。
Placement 否 否 Placement 备份所在的位置。
Tags 否 否 Array of Tag 备份绑定的标签列表。
AppId 是 否 Uint64 用户AppId。
DiskName 是 是 String 云盘名称。
DiskDetails 否 是 String 创建备份时刻，云硬盘各属性的详情。
BackupClass 否 是 String 全量、增量备份信息；FULL表示全量备份，INC表示增量备份。
BackupGroupId 否 否 String 备份关联的备份组。

BackupDeniedAction

单个备份的操作掩码。

被如下接口引用：DescribeBackupsDeniedActions

名称 必选 允许NULL 类型 描述
BackupId 是 否 String 备份ID。
SnapshotDeniedAction 是 否 Array of DeniedAction 具体的备份操作掩码列表。

BackupGroup

描述备份组详情

被如下接口引用：DescribeBackupGroups

名称 必选 允许NULL 类型 描述
ContainRootBackup 是 否 Bool 备份组是否包含系统盘备份。
BackupGroupId 是 否 String 备份组ID。
BackupGroupType 是 否 String 备份组类型。NORMAL: 普通备份组，非一致性备份。
Percent 是 否 Uint64 备份组创建进度。
BackupIdSet 是 否 Array of String 备份组包含的备份ID列表。
BackupGroupName 是 否 String 备份组名称。
BackupGroupState 是 否 String 备份组状态。<br><li>NORMAL: 正常<br><li>CREATING:创建中<br><li>DELETED:已删除<br><li>FAILED:创建失败<br><li>DISMISS:已解散<br><li>ROLLBACKING:回滚中
ModifyTime 是 否 Datetime 最新修改时间。
CreateTime 是 否 Datetime 备份组创建时间。
AppId 是 否 Uint64 用户AppId。
IsPermanent 是 否 Bool 是否为永久备份组。
DeadlineTime 是 是 Datetime 备份组的到期时间。如果为永久备份组，则取值为null。
InstanceId 是 是 String 创建备份组的实例ID。
InstanceDetails 是 是 String 创建备份组时刻实例的详情。

InternetAccessible

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

被如下接口引用：RunInstancesWithBackupGroup

名称 必选 允许NULL 类型 描述
InternetChargeType 否 是 String 网络计费类型。取值范围：<br><li>BANDWIDTH_PREPAID：预付费按带宽结算<br><li>TRAFFIC_POSTPAID_BY_HOUR：流量按小时后付费<br><li>BANDWIDTH_POSTPAID_BY_HOUR：带宽按小时后付费<br><li>BANDWIDTH_PACKAGE：带宽包用户<br>默认取值：TRAFFIC_POSTPAID_BY_HOUR。
InternetMaxBandwidthOut 否 否 Int64 公网出带宽上限，单位：Mbps。默认值：0Mbps。不同机型带宽上限范围不一致。
PublicIpAssigned 否 否 Bool 是否分配公网IP。取值范围：<br><li>TRUE：表示分配公网IP<br><li>FALSE：表示不分配公网IP<br><br>公网带宽大于0时必须设置为True,默认开通公网IP；当公网带宽为0，则不允许分配公网IP。

ApplyDisk

本参数用于备份组回滚接口的入参，表示回滚的云盘、备份列表

被如下接口引用：ApplyBackupGroup

名称 必选 允许NULL 类型 描述
BackupId 是 否 String 备份ID。
DiskId 是 否 String 云硬盘ID。

Tag

描述标签信息。

被如下接口引用：DescribeBackups、DescribeCfsBackups

名称 必选 允许NULL 类型 描述
Key 是 否 String 标签键。
Value 是 否 String 标签值。

AutoBackupPolicy

描述了定期备份策略的详细信息

被如下接口引用：DescribeAutoBackupPolicies

名称 必选 允许NULL 类型 描述
DiskIdSet 是 否 Array of String 备份策略绑定的云硬盘列表。
IsActivated 是 否 Bool 定期备份策略是否激活。
IsPermanent 是 否 Bool 使用该定期备份策略创建出来的备份是否永久保留。
NextTriggerTime 是 否 Datetime 定期备份下次触发的时间。
AutoBackupPolicyState 是 否 String 定期备份策略的状态。取值范围：<br><li>NORMAL：正常<br><li>ISOLATED：已隔离。
AutoBackupPolicyName 是 否 String 备份策略的名称。
Policy 是 否 Array of Policy 定期备份的执行策略。
AutoBackupPolicyId 是 否 String 备份策略ID。
CreateTime 是 否 Datetime 备份策略的创建时间。
RetentionDays 是 否 Uint64 使用该定期备份策略创建出来的备份保留天数。
AppId 是 否 Uint64 用户AppId。
InstanceIdSet 是 否 Array of String 定期备份策略绑定的实例ID列表。
FileSystemIdSet 是 否 Array of String 备份策略绑定的文件系统ID列表。
RetentionMonths 是 否 Uint64 该定期快照创建的快照最大保留月数
RetentionAmount 是 否 Uint64 该定期快照创建的快照最大保留数量
AdvancedRetentionPolicy 是 否 AdvancedRetentionPolicy 高级保留策略
CreateSpeed 否 否 Uint64 创建备份的带宽上限，范围：[0, 100]

OperationLog

描述备份相关操作日志

被如下接口引用：DescribeBackupOperations

名称 必选 允许NULL 类型 描述
TaskId 是 否 Uint64 操日志任务ID。
InstanceId 是 是 String 实例ID。
AutoBackupPolicyId 是 是 String 定期备份策略ID。
TaskState 是 否 String 操作日志任务结果。<br><li>SUCCESS: 成功<br><li>FAILED: 失败
SubTaskStatistic 是 是 SubTaskStatistic 子任务执行情况统计。
LogTaskId 是 是 String 任务流水ID。
BackupGroupId 是 是 String 备份组ID。
StartTime 是 是 Datetime 任务开始时间。
AppId 是 是 Uint64 用户AppId。
Operator 是 是 String 操作者。
BackupId 是 是 String 备份ID。
TaskName 是 否 String 任务名称。
EndTime 是 是 Datetime 任务结束时间。
ParentTaskId 是 是 Uint64 当前任务的父任务ID。如果无父任务，则默认为0。
DiskId 是 是 String 云硬盘ID。
TaskDescription 是 是 String 任务结果描述。
FileSystemId 是 是 String 文件系统ID。

EnhancedService

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

被如下接口引用：RunInstancesWithBackupGroup

名称 必选 允许NULL 类型 描述
SecurityService 否 否 RunSecurityServiceEnabled 开启云安全服务。若不指定该参数，则默认开启云安全服务。
MonitorService 否 否 RunMonitorServiceEnabled 开启云安全服务。若不指定该参数，则默认开启云监控服务。

BackupGroupDeniedAction

单个备份组的操作掩码。

被如下接口引用：DescribeBackupGroupsDeniedActions

名称 必选 允许NULL 类型 描述
BackupGroupId 是 否 String 备份组ID。
DeniedActions 是 否 Array of DeniedAction 具体的备份操作掩码列表。

Filter

描述键值对过滤器，用于条件过滤查询。

被如下接口引用：DescribeAutoBackupPolicies、DescribeBackupCfsFileSystems、DescribeBackupDisks、DescribeBackupGroups、DescribeBackupInstances、DescribeBackupOperations、DescribeBackups、DescribeCfsBackups

名称 必选 允许NULL 类型 描述
Name 是 否 String 过滤键的名称。
Values 是 否 Array of String 一个或者多个过滤值。

Policy

描述了定期备份的执行策略

被如下接口引用：CreateAutoBackupPolicy、DescribeAutoBackupPolicies、ModifyAutoBackupPolicyAttribute

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

SystemDisk

描述云服务器的系统盘信息

被如下接口引用：RunInstancesWithBackupGroup

名称 必选 允许NULL 类型 描述
DiskType 否 否 String 系统盘类型。取值范围：<br><li>CLOUD_BASIC：普通云硬盘<br><li>CLOUD_SSD：SSD云硬盘<br><li>CLOUD_PREMIUM：高性能云盘
DiskSize 否 否 Int64 系统盘大小，单位：GB。默认值为 50
DiskStoragePoolGroup 否 是 String 系统盘指定的资源池。

BackupCopyResult

描述备份跨地域复制的结果。

被如下接口引用：CopyBackupCrossRegions

名称 必选 允许NULL 类型 描述
DestinationRegion 是 否 String 跨地域复制的目的地域。
BackupId 是 否 String 复制到目的地域的新备份ID。

AdvancedRetentionPolicy

高级保留策略

被如下接口引用：CreateAutoBackupPolicy、DescribeAutoBackupPolicies、ModifyAutoBackupPolicyAttribute

名称 必选 允许NULL 类型 描述
Days 否 否 Uint64 保留Days天内的每天最新的一个备份
Weeks 否 否 Uint64 保留Weeks周内的每周最新的一个备份
Months 否 否 Uint64 保留Months月内的每月最新的一个备份
Years 否 否 Uint64 保留Years年内的每年最新的一个备份

BackupDisk

描述云硬盘备份信息

被如下接口引用：DescribeBackupDisks

名称 必选 允许NULL 类型 描述
LatestBackupTime 是 否 Datetime 云硬盘最新一次备份的时间。
DiskName 是 是 String 云硬盘名称。
AutoBackupPolicyIdSet 是 否 Array of String 云硬盘绑定的定期备份策略列表。
Placement 是 是 Placement 云硬盘所在的位置。
DiskChargeType 是 是 String 付费模式。取值范围：<br><li>PREPAID：预付费，即包年包月<br><li>POSTPAID_BY_HOUR：后付费，即按量计费。
AppId 是 否 Uint64 用户AppId。
DiskType 是 是 String 云盘介质类型。取值范围：<br><li>CLOUD_BASIC：表示普通云硬<br><li>CLOUD_PREMIUM：表示高性能云硬盘<br><li>CLOUD_SSD：SSD表示SSD云硬盘。
BackupIdSet 是 否 Array of String 云硬盘的备份ID列表。
DiskCreateTime 是 是 String 云硬盘创建时间。
DiskState 是 是 String 云盘状态。取值范围：<br><li>UNATTACHED：未挂载<br><li>ATTACHING：挂载中<br><li>ATTACHED：已挂载<br><li>DETACHING：解挂中<br><li>EXPANDING：扩容中<br><li>ROLLBACKING：回滚中<br><li>DELETED：已删除。
DiskSize 是 是 Uint64 云硬盘大小，单位GB。
ModifyTime 是 否 Datetime 最新修改时间。
DiskUsage 是 是 String 云硬盘类型。取值范围：<br><li>SYSTEM_DISK：系统盘<br><li>DATA_DISK：数据盘。
CreateTime 是 否 Datetime 云硬盘当前存在的最早备份的时间。
DiskId 是 否 String 云盘ID。

Placement

描述了实例的抽象位置，包括其所在的可用区，所属的项目

被如下接口引用：CreateDisksWithBackup、DescribeBackupDisks、DescribeBackups、DescribeCfsBackups、RunInstancesWithBackupGroup

名称 必选 允许NULL 类型 描述
Zone 是 否 String 所属的可用区ID。该参数也可以通过调用DescribeZones的返回值中的Zone字段来获取。
ProjectId 否 否 Uint64 实例所属项目ID。该参数可以通过调用 DescribeProject 的返回值中的 projectId 字段来获取。不填为默认项目。
CdcId 否 是 String 实例所属的独享集群ID。作为入参时，表示对指定的CdcId独享集群的资源进行操作，可为空。 作为出参时，表示资源所属的独享集群的ID，可为空。
CageId 否 是 String 围笼Id。作为入参时，表示对指定的CageId的资源进行操作，可为空。 作为出参时，表示资源所属围笼ID，可为空。
CdcName 否 是 String 独享集群名字。作为入参时，忽略。作为出参时，表示云硬盘所属的独享集群名，可为空。
ProjectName 否 是 String 项目名称

VirtualPrivateCloud

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

被如下接口引用：RunInstancesWithBackupGroup

名称 必选 允许NULL 类型 描述
VpcId 是 否 String 私有网络ID，形如vpc-xxxxxxx。
SubnetId 是 否 String 私有网络子网ID，形如subnet-xxxxxxx。
AsVpcGateway 否 否 Bool 是否用作公网网关。公网网关只有在实例拥有公网IP以及处于私有网络下时才能正常使用。取值范围：<br><li>TRUE：表示用作公网网关<br><li>FALSE：表示不用作公网网关<br><br>默认取值：FALSE。
PrivateIpAddresses 否 否 Array of String 私有网络子网 IP 数组，在创建实例、修改实例vpc属性操作中可使用此参数。当前仅批量创建多台实例时支持传入相同子网的多个 IP。
Ipv6AddressCount 否 否 Int64 为弹性网卡指定随机生成的 IPv6 地址数量。

OverviewDetail

资源概览详情

被如下接口引用：DescribeBackupResourceOverview

名称 必选 允许NULL 类型 描述
BackupOverview 否 否 BackupOverview 备份资源概览
Region 否 否 String 地域

BackupInstance

描述实例的备份信息。

被如下接口引用：DescribeBackupInstances

名称 必选 允许NULL 类型 描述
AutoBackupPolicyIdSet 是 否 Array of String 实例绑定的定期备份策略列表。
InstanceId 是 否 String 实例ID。
AppId 是 否 Uint64 用户AppId。
LatestBackupTime 是 否 Datetime 实例最新备份时间。
BackupGroupIdSet 是 否 Array of String 实例的备份组ID列表。
ModifyTime 是 否 Datetime 修改时间。
CreateTime 是 否 Datetime 实例当前存在的最早备份的时间。

BackupOverview

备份资源概览

被如下接口引用：DescribeBackupResourceOverview

名称 必选 允许NULL 类型 描述
BackupDiskCount 否 否 Uint64 备份云硬盘个数
BackupDiskSizeMb 否 否 Uint64 备份云硬盘容量(MiB)
BackupInstanceCount 否 否 Uint64 备份云主机个数
BackupInstanceSizeMb 否 否 Uint64 备份云主机容量(MiB)
BackupFileSystemCount 否 否 Uint64 备份文件系统数量。
BackupFileSystemSizeMb 否 否 Uint64 备份文件系统容量(MiB)。