数据结构
最近更新时间: 2024-09-03 18:49:47
AttachDetail
描述一个实例已挂载和可挂载数据盘的数量。
被如下接口引用:DescribeInstancesDiskNum
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| InstanceId | 是 | 是 | String | 实例ID。 |
| AttachedDiskCount | 是 | 是 | Uint64 | 实例已挂载数据盘的数量。 |
| MaxAttachCount | 是 | 是 | Uint64 | 实例最大可挂载数据盘的数量。 |
ProductInfo
描述订单参数转换接口输出的产品信息。
被如下接口引用:SwitchParameterCreateDisks、SwitchParameterModifyDiskAttributes、SwitchParameterRenewDisks、SwitchParameterResizeDisk
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Name | 是 | 否 | String | 属性名称。 |
| Value | 是 | 否 | String | 属性值。 |
Policy
描述了定期快照的执行策略
被如下接口引用:CreateAutoSnapshotPolicy、DescribeAutoSnapshotPolicies、DescribeDiskAssociatedAutoSnapshotPolicy、ModifyAutoSnapshotPolicyAttribute
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| DayOfWeek | 是 | 否 | Array of Uint64 | 选定周一到周日中需要创建快照的日期,取值范围:[0, 6]。0表示周一触发,依此类推。 |
| Hour | 是 | 否 | Array of Uint64 | 指定定期快照策略的触发时间。单位为小时,取值范围:[0, 23]。00:00 ~ 23:00 共 24 个时间点可选,1表示 01:00,依此类推。 |
GoodsDetail
产品详情。
被如下接口引用:SwitchParameterCreateDisks、SwitchParameterRenewDisks、SwitchParameterResizeDisk
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TimeSpan | 否 | 否 | Uint64 | 购买或续费云盘的时长。 |
| Pid | 否 | 否 | Uint64 | 产品ID。 |
| DiskType | 否 | 否 | String | 云盘类型,系统盘或数据盘。 |
| ProductInfo | 否 | 否 | Array of ProductInfo | 产品信息描述。 |
| MediumType | 否 | 否 | String | 云盘介质类型。 |
| TimeUnit | 否 | 否 | String | 时长“TimeSpan”的单位。 |
| CbsSize | 否 | 否 | Uint64 | 云盘大小。 |
SnapshotDeniedAction
单个快照的操作掩码
被如下接口引用:DescribeSnapshotsDeniedActions
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SnapshotId | 是 | 否 | String | 根据快照ID |
| DeniedActions | 是 | 否 | Array of DeniedAction | 具体的快照的操作掩码信息 |
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 | 后付费云盘的计价单元,取值范围:<br><li>HOUR:表示后付费云盘的计价单元是按小时计算。 |
ResizeGoodsDetail
产品续费详情,只用于SwitchParameterResizeDisks接口。
被如下接口引用:SwitchParameterModifyDiskAttributes
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Pid | 是 | 否 | Uint64 | 产品ID。 |
| ResourceId | 是 | 否 | String | 云盘ID。 |
| CurDeadline | 是 | 否 | String | 云盘当前到期时间。 |
| ProductInfo | 是 | 否 | Array of ProductInfo | 产品信息描述。 |
| NewConfig | 是 | 否 | DiskResizeConfig | 云盘扩容后的配置。 |
| OldConfig | 是 | 否 | DiskResizeConfig | 云盘扩容前的配置。 |
DeniedAction
云硬盘不能执行的接口
被如下接口引用:DescribeDisksDeniedActions、DescribeSnapshotGroupsDeniedActions、DescribeSnapshotsDeniedActions
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 不能操作接口名,比如查询云盘列表"DescribeDisks",对于多用途的接口,会以"接口.入参"的形式返回。比如"ModifyDiskAttributes.DiskType" |
| Message | 是 | 否 | String | 接口不能操作的原因 |
| Code | 是 | 否 | String | 接口不能操作对应提示的错误码 |
Image
快照关联的镜像
被如下接口引用:DescribeDiskAssociatedSnapshots、DescribeSnapshotGroups、DescribeSnapshots
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| ImageId | 是 | 是 | String | 镜像实例ID。 |
| ImageName | 是 | 是 | String | 镜像名称。 |
DiskResizeConfig
云盘扩容配置,用于SwitchParameterResizeDisk接口出参。
被如下接口引用:SwitchParameterModifyDiskAttributes
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Pid | 是 | 否 | Uint64 | 产品ID。 |
| CbsSize | 是 | 否 | Uint64 | 云盘大小。 |
| MediumType | 是 | 否 | String | 云盘介质类型。 |
DiskConfig
云盘配置。
被如下接口引用:DescribeDiskConfigQuota
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Available | 否 | 是 | Bool | 配置是否可用。 |
| DiskType | 否 | 是 | String | 云盘介质类型。取值范围:<br><li>CLOUD_BASIC:表示普通云硬盘<br><li>CLOUD_PREMIUM:表示高性能云硬盘<br><li>CLOUD_SSD:SSD表示SSD云硬盘。 |
| DiskUsage | 否 | 是 | String | 云盘类型。取值范围:<br><li>SYSTEM_DISK:表示系统盘<br><li>DATA_DISK:表示数据盘。 |
| DiskChargeType | 否 | 是 | String | 付费模式。取值范围:<br><li>PREPAID:表示预付费,即包年包月<br><li>POSTPAID_BY_HOUR:表示后付费,即按量计费。 |
| MaxDiskSize | 否 | 是 | Uint64 | 最大可配置云盘大小。 |
| MinDiskSize | 否 | 是 | Uint64 | 最小可配置云盘大小。 |
| Zone | 否 | 是 | String | 所在可用区。 |
| DeviceClass | 否 | 是 | String | 实例机型。 |
| InstanceFamily | 否 | 是 | String | 实例机型系列。详见实例类型 |
| StepSize | 否 | 是 | Uint64 | 步长 |
| ExtraPerformanceRange | 否 | 是 | Array of Int64 | 额外的性能区间。 |
SnapOverview
用户快照信息概览,包括已创建的快照的总数和总容量。
被如下接口引用:DescribeUserDiskResources
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SnapshotCapacityUsedTotal | 是 | 否 | Float | 用户已创建快照总容量。 |
| SnapshotNumberUsedTotal | 是 | 否 | Int64 | 用户已创建快照总个数。 |
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 | 自动续费标识。取值范围:<br><li>NOTIFY_AND_AUTO_RENEW:通知过期且自动续费<br><li>NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费<br><li>DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费<br><br>默认取值:NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费。 |
| CurInstanceDeadline | 否 | 否 | Datetime | 需要将云盘的到期时间与挂载的子机对齐时,可传入该参数。该参数表示子机当前的到期时间,此时Period如果传入,则表示子机需要续费的时长,云盘会自动按对齐到子机续费后的到期时间续费。 |
Filters
描述键值对过滤器,用于条件过滤查询。
被如下接口引用:DescribeDiskStoragePoolGroups
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Name | 是 | 否 | String | 过滤键的名称。 |
| Values | 是 | 否 | Array of String | 一个或者多个过滤值。 |
Tag
标签。
被如下接口引用:CreateDisks、CreateSnapshot、DescribeDiskAssociatedSnapshots、DescribeDisks、DescribeSnapshots、SwitchParameterCreateDisks
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Key | 是 | 否 | String | 标签健。 |
| Value | 是 | 否 | 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 | 云盘类别。 |
DiskStoragePoolGroupInfo
云硬盘存储池组
被如下接口引用:DescribeDiskStoragePoolGroups
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| DiskStoragePoolGroupName | 是 | 否 | String | 存储资源组名称 |
| PoolBoundType | 是 | 否 | String | 绑定类型 |
| DiskStoragePoolGroup | 是 | 否 | String | 存储资源池组 |
| Zone | 是 | 否 | String | 可用区 |
| DiskType | 是 | 否 | String | 云硬盘类型 |
| Available | 是 | 否 | Bool | 是否售罄 |
| Message | 是 | 否 | String | 售罄信息 |
| PoolCustomAttributes | 否 | 是 | PoolCustomAttributes | 描述资源池的cpu信息。 |
Filter
描述键值对过滤器,用于条件过滤查询。
被如下接口引用:DescribeAutoSnapshotPolicies、DescribeDisks、DescribeSnapshotGroups、DescribeSnapshots
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Name | 是 | 否 | String | 过滤键的名称。 |
| Values | 是 | 否 | Array of String | 一个或者多个过滤值。 |
ApplyDisk
本参数用于快照组回滚接口的入参,表示回滚的云盘、快照列表
被如下接口引用:ApplySnapshotGroup
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SnapshotId | 是 | 否 | String | 快照ID |
| DiskId | 是 | 否 | String | 快照对应的原云硬盘ID |
PoolCustomAttributes
描述用户资源池的自定义属性
被如下接口引用:DescribeDiskStoragePoolGroups
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| CpuArchitecture | 否 | 是 | String | cpu架构。 |
| CpuModel | 否 | 是 | String | cpu型号。 |
BlockStorage
描述块存储的详细信息。
被如下接口引用:DescribeBlockStorages
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| DiskId | 是 | 否 | String | 块存储ID。 |
| DiskName | 是 | 否 | String | 块存储名称。 |
| DiskSize | 是 | 否 | Uint64 | 块存储大小,单位GB。 |
| DiskType | 是 | 否 | String | 块存储介质类型。取值范围:<br><li>CLOUD_BASIC<br><li>CLOUD_PREMIUM<br><li>CLOUD_SSD<br><li>CLOUD_ENHANCEDSSD<br><li>LOCAL_BASIC<br><li>LOCAL_SSD |
| DiskUsage | 是 | 否 | String | 块存储类型。取值范围:<br><li>SYSTEM_DISK:系统盘<br><li>DATA_DISK:数据盘。 |
| InstanceId | 是 | 是 | String | 块存储挂载的实例ID。 |
| InstanceName | 是 | 否 | String | 块存储挂载的实例名称。 |
DiskFeature
云硬盘产品支持的特性。
被如下接口引用:DescribeDiskSupportFeatures
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| TradeType | 是 | 是 | String | 云硬盘使用的计费系统。取值范围:<br><li>bmppro:计费系统<br><li>bmp:计量系统 |
DiskOverview
用户云硬盘信息概览,包括云硬盘总数,已过期云硬盘数,7天内将到期云硬盘数。
被如下接口引用:DescribeUserDiskResources
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| DiskNumberTotal | 是 | 否 | Int64 | 用户云硬盘总数。 |
| ExpiredNumberTotal | 是 | 否 | Int64 | 用户已过期云硬盘总数。 |
| DiskNumberExpireIn7days | 是 | 否 | Int64 | 用户7天内将到期云硬盘总数 |
DiskConfigSet
云盘配置
被如下接口引用:DescribeZoneDiskConfigInfos
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| DiskUsage | 是 | 否 | String | 系统盘或数据盘 |
| DiskType | 是 | 否 | String | CLOUD_BASIC、CLOUD_PREMIUM、CLOUD_SSD |
| DiskSize | 是 | 否 | Int64 | 云盘大小 |
| SnapshotId | 否 | 否 | String | 快照ID |
DiskDeniedAction
单个云硬盘的操作掩码
被如下接口引用:DescribeDisksDeniedActions
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| DiskId | 是 | 否 | String | 云硬盘ID,比如"disk-7rf24jvb" |
| DeniedActions | 是 | 否 | Array of DeniedAction | 具体的云硬盘的操作掩码信息 |
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。 |
SnapshotGroup
描述快照组详情
被如下接口引用:DescribeSnapshotGroups
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SnapshotGroupId | 是 | 否 | String | 快照组ID |
| SnapshotGroupType | 是 | 是 | String | 快照组类型。NORMAL: 普通快照组,非一致性快照 |
| ContainRootSnapshot | 是 | 是 | Bool | 快照组是否包含系统盘快照 |
| SnapshotIdSet | 是 | 是 | Array of String | 快照组包含的快照ID列表 |
| SnapshotGroupState | 是 | 是 | String | 快照组状态。<br><li>NORMAL: 正常<br><li>CREATING:创建中<br><li>DELETED:已删除<br><li>FAILED:创建失败<br><li>DISMISS:已解散<br><li>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 | 最后一次异步操作结果的提示码 |
ResourcesDetail
描述用户的资源详情。
被如下接口引用:DescribeUserDiskResources
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Region | 是 | 否 | String | 资源所在地域。 |
| SnapshotNumberTotal | 是 | 否 | Uint64 | 快照用户数量配额。 |
| SnapshotNumberUsed | 是 | 否 | Uint64 | 已使用的快照数量。 |
| SnapshotCapacityTotal | 是 | 否 | Uint64 | 快照容量配额。 |
| SnapshotCapacityUsed | 是 | 否 | Uint64 | 已使用的快照容量,单位GB。 |
| DiskNumber | 是 | 否 | Int64 | 云盘数量。 |
| NewDiskFlag | 是 | 否 | Bool | 当前地域是否包含新购买的云盘。 |
| SnapshotSupportCrossCopy | 是 | 否 | Bool | 当前地域是否支持跨地域复制 |
| DiskNumberIsolated | 是 | 否 | Uint64 | 回收站内的云盘数量。 |
AutoSnapshotPolicy
描述了定期快照策略的详细信息
被如下接口引用:DescribeAutoSnapshotPolicies、DescribeDiskAssociatedAutoSnapshotPolicy
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| AutoSnapshotPolicyId | 否 | 否 | String | 定期快照策略ID。 |
| AutoSnapshotPolicyName | 否 | 否 | String | 定期快照策略名称。 |
| AutoSnapshotPolicyState | 否 | 否 | String | 定期快照策略的状态。取值范围:<br><li>NORMAL:正常<br><li>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 |
SnapshotGroupDeniedAction
单个快照组的操作掩码
被如下接口引用:DescribeSnapshotGroupsDeniedActions
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SnapshotGroupId | 是 | 否 | String | 快照组ID |
| DeniedActions | 是 | 否 | Array of DeniedAction | 具体的快照的操作掩码信息 |
SnapshotCopyResult
描述快照跨地域复制的结果。
被如下接口引用:CopySnapshotCrossRegions
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| DestinationRegion | 是 | 否 | String | 跨地复制的目标地域。 |
| SnapshotId | 是 | 否 | String | 复制到目标地域的新快照ID。 |
Disk
描述了云硬盘的详细信息
被如下接口引用:DescribeDisks
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| DiskId | 否 | 否 | String | 云硬盘ID。 |
| DiskUsage | 否 | 否 | String | 云硬盘类型。取值范围:<br><li>SYSTEM_DISK:系统盘<br><li>DATA_DISK:数据盘。 |
| DiskChargeType | 否 | 否 | String | 付费模式。取值范围:<br><li>PREPAID:预付费,即包年包月<br><li>POSTPAID_BY_HOUR:后付费,即按量计费。 |
| Portable | 否 | 否 | Bool | 是否为弹性云盘,false表示非弹性云盘,true表示弹性云盘。 |
| Placement | 否 | 否 | Placement | 云硬盘所在的位置。 |
| SnapshotAbility | 否 | 否 | Bool | 云盘是否具备创建快照的能力。取值范围:<br><li>false表示不具备<br><li>true表示具备。 |
| DiskName | 否 | 否 | String | 云硬盘名称。 |
| DiskSize | 否 | 否 | Uint64 | 云硬盘大小。 |
| DiskState | 否 | 否 | String | 云盘状态。取值范围:<br><li>UNATTACHED:未挂载<br><li>ATTACHING:挂载中<br><li>ATTACHED:已挂载<br><li>DETACHING:解挂中<br><li>EXPANDING:扩容中<br><li>ROLLBACKING:回滚中。 |
| DiskType | 否 | 否 | String | 云盘介质类型。取值范围:<br><li>CLOUD_BASIC:表示普通云硬<br><li>CLOUD_PREMIUM:表示高性能云硬盘<br><li>CLOUD_SSD:SSD表示SSD云硬盘。 |
| Attached | 否 | 否 | Bool | 云盘是否挂载到云主机上。取值范围:<br><li>false:表示未挂载<br><li>true:表示已挂载。 |
| InstanceId | 否 | 否 | String | 云硬盘挂载的云主机ID。 |
| CreateTime | 否 | 否 | String | 云硬盘的创建时间。 |
| DeadlineTime | 否 | 否 | String | 云硬盘的到期时间。 |
| Rollbacking | 否 | 否 | Bool | 云盘是否处于快照回滚状态。取值范围:<br><li>false:表示不处于快照回滚状态<br><li>true:表示处于快照回滚状态。 |
| RollbackPercent | 否 | 否 | Uint64 | 云盘快照回滚的进度。 |
| Encrypt | 否 | 否 | Bool | 云盘是否为加密盘。取值范围:<br><li>false:表示非加密盘<br><li>true:表示加密盘。 |
| AutoRenewFlagError | 否 | 否 | Bool | 云盘已挂载到子机,且子机与云盘都是包年包月。<br><li>true:子机设置了自动续费标识,但云盘未设置<br><li>false:云盘自动续费标识正常。 |
| RenewFlag | 否 | 否 | String | 自动续费标识。取值范围:<br><li>NOTIFY_AND_AUTO_RENEW:通知过期且自动续费<br><li>NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费<br><li>DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费。 |
| DeadlineError | 否 | 否 | Bool | 在云盘已挂载到实例,且实例与云盘都是包年包月的条件下,此字段才有意义。<br><li>true:云盘到期时间早于实例。<br><li>false:云盘到期时间晚于实例。 |
| IsReturnable | 否 | 是 | Bool | 判断预付费的云盘是否支持主动退还。<br><li>true:支持主动退还<br><li>false:不支持主动退还。 |
| ReturnFailCode | 否 | 是 | Uint64 | 预付费云盘在不支持主动退还的情况下,该参数表明不支持主动退还的具体原因。取值范围:<br><li>1:云硬盘已经退还<br><li>2:云硬盘已过期<br><li>3:云盘不支持退还<br><li>8:超过可退还数量的限制。 |
| AutoSnapshotPolicyIds | 否 | 是 | Array of String | 云盘关联的定期快照ID。只有在调用DescribeDisks接口时,入参ReturnBindAutoSnapshotPolicy取值为TRUE才会返回该参数。 |
| Tags | 是 | 是 | Array of Tag | 与云盘绑定的标签,云盘未绑定标签则取值为空。 |
| DeleteWithInstance | 是 | 是 | Bool | 云盘是否与挂载的实例一起销毁。<br><li>true:销毁实例时会同时销毁云盘,只支持按小时后付费云盘。<br><li>false:销毁实例时不销毁云盘。 |
| DifferDaysOfDeadline | 是 | 是 | Int64 | 当前时间距离盘到期的天数(仅对预付费盘有意义)。 |
| Migrating | 是 | 是 | Bool | 云盘是否处于类型变更中。取值范围:<br><li>false:表示云盘不处于类型变更中<br><li>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:非国密 |
Placement
描述了实例的抽象位置,包括其所在的可用区,所属的项目
被如下接口引用:CreateDisks、DescribeDiskAssociatedSnapshots、DescribeDisks、DescribeSnapshots、InquiryPriceCreateSnapshots、SwitchParameterCreateDisks
| 名称 | 必选 | 允许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 | 项目名称 |
| DedicatedClusterId | 否 | 是 | String | cvm独享集群id。作为入参时,表示对指定独享集群的资源进行操作。作为出参时,表示资源所属的独享集群的ID,可为空。 |
SharePermission
快照分享信息集合
被如下接口引用:DescribeSnapshotSharePermission
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| CreatedTime | 是 | 否 | Datetime | 快照分享的时间 |
| AccountId | 是 | 否 | Int64 | 分享的账号Id |
Snapshot
描述了快照的详细信息
被如下接口引用:DescribeDiskAssociatedSnapshots、DescribeSnapshots
| 名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| SnapshotId | 否 | 否 | String | 快照ID。 |
| Placement | 否 | 否 | Placement | 快照所在的位置。 |
| DiskUsage | 否 | 否 | String | 创建此快照的云硬盘类型。取值范围:<br><li>SYSTEM_DISK:系统盘<br><li>DATA_DISK:数据盘。 |
| DiskId | 否 | 否 | String | 创建此快照的云硬盘ID。 |
| DiskSize | 否 | 否 | Uint64 | 创建此快照的云硬盘大小。 |
| SnapshotState | 否 | 否 | String | 快照的状态。取值范围:<br><li>NORMAL:正常<br><li>CREATING:创建中<br><li>ROLLBACKING:回滚中<br><li>COPYING_FROM_REMOTE:跨地域复制快照拷贝中。 |
| SnapshotName | 否 | 否 | String | 快照名称,用户自定义的快照别名。调用ModifySnapshotAttribute可修改此字段。 |
| Percent | 否 | 否 | Uint64 | 快照创建进度百分比,快照创建成功后此字段恒为100。 |
| CreateTime | 否 | 否 | String | 快照的创建时间。 |
| DeadlineTime | 否 | 否 | String | 快照到期时间。如果快照为永久保留,此字段为空。 |
| Encrypt | 否 | 否 | Bool | 是否为加密盘创建的快照。取值范围:<br><li>true:该快照为加密盘创建的<br><li>false:非加密盘创建的快照。 |
| IsPermanent | 否 | 否 | Bool | 是否为永久快照。取值范围:<br><li>true:永久快照<br><li>false:非永久快照。 |
| CopyingToRegions | 是 | 是 | Array of String | 快照正在跨地域复制的目的地域,默认取值为[]。 |
| CopyFromRemote | 是 | 是 | Bool | 是否为跨地域复制的快照。取值范围:<br><li>true:表示为跨地域复制的快照。<br><li>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 | 加密算法。 |