租户端存储云硬盘（CBS）数据结构

数据结构

最近更新时间: 2024-12-21 13:01:31

SnapshotCopyResult

描述快照跨地域复制的结果。

被如下接口引用：CopySnapshotCrossRegions

名称	必选	允许NULL	类型	描述
DestinationRegion	是	否	String	跨地复制的目标地域。示例值：
SnapshotId	是	否	String	复制到目标地域的新快照ID。示例值：

DiskConfigSet

云盘配置

被如下接口引用：DescribeZoneDiskConfigInfos

名称	必选	允许NULL	类型	描述
DiskUsage	是	否	String	系统盘或数据盘示例值：
DiskType	是	否	String	CLOUD_BASIC、CLOUD_PREMIUM、CLOUD_SSD 示例值：
DiskSize	是	否	Int64	云盘大小示例值：
SnapshotId	否	否	String	快照ID 示例值：

Image

快照关联的镜像

被如下接口引用：DescribeDiskAssociatedSnapshots、DescribeSnapshotGroups、DescribeSnapshots、DescribeSnapshotsInternal

名称	必选	允许NULL	类型	描述
ImageId	是	是	String	镜像实例ID。示例值：
ImageName	是	是	String	镜像名称。示例值：

Price

描述了云盘的价格

被如下接口引用：InquirePriceModifyDiskExtraPerformance、InquiryPriceCreateDisks、InquiryPriceCreateSnapshots、InquiryPriceModifyDiskAttributes、InquiryPriceRenewDisks、InquiryPriceResizeDisk

名称	必选	允许NULL	类型	描述
OriginalPrice	否	是	Float	预支费用的原价，单位：元。示例值：
DiscountPrice	否	是	Float	预支费用的折扣价，单位：元。示例值：
UnitPriceDiscount	否	是	Float	后付费云盘折扣单价，单位：元。示例值：
UnitPrice	否	是	Float	后付费云盘原单价，单位：元。示例值：
UnitPriceHigh	否	是	String	高精度后付费云盘原单价, 单位：元示例值：
OriginalPriceHigh	否	是	String	高精度预付费云盘预支费用的原价, 单位：元。示例值：
DiscountPriceHigh	否	是	String	高精度预付费云盘预支费用的折扣价, 单位：元示例值：
UnitPriceDiscountHigh	否	是	String	高精度后付费云盘折扣单价, 单位：元示例值：
ChargeUnit	否	是	String	后付费云盘的计价单元，取值范围： HOUR：表示后付费云盘的计价单元是按小时计算。示例值：
DetailPrices	否	是	Array of DetailPrice	计费项目明细列表。示例值：查看

Snapshot

描述了快照的详细信息

被如下接口引用：DescribeDiskAssociatedSnapshots、DescribeSnapshots、DescribeSnapshotsInternal

名称	必选	允许NULL	类型	描述
SnapshotId	否	否	String	快照ID。示例值：
Placement	否	否	Placement	快照所在的位置。示例值：查看
DiskUsage	否	否	String	创建此快照的云硬盘类型。取值范围： SYSTEM_DISK：系统盘 DATA_DISK：数据盘。示例值：
DiskId	否	否	String	创建此快照的云硬盘ID。示例值：
DiskSize	否	否	Uint64	创建此快照的云硬盘大小。示例值：
SnapshotState	否	否	String	快照的状态。取值范围： NORMAL：正常 CREATING：创建中 ROLLBACKING：回滚中 COPYING_FROM_REMOTE：跨地域复制快照拷贝中。示例值：
SnapshotName	否	否	String	快照名称，用户自定义的快照别名。调用ModifySnapshotAttribute可修改此字段。示例值：
Percent	否	否	Uint64	快照创建进度百分比，快照创建成功后此字段恒为100。示例值：
CreateTime	否	否	String	快照的创建时间。示例值：
DeadlineTime	否	否	String	快照到期时间。如果快照为永久保留，此字段为空。示例值：
Encrypt	否	否	Bool	是否为加密盘创建的快照。取值范围： true：该快照为加密盘创建的 false:非加密盘创建的快照。示例值：
IsPermanent	否	否	Bool	是否为永久快照。取值范围： true：永久快照 false：非永久快照。示例值：
CopyingToRegions	是	是	Array of String	快照正在跨地域复制的目的地域，默认取值为[]。示例值：
CopyFromRemote	是	是	Bool	是否为跨地域复制的快照。取值范围： true：表示为跨地域复制的快照。 false:本地域的快照。示例值：
Images	是	是	Array of Image	快照关联的镜像列表。示例值：查看
ImageCount	是	是	Uint64	快照关联的镜像个数。示例值：
SnapshotType	是	是	String	快照类型，目前该项取值可以为PRIVATE_SNAPSHOT或者SHARED_SNAPSHOT 示例值：
ShareReference	是	是	Uint64	快照当前被共享数示例值：
Tags	否	是	Array of Tag	快照的标签列表。示例值：查看
PlatformProjectId	否	是	String	快照的TCE项目ID。示例值：
EncryptAlgorithm	否	是	String	加密算法。示例值：
SavePlaceName	否	是	String	快照存储位置示例值：
SnapFormat	否	是	String	快照格式的类型。取值范围: {"RAW", "QCOW2"}。示例值：
SnapSize	否	是	Uint64	快照大小示例值：
CopyFromBackupDetail	否	是	CopyFromBackupDetail	由备份复制过来的快照，获取对应备份的信息示例值：查看

DiskConfig

云盘配置。

被如下接口引用：DescribeDiskConfigQuota

名称	必选	允许NULL	类型	描述
Available	否	否	Bool	配置是否可用。示例值：
DiskType	否	否	String	云盘介质类型。取值范围： CLOUD_BASIC：表示普通云硬盘 CLOUD_PREMIUM：表示高性能云硬盘 CLOUD_SSD：SSD表示SSD云硬盘。示例值：
DiskUsage	否	否	String	云盘类型。取值范围： SYSTEM_DISK：表示系统盘 DATA_DISK：表示数据盘。示例值：
DiskChargeType	否	否	String	付费模式。取值范围： PREPAID：表示预付费，即包年包月 POSTPAID_BY_HOUR：表示后付费，即按量计费。示例值：
MaxDiskSize	否	否	Uint64	最大可配置云盘大小。示例值：
MinDiskSize	否	否	Uint64	最小可配置云盘大小。示例值：
Zone	否	否	String	所在可用区。示例值：
DeviceClass	否	是	String	实例机型。示例值：
InstanceFamily	否	是	String	实例机型系列。详见实例类型示例值：
StepSize	是	是	Uint64	步长示例值：
ExtraPerformanceRange	否	是	Array of Int64	额外的性能区间。示例值：
RecommendDiskSize	否	是	Uint64	当前类型云硬盘的推荐大小，单位GB。示例值：

Disk

描述了云硬盘的详细信息

被如下接口引用：DescribeDisks

名称	必选	允许NULL	类型	描述
DiskId	否	否	String	云硬盘ID。示例值：
DiskUsage	否	否	String	云硬盘类型。取值范围： SYSTEM_DISK：系统盘 DATA_DISK：数据盘。示例值：
DiskChargeType	否	否	String	付费模式。取值范围： PREPAID：预付费，即包年包月 POSTPAID_BY_HOUR：后付费，即按量计费。示例值：
Portable	否	否	Bool	是否为弹性云盘，false表示非弹性云盘，true表示弹性云盘。示例值：
Placement	否	否	Placement	云硬盘所在的位置。示例值：查看
SnapshotAbility	否	否	Bool	云盘是否具备创建快照的能力。取值范围： false表示不具备 true表示具备。示例值：
DiskName	否	否	String	云硬盘名称。示例值：
DiskSize	否	否	Uint64	云硬盘大小。示例值：
DiskState	否	否	String	云盘状态。取值范围： UNATTACHED：未挂载 ATTACHING：挂载中 ATTACHED：已挂载 DETACHING：解挂中 EXPANDING：扩容中 ROLLBACKING：回滚中。示例值：
DiskType	否	否	String	云盘介质类型。取值范围： CLOUD_BASIC：表示普通云硬 CLOUD_PREMIUM：表示高性能云硬盘 CLOUD_SSD：SSD表示SSD云硬盘。示例值：
Attached	否	否	Bool	云盘是否挂载到云主机上。取值范围： false:表示未挂载 true:表示已挂载。示例值：
InstanceId	否	否	String	云硬盘挂载的云主机ID。示例值：
CreateTime	否	否	String	云硬盘的创建时间。示例值：
DeadlineTime	否	否	String	云硬盘的到期时间。示例值：
Rollbacking	否	否	Bool	云盘是否处于快照回滚状态。取值范围： false:表示不处于快照回滚状态 true:表示处于快照回滚状态。示例值：
RollbackPercent	否	否	Uint64	云盘快照回滚的进度。示例值：
Encrypt	否	否	Bool	云盘是否为加密盘。取值范围： false:表示非加密盘 true:表示加密盘。示例值：
AutoRenewFlagError	否	否	Bool	云盘已挂载到子机，且子机与云盘都是包年包月。 true：子机设置了自动续费标识，但云盘未设置 false：云盘自动续费标识正常。示例值：
RenewFlag	否	否	String	自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费。示例值：
DeadlineError	否	否	Bool	在云盘已挂载到实例，且实例与云盘都是包年包月的条件下，此字段才有意义。 true:云盘到期时间早于实例。 false：云盘到期时间晚于实例。示例值：
IsReturnable	否	是	Bool	判断预付费的云盘是否支持主动退还。 true:支持主动退还 false:不支持主动退还。示例值：
ReturnFailCode	否	是	Uint64	预付费云盘在不支持主动退还的情况下，该参数表明不支持主动退还的具体原因。取值范围： 1：云硬盘已经退还 2：云硬盘已过期 3：云盘不支持退还 8：超过可退还数量的限制。示例值：
AutoSnapshotPolicyIds	否	是	Array of String	云盘关联的定期快照ID。只有在调用DescribeDisks接口时，入参ReturnBindAutoSnapshotPolicy取值为TRUE才会返回该参数。示例值：
Tags	是	是	Array of Tag	与云盘绑定的标签，云盘未绑定标签则取值为空。示例值：查看
DeleteWithInstance	是	是	Bool	云盘是否与挂载的实例一起销毁。 true:销毁实例时会同时销毁云盘，只支持按小时后付费云盘。 false：销毁实例时不销毁云盘。示例值：
DifferDaysOfDeadline	是	是	Int64	当前时间距离盘到期的天数（仅对预付费盘有意义）。示例值：
Migrating	是	是	Bool	云盘是否处于类型变更中。取值范围： false:表示云盘不处于类型变更中 true:表示云盘已发起类型变更，正处于迁移中。示例值：
MigratePercent	是	是	Uint64	云盘类型变更的迁移进度，取值0到100。示例值：
Shareable	是	是	Bool	云盘是否为共享型云盘。示例值：
InstanceIdList	是	是	Array of String	对于非共享型云盘，该参数为空数组。对于共享型云盘，则表示该云盘当前被挂载到的CVM实例InstanceId 示例值：
SnapshotCount	是	是	Int64	云盘拥有的快照总数。示例值：
SnapshotSize	是	是	Uint64	云盘拥有的快照总容量，单位为MB。示例值：
PlatformProjectId	是	是	String	项目ID 示例值：
BackupDisk	是	是	Bool	云硬盘因欠费销毁或者到期销毁时，是否使用快照备份数据的标识。true表示销毁时创建快照进行数据备份。false表示直接销毁，不进行数据备份。示例值：
InstanceType	是	是	String	盘挂载的子机机型示例值：
DiskStoragePoolGroup	是	是	String	盘所属的资源池示例值：
LatestOperationRequestId	是	是	String	最后一次执行的异步任务对应的API RequestId 示例值：
ThroughputPerformance	是	是	Uint64	云硬盘额外性能值，单位MB/s。示例值：
LatestOperation	是	是	String	最后一次执行的异步任务操作。示例值：
LastAttachInsId	是	是	String	云盘最后挂载的云服务器ID 示例值：
LatestOperationState	是	是	String	最后一次执行的异步任务执行结果。示例值：
DeleteSnapshot	是	是	Int64	销毁云盘时删除关联的非永久保留快照。0 表示非永久快照不随云盘销毁而销毁，1表示非永久快照随云盘销毁而销毁，默认取0。快照是否永久保留可以通过DescribeSnapshots接口返回的快照详情的IsPermanent字段来判断，true表示永久快照，false表示非永久快照。示例值：
ErrorPrompt	是	是	String	出错时返回给用户的操作提示示例值：
EncryptAlgorithm	是	是	String	加密算法类型。SM4:国密；AES256:非国密示例值：
DiskBackupQuota	否	是	Uint64	云硬盘备份点配额。表示最大可以保留的备份点数量。示例值：
DiskBackupCount	否	是	Uint64	云硬盘备份点已使用的数量。示例值：
BurstPerformance	否	是	Bool	云盘是否开启性能突发示例值：

GoodsDetail

产品详情。

被如下接口引用：SwitchParameterCreateDisks、SwitchParameterRenewDisks、SwitchParameterResizeDisk

名称	必选	允许NULL	类型	描述
TimeSpan	否	否	Uint64	购买或续费云盘的时长。示例值：
Pid	否	否	Uint64	产品ID。示例值：
DiskType	否	否	String	云盘类型，系统盘或数据盘。示例值：
ProductInfo	否	否	Array of ProductInfo	产品信息描述。示例值：查看
MediumType	否	否	String	云盘介质类型。示例值：
TimeUnit	否	否	String	时长“TimeSpan”的单位。示例值：
CbsSize	否	否	Uint64	云盘大小。示例值：

CopyFromBackupDetail

由备份复制过来的快照，获取对应备份的信息

被如下接口引用：DescribeDiskAssociatedSnapshots、DescribeSnapshots、DescribeSnapshotsInternal

名称	必选	允许NULL	类型	描述
BackupGroupId	是	是	String	备份组ID 示例值：
CreateTime	是	是	Datetime	备份创建的时间示例值：
BackupDiskId	是	是	String	备份磁盘ID 示例值：
BackupId	是	是	String	备份ID，表示备份的唯一标识符示例值：

SnapshotDeniedAction

单个快照的操作掩码

被如下接口引用：DescribeSnapshotsDeniedActions

名称	必选	允许NULL	类型	描述
SnapshotId	是	否	String	根据快照ID 示例值：
DeniedActions	是	否	Array of DeniedAction	具体的快照的操作掩码信息示例值：查看

ResourcesDetail

描述用户的资源详情。

被如下接口引用：DescribeUserDiskResources

名称	必选	允许NULL	类型	描述
Region	是	否	String	资源所在地域。示例值：
SnapshotNumberTotal	是	否	Uint64	快照用户数量配额。示例值：
SnapshotNumberUsed	是	否	Uint64	已使用的快照数量。示例值：
SnapshotCapacityTotal	是	否	Uint64	快照容量配额。示例值：
SnapshotCapacityUsed	是	否	Uint64	已使用的快照容量，单位GB。示例值：
DiskNumber	是	否	Int64	云盘数量。示例值：
NewDiskFlag	是	否	Bool	当前地域是否包含新购买的云盘。示例值：
SnapshotSupportCrossCopy	是	否	Bool	当前地域是否支持跨地域复制示例值：
DiskNumberIsolated	是	否	Uint64	回收站内的云盘数量。示例值：

DedicatedClusterDiskStatistic

CDC 独享集群云硬盘统计信息。

被如下接口引用：DescribeDedicatedClusterDiskStatistics

名称	必选	允许NULL	类型	描述
DiskType	是	否	String	硬盘介质类型。示例值：
TotalDiskSize	是	否	Uint64	云硬盘总容量。示例值：
UsedDiskSize	是	否	Uint64	已使用的云硬盘容量。示例值：
AvailableDiskSize	是	否	Uint64	可用的云硬盘容量。示例值：

DiskResizeConfig

云盘扩容配置，用于SwitchParameterResizeDisk接口出参。

被如下接口引用：SwitchParameterModifyDiskAttributes

名称	必选	允许NULL	类型	描述
Pid	是	否	Uint64	产品ID。示例值：
CbsSize	是	否	Uint64	云盘大小。示例值：
MediumType	是	否	String	云盘介质类型。示例值：

Policy

描述了定期快照的执行策略

被如下接口引用：CreateAutoSnapshotPolicy、DescribeAutoSnapshotPolicies、DescribeCopyAutoSnapshotPolicy、DescribeDiskAssociatedAutoSnapshotPolicy、ModifyAutoSnapshotPolicyAttribute

名称	必选	允许NULL	类型	描述
DayOfWeek	否	否	Array of Uint64	选定周一到周日中需要创建快照的日期，取值范围：[0, 6]。0表示周一触发，依此类推。示例值：
Hour	是	否	Array of Uint64	指定定期快照策略的触发时间。单位为小时，取值范围：[0, 23]。00:00 ~ 23:00 共 24 个时间点可选，1表示 01:00，依此类推。示例值：
IntervalDays	否	否	Uint64	指定创建定期快照的间隔天数，取值范围：[1, 365]，例如设置为5，则间隔5天即触发定期快照创建。注：当选择按天备份时，理论上第一次备份的时间为备份策略创建当天。如果当天备份策略创建的时间已经晚于设置的备份时间，那么将会等到第二个备份周期再进行第一次备份。示例值：

SnapOverview

用户快照信息概览，包括已创建的快照的总数和总容量。

被如下接口引用：DescribeUserDiskResources

名称	必选	允许NULL	类型	描述
SnapshotCapacityUsedTotal	是	否	Float	用户已创建快照总容量。示例值：
SnapshotNumberUsedTotal	是	否	Int64	用户已创建快照总个数。示例值：

Filters

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

被如下接口引用：DescribeDiskStoragePoolGroups

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

BlockStorage

描述块存储的详细信息。

被如下接口引用：DescribeBlockStorages

名称	必选	允许NULL	类型	描述
DiskId	是	否	String	块存储ID。示例值：
DiskName	是	否	String	块存储名称。示例值：
DiskSize	是	否	Uint64	块存储大小，单位GB。示例值：
DiskType	是	否	String	块存储介质类型。取值范围： CLOUD_BASIC CLOUD_PREMIUM CLOUD_SSD CLOUD_ENHANCEDSSD LOCAL_BASIC LOCAL_SSD 示例值：
DiskUsage	是	否	String	块存储类型。取值范围： SYSTEM_DISK：系统盘 DATA_DISK：数据盘。示例值：
InstanceId	是	是	String	块存储挂载的实例ID。示例值：
InstanceName	是	否	String	块存储挂载的实例名称。示例值：

DiskOrder

请求计费的订单参数。

被如下接口引用：SwitchParameterCreateDisks、SwitchParameterRenewDisks、SwitchParameterResizeDisk

名称	必选	允许NULL	类型	描述
GoodsCategoryId	否	否	Uint64	产品类别。示例值：
GoodsNum	否	否	Uint64	产品数量。示例值：
ProjectId	否	否	Uint64	项目ID。示例值：
GoodsDetail	否	否	GoodsDetail	产品详情。示例值：查看
RegionId	否	否	Uint64	地域ID。示例值：
ZoneId	否	否	Uint64	可用区ID。示例值：
PayMode	否	否	Uint64	付费模式。示例值：
Type	否	否	String	云盘类别。示例值：

ZoneInfo

可用区信息

被如下接口引用：

名称	必选	允许NULL	类型	描述
Zone	是	否	String	可用区名称，例如，ap-guangzhou-3 示例值：
ZoneName	是	否	String	可用区描述，例如，广州三区示例值：
ZoneId	是	否	String	可用区ID 示例值：
ZoneState	是	否	String	可用区状态示例值：

ProductInfo

描述订单参数转换接口输出的产品信息。

被如下接口引用：SwitchParameterCreateDisks、SwitchParameterModifyDiskAttributes、SwitchParameterRenewDisks、SwitchParameterResizeDisk

名称	必选	允许NULL	类型	描述
Name	是	否	String	属性名称。示例值：
Value	是	否	String	属性值。示例值：

ResizeDiskOrder

请求计费的订单参数（扩容）。

被如下接口引用：SwitchParameterModifyDiskAttributes

名称	必选	允许NULL	类型	描述
GoodsCategoryId	是	否	Uint64	产品类别。示例值：
GoodsNum	是	否	Uint64	产品数量。示例值：
ProjectId	是	否	Uint64	项目ID。示例值：
GoodsDetail	是	否	ResizeGoodsDetail	产品详情。示例值：查看
RegionId	是	否	Uint64	地域ID。示例值：
ZoneId	是	否	Uint64	可用区ID。示例值：
PayMode	是	否	Uint64	付费模式。示例值：
Type	是	是	String	云盘类别。示例值：
SubProductCode	是	是	String	子产品ID。示例值：

AdvancedRetentionPolicy

快照高级保留策略

被如下接口引用：CreateAutoSnapshotPolicy、DescribeAutoSnapshotPolicies、DescribeCopyAutoSnapshotPolicy、DescribeDiskAssociatedAutoSnapshotPolicy、ModifyAutoSnapshotPolicyAttribute

名称	必选	允许NULL	类型	描述
Days	否	是	Uint64	保留Days天内的每天最新的一个快照示例值：
Weeks	否	是	Uint64	保留Weeks周内的每周最新的一个快照示例值：
Months	否	是	Uint64	保留Months月内的每月最新的一个快照示例值：
Years	否	是	Uint64	保留Years年内的每年最新的一个快照示例值：

Tag

标签。

被如下接口引用：CreateDisks、CreateSnapshot、DescribeAutoSnapshotPolicies、DescribeCopyAutoSnapshotPolicy、DescribeDiskAssociatedAutoSnapshotPolicy、DescribeDiskAssociatedSnapshots、DescribeDisks、DescribeSnapshotGroups、DescribeSnapshots、DescribeSnapshotsInternal、SwitchParameterCreateDisks

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

DetailPrice

描述预付费或后付费云盘的价格。

名称	必选	允许NULL	类型	描述
PriceTitle	否	是	String	描述计费项目名称。示例值：
PriceName	否	是	String	描述计费项目显示名称，用户控制台展示。示例值：
OriginalPrice	否	是	Float	预付费云盘预支费用的原价，单位：元。示例值：
DiscountPrice	否	是	Float	预付费云盘预支费用的折扣价，单位：元。示例值：
UnitPrice	否	是	Float	后付费云盘原单价，单位：元。示例值：
UnitPriceDiscount	否	是	Float	后付费云盘折扣单价，单位：元。示例值：
ChargeUnit	否	是	String	后付费云盘的计价单元，取值范围：HOUR：表示后付费云盘的计价单元是按小时计算。示例值：
OriginalPriceHigh	否	是	String	高精度预付费云盘预支费用的原价，单位：元。示例值：
DiscountPriceHigh	否	是	String	高精度预付费云盘预支费用的折扣价，单位：元。示例值：
UnitPriceHigh	否	是	String	高精度后付费云盘原单价，单位：元。示例值：
UnitPriceDiscountHigh	否	是	String	高精度后付费云盘折扣单价，单位：元。示例值：

Filter

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

被如下接口引用：DescribeAutoSnapshotPolicies、DescribeCopyAutoSnapshotPolicy、DescribeDisks、DescribeSnapshotGroups、DescribeSnapshots、DescribeSnapshotsInternal

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

Placement

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

被如下接口引用：CreateDisks、DescribeDiskAssociatedSnapshots、DescribeDisks、DescribeSnapshots、DescribeSnapshotsInternal、InquiryPriceCreateSnapshots、SwitchParameterCreateDisks

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

ResizeGoodsDetail

产品续费详情，只用于SwitchParameterResizeDisks接口。

被如下接口引用：SwitchParameterModifyDiskAttributes

名称	必选	允许NULL	类型	描述
Pid	是	否	Uint64	产品ID。示例值：
ResourceId	是	否	String	云盘ID。示例值：
CurDeadline	是	否	String	云盘当前到期时间。示例值：
ProductInfo	是	否	Array of ProductInfo	产品信息描述。示例值：查看
NewConfig	是	否	DiskResizeConfig	云盘扩容后的配置。示例值：查看
OldConfig	是	否	DiskResizeConfig	云盘扩容前的配置。示例值：查看

DiskOverview

用户云硬盘信息概览，包括云硬盘总数，已过期云硬盘数，7天内将到期云硬盘数。

被如下接口引用：DescribeUserDiskResources

名称	必选	允许NULL	类型	描述
DiskNumberTotal	是	否	Int64	用户云硬盘总数。示例值：
ExpiredNumberTotal	是	否	Int64	用户已过期云硬盘总数。示例值：
DiskNumberExpireIn7days	是	否	Int64	用户7天内将到期云硬盘总数示例值：

AutoSnapshotPolicy

描述了定期快照策略的详细信息

被如下接口引用：DescribeAutoSnapshotPolicies、DescribeCopyAutoSnapshotPolicy、DescribeDiskAssociatedAutoSnapshotPolicy

名称	必选	允许NULL	类型	描述
AutoSnapshotPolicyId	否	否	String	定期快照策略ID。示例值：
AutoSnapshotPolicyName	否	否	String	定期快照策略名称。示例值：
AutoSnapshotPolicyState	否	否	String	定期快照策略的状态。取值范围： NORMAL：正常 ISOLATED：已隔离。示例值：
IsActivated	否	否	Bool	定期快照策略是否激活。示例值：
IsPermanent	否	否	Bool	使用该定期快照策略创建出来的快照是否永久保留。示例值：
RetentionDays	否	否	Uint64	使用该定期快照策略创建出来的快照保留天数。示例值：
CreateTime	否	否	Datetime	定期快照策略的创建时间。示例值：
NextTriggerTime	否	否	Datetime	定期快照下次触发的时间。示例值：
Policy	否	否	Array of Policy	定期快照的执行策略。示例值：查看
DiskIdSet	否	否	Array of String	已绑定当前定期快照策略的云盘ID列表。示例值：
IsCopyToRemote	是	是	Uint64	是否跨账号复制快照示例值：
CopyFromAccountUin	是	是	String	源账号uin 示例值：
CopyToAccountUin	是	是	String	目的账号uin 示例值：
InstanceIdSet	否	否	Array of String	已绑定当前定期快照策略的实例列表。示例值：
RetentionMonths	否	否	Uint64	该定期快照策略创建的快照最大保留月数示例值：
RetentionAmount	否	否	Uint64	该定期快照策略创建的快照最大保留数量示例值：
AdvancedRetentionPolicy	否	是	AdvancedRetentionPolicy	快照高级保留策略示例值：查看
IsCrossRegion	否	是	Bool	该定期快照策略是否启用跨地域快照复制。示例值：
Tags	否	是	Array of Tag	标签。示例值：查看
CrossRegionRetentionDays	否	是	Int64	通过该定期快照策略创建的跨地域快照保留天数，默认保留7天，该参数不可与CrossRegionIsPermanent参数冲突。示例值：
CrossRegionIsPermanent	否	是	Bool	通过该定期快照策略创建的跨地域快照是否永久保留，默认为0，表示非永久保留示例值：

SnapshotGroup

描述快照组详情

被如下接口引用：DescribeSnapshotGroups

名称	必选	允许NULL	类型	描述
SnapshotGroupId	是	否	String	快照组ID 示例值：
SnapshotGroupType	是	是	String	快照组类型。NORMAL: 普通快照组，非一致性快照示例值：
ContainRootSnapshot	是	是	Bool	快照组是否包含系统盘快照示例值：
SnapshotIdSet	是	是	Array of String	快照组包含的快照ID列表示例值：
SnapshotGroupState	是	是	String	快照组状态。 NORMAL: 正常 CREATING:创建中 DELETED:已删除 FAILED:创建失败 DISMISS:已解散 ROLLBACKING:回滚中示例值：
Percent	是	是	Uint64	快照组创建进度示例值：
CreateTime	是	是	String	创建时间示例值：
ModifyTime	是	是	String	最新修改时间示例值：
Images	是	是	Array of Image	快照组关联的镜像列表示例值：查看
SnapshotGroupName	是	是	String	快照组名称示例值：
ImageCount	是	是	Uint64	快照组关联的镜像数量示例值：
LatestOperationState	是	是	String	最后一次执行的异步任务执行结果示例值：
LatestOperationRequestId	是	是	String	最后一次执行的异步任务对应的API RequestId 示例值：
LatestOperation	是	是	String	最后一次执行的异步任务操作示例值：
OperationFailedResourceIdSet	是	是	Array of String	最后一次异步任务操作失败的资源列表示例值：
OperationSuccessResourceIdSet	是	是	Array of String	最后一次异步操作成功的资源列表示例值：
ErrorPrompt	是	是	String	最后一次异步操作结果的提示码示例值：
IsPermanent	否	是	Bool	跨地域复制的快照是否永久保留，默认为True，表示永久保留。目前只对由ASP自动发起复制的快照有效，由用户主动发起的默认永久保留。示例值：
DeadlineTime	否	是	Datetime_iso	截止时间示例值：
Tags	否	是	Tag	标签值示例值：查看

ApplyDisk

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

被如下接口引用：ApplySnapshotGroup

名称	必选	允许NULL	类型	描述
SnapshotId	是	否	String	快照ID 示例值：
DiskId	是	否	String	快照对应的原云硬盘ID 示例值：

DiskStoragePoolGroupInfo

云硬盘存储池组

被如下接口引用：DescribeDiskStoragePoolGroups

名称	必选	允许NULL	类型	描述
DiskStoragePoolGroupName	是	否	String	存储资源组名称示例值：
PoolBoundType	是	否	String	绑定类型示例值：
DiskStoragePoolGroup	是	否	String	存储资源池组示例值：
Zone	是	否	String	可用区示例值：
DiskType	是	否	String	云硬盘类型示例值：
Available	是	否	Bool	是否售罄示例值：
Message	是	否	String	售罄信息示例值：
PoolCustomAttributes	否	是	PoolCustomAttributes	描述资源池的cpu信息。示例值：查看

DiskDeniedAction

单个云硬盘的操作掩码

被如下接口引用：DescribeDisksDeniedActions

名称	必选	允许NULL	类型	描述
DiskId	是	否	String	云硬盘ID，比如"disk-7rf24jvb" 示例值：
DeniedActions	是	否	Array of DeniedAction	具体的云硬盘的操作掩码信息示例值：查看

AttachDetail

描述一个实例已挂载和可挂载数据盘的数量。

被如下接口引用：DescribeInstancesDiskNum

名称	必选	允许NULL	类型	描述
InstanceId	是	是	String	实例ID。示例值：
AttachedDiskCount	是	是	Uint64	实例已挂载数据盘的数量。示例值：
MaxAttachCount	是	是	Uint64	实例最大可挂载数据盘的数量。示例值：

DiskChargePrepaid

描述了实例的计费模式

被如下接口引用：CreateDisks、InquiryPriceCreateDisks、InquiryPriceCreateSnapshots、InquiryPriceRenewDisks、RenewDisk、SwitchParameterCreateDisks、SwitchParameterRenewDisks

名称	必选	允许NULL	类型	描述
Period	是	否	Uint64	购买云盘的时长，默认单位为月，此时，取值范围：1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。示例值：
RenewFlag	否	否	String	自动续费标识。取值范围： NOTIFY_AND_AUTO_RENEW：通知过期且自动续费 NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费 DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费默认取值：NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费。示例值：
CurInstanceDeadline	否	否	Datetime	需要将云盘的到期时间与挂载的子机对齐时，可传入该参数。该参数表示子机当前的到期时间，此时Period如果传入，则表示子机需要续费的时长，云盘会自动按对齐到子机续费后的到期时间续费。示例值：

DiskFeature

云硬盘产品支持的特性。

被如下接口引用：DescribeDiskSupportFeatures

名称	必选	允许NULL	类型	描述
TradeType	是	是	String	云硬盘使用的计费系统。取值范围： bmppro：计费系统 bmp：计量系统示例值：

SnapshotGroupDeniedAction

单个快照组的操作掩码

被如下接口引用：DescribeSnapshotGroupsDeniedActions

名称	必选	允许NULL	类型	描述
SnapshotGroupId	是	否	String	快照组ID 示例值：
DeniedActions	是	否	Array of DeniedAction	具体的快照的操作掩码信息示例值：查看

PoolCustomAttributes

描述用户资源池的自定义属性

被如下接口引用：DescribeDiskStoragePoolGroups

名称	必选	允许NULL	类型	描述
CpuArchitecture	否	是	Array of String	cpu架构。示例值：
CpuModel	否	是	Array of String	cpu型号。示例值：

SharePermission

快照分享信息集合

被如下接口引用：DescribeSnapshotSharePermission

名称	必选	允许NULL	类型	描述
CreatedTime	是	否	Datetime	快照分享的时间示例值：
AccountId	是	否	String	分享的账号Id 示例值：

DeniedAction

云硬盘不能执行的接口

被如下接口引用：DescribeDisksDeniedActions、DescribeSnapshotGroupsDeniedActions、DescribeSnapshotsDeniedActions

名称	必选	允许NULL	类型	描述
Action	是	否	String	不能操作接口名，比如查询云盘列表"DescribeDisks"，对于多用途的接口，会以"接口.入参"的形式返回。比如"ModifyDiskAttributes.DiskType" 示例值：
Message	是	否	String	接口不能操作的原因示例值：
Code	是	否	String	接口不能操作对应提示的错误码示例值：