数据结构

最近更新时间:2019-08-01 14:33:27

AttachDetail

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

被如下接口引用:DescribeInstancesDiskNum。

名称 类型 描述
InstanceId String 实例ID。
AttachedDiskCount Integer 实例已挂载数据盘的数量。
MaxAttachCount Integer 实例最大可挂载数据盘的数量。

AutoSnapshotPolicy

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

被如下接口引用:DescribeAutoSnapshotPolicies、DescribeDiskAssociatedAutoSnapshotPolicy。

名称 类型 描述
AutoSnapshotPolicyId String 定期快照策略ID。
AutoSnapshotPolicyName String 定期快照策略名称。
AutoSnapshotPolicyState String 定期快照策略的状态。取值范围:
  • NORMAL:正常
  • ISOLATED:已隔离。
  • IsActivated Boolean 定期快照策略是否激活。
    IsPermanent Boolean 使用该定期快照策略创建出来的快照是否永久保留。
    RetentionDays Integer 使用该定期快照策略创建出来的快照保留天数。
    CreateTime Timestamp 定期快照策略的创建时间。
    NextTriggerTime Timestamp 定期快照下次触发的时间。
    Policy Array of Policy 定期快照的执行策略。
    DiskIdSet Array of String 已绑定当前定期快照策略的云盘ID列表。

    Disk

    描述了云硬盘的详细信息

    被如下接口引用:DescribeDisks。

    名称 类型 描述
    DiskId String 云硬盘ID。
    DiskUsage String 云硬盘类型。取值范围:
  • SYSTEM_DISK:系统盘
  • DATA_DISK:数据盘。
  • DiskChargeType String 付费模式。取值范围:
  • PREPAID:预付费,即包年包月
  • POSTPAID_BY_HOUR:后付费,即按量计费。
  • Portable Boolean 是否为弹性云盘,false表示非弹性云盘,true表示弹性云盘。
    Placement Placement 云硬盘所在的位置。
    SnapshotAbility Boolean 云盘是否具备创建快照的能力。取值范围:
  • false表示不具备
  • true表示具备。
  • DiskName String 云硬盘名称。
    DiskSize Integer 云硬盘大小,单位GB。
    DiskState String 云盘状态。取值范围:
  • UNATTACHED:未挂载
  • ATTACHING:挂载中
  • ATTACHED:已挂载
  • DETACHING:解挂中
  • EXPANDING:扩容中
  • ROLLBACKING:回滚中
  • TORECYCLE:待回收
  • DUMPING:拷贝硬盘中。
  • DiskType String 云盘介质类型。取值范围:
  • CLOUD_BASIC:表示普通云硬盘
  • CLOUD_PREMIUM:表示高性能云硬盘
  • CLOUD_SSD:SSD表示SSD云硬盘。
  • Attached Boolean 云盘是否挂载到云主机上。取值范围:
  • false:表示未挂载
  • true:表示已挂载。
  • InstanceId String 云硬盘挂载的云主机ID。
    CreateTime Timestamp 云硬盘的创建时间。
    DeadlineTime Timestamp 云硬盘的到期时间。
    Rollbacking Boolean 云盘是否处于快照回滚状态。取值范围:
  • false:表示不处于快照回滚状态
  • true:表示处于快照回滚状态。
  • RollbackPercent Integer 云盘快照回滚的进度。
    Encrypt Boolean 云盘是否为加密盘。取值范围:
  • false:表示非加密盘
  • true:表示加密盘。
  • AutoRenewFlagError Boolean 云盘已挂载到子机,且子机与云盘都是包年包月。
  • true:子机设置了自动续费标识,但云盘未设置
  • false:云盘自动续费标识正常。
    注意:此字段可能返回 null,表示取不到有效值。
  • RenewFlag String 自动续费标识。取值范围:
  • NOTIFY_AND_AUTO_RENEW:通知过期且自动续费
  • NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费
  • DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费。
    注意:此字段可能返回 null,表示取不到有效值。
  • DeadlineError Boolean 在云盘已挂载到实例,且实例与云盘都是包年包月的条件下,此字段才有意义。
  • true:云盘到期时间早于实例。
  • false:云盘到期时间晚于实例。
    注意:此字段可能返回 null,表示取不到有效值。
  • IsReturnable Boolean 判断预付费的云盘是否支持主动退还。
  • true:支持主动退还
  • false:不支持主动退还。
    注意:此字段可能返回 null,表示取不到有效值。
  • ReturnFailCode Integer 预付费云盘在不支持主动退还的情况下,该参数表明不支持主动退还的具体原因。取值范围:
  • 1:云硬盘已经退还
  • 2:云硬盘已过期
  • 3:云盘不支持退还
  • 8:超过可退还数量的限制。
    注意:此字段可能返回 null,表示取不到有效值。
  • AutoSnapshotPolicyIds Array of String 云盘关联的定期快照ID。只有在调用DescribeDisks接口时,入参ReturnBindAutoSnapshotPolicy取值为TRUE才会返回该参数。
    注意:此字段可能返回 null,表示取不到有效值。
    Tags Array of Tag 与云盘绑定的标签,云盘未绑定标签则取值为空。
    注意:此字段可能返回 null,表示取不到有效值。
    DeleteWithInstance Boolean 云盘是否与挂载的实例一起销毁。
  • true:销毁实例时会同时销毁云盘,只支持按小时后付费云盘。
  • false:销毁实例时不销毁云盘。
    注意:此字段可能返回 null,表示取不到有效值。
  • DifferDaysOfDeadline Integer 当前时间距离盘到期的天数(仅对预付费盘有意义)。
    注意:此字段可能返回 null,表示取不到有效值。
    Migrating Boolean 云盘是否处于类型变更中。取值范围:
  • false:表示云盘不处于类型变更中
  • true:表示云盘已发起类型变更,正处于迁移中。
    注意:此字段可能返回 null,表示取不到有效值。
  • MigratePercent Integer 云盘类型变更的迁移进度,取值0到100。
    注意:此字段可能返回 null,表示取不到有效值。
    Shareable Boolean 云盘是否为共享型云盘。
    InstanceIdList Array of String 对于非共享型云盘,该参数为空数组。对于共享型云盘,则表示该云盘当前被挂载到的CVM实例InstanceId
    AttachDeviceId String 云硬盘挂载目标设备的ID
    注意:此字段可能返回 null,表示取不到有效值。
    AttachDeviceType String 云硬盘挂载目标设备的类型,目前包括CVM和POD
    注意:此字段可能返回 null,表示取不到有效值。

    DiskChargePrepaid

    描述了实例的计费模式

    被如下接口引用:CreateDisks、InquiryPriceCreateDisks、InquiryPriceRenewDisks、RenewDisk。

    名称 类型 必选 描述
    Period Integer 购买云盘的时长,默认单位为月,取值范围: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 Timestamp 需要将云盘的到期时间与挂载的子机对齐时,可传入该参数。该参数表示子机当前的到期时间,此时Period如果传入,则表示子机需要续费的时长,云盘会自动按对齐到子机续费后的到期时间续费,示例取值:2018-03-30 20:15:03。

    DiskConfig

    云盘配置。

    被如下接口引用:DescribeDiskConfigQuota。

    名称 类型 描述
    Available Boolean 配置是否可用。
    DiskType String 云盘介质类型。取值范围:
  • CLOUD_BASIC:表示普通云硬盘
  • CLOUD_PREMIUM:表示高性能云硬盘
  • CLOUD_SSD:SSD表示SSD云硬盘。
  • DiskUsage String 云盘类型。取值范围:
  • SYSTEM_DISK:表示系统盘
  • DATA_DISK:表示数据盘。
  • DiskChargeType String 付费模式。取值范围:
  • PREPAID:表示预付费,即包年包月
  • POSTPAID_BY_HOUR:表示后付费,即按量计费。
  • MaxDiskSize Integer 最大可配置云盘大小,单位GB。
    MinDiskSize Integer 最小可配置云盘大小,单位GB。
    Zone String 云硬盘所属的可用区
    DeviceClass String 实例机型。
    注意:此字段可能返回 null,表示取不到有效值。
    InstanceFamily String 实例机型系列。详见实例类型
    注意:此字段可能返回 null,表示取不到有效值。

    DiskOperationLog

    云盘操作日志。

    被如下接口引用:DescribeDiskOperationLogs。

    名称 类型 描述
    Operator String 操作者的UIN。
    Operation String 操作类型。取值范围:
    CBS_OPERATION_ATTACH:挂载云硬盘
    CBS_OPERATION_DETACH:解挂云硬盘
    CBS_OPERATION_RENEW:续费
    CBS_OPERATION_EXPAND:扩容
    CBS_OPERATION_CREATE:创建
    CBS_OPERATION_ISOLATE:隔离
    CBS_OPERATION_MODIFY:修改云硬盘属性
    ASP_OPERATION_BIND:关联定期快照策略
    ASP_OPERATION_UNBIND:取消关联定期快照策略
    DiskId String 操作的云盘ID。
    OperationState String 操作的状态。取值范围:
    SUCCESS :表示操作成功
    FAILED :表示操作失败
    PROCESSING :表示操作中。
    StartTime String 开始时间。
    EndTime String 结束时间。

    Filter

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

    被如下接口引用:DescribeAutoSnapshotPolicies、DescribeDiskOperationLogs、DescribeDisks、DescribeSnapshotOperationLogs、DescribeSnapshots。

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

    Image

    镜像。

    被如下接口引用:DescribeSnapshots。

    名称 类型 描述
    ImageId String 镜像实例ID。
    ImageName String 镜像名称。

    Placement

    描述了实例的抽象位置,包括其所在的可用区,所属的项目,以及所属的独享集群的ID和名字。

    被如下接口引用:CreateDisks、DescribeDisks、DescribeSnapshots。

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

    Policy

    描述了定期快照的执行策略。可理解为在DayOfWeek指定的那几天中,在Hour指定的小时执行该条定期快照策略。

    被如下接口引用:CreateAutoSnapshotPolicy、DescribeAutoSnapshotPolicies、DescribeDiskAssociatedAutoSnapshotPolicy、ModifyAutoSnapshotPolicyAttribute。

    名称 类型 必选 描述
    DayOfWeek Array of Integer 指定每周从周一到周日需要触发定期快照的日期,取值范围:[0, 6]。0表示周日触发,1-6分别表示周一至周六。
    Hour Array of Integer 指定定期快照策略的触发时间。单位为小时,取值范围:[0, 23]。00:00 ~ 23:00 共 24 个时间点可选,1表示 01:00,依此类推。

    PrepayPrice

    预付费订单的费用。

    被如下接口引用:InquiryPriceRenewDisks、InquiryPriceResizeDisk。

    名称 类型 描述
    OriginalPrice Float 预付费云盘或快照预支费用的原价,单位:元。
    DiscountPrice Float 预付费云盘或快照预支费用的折扣价,单位:元。

    Price

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

    被如下接口引用:InquiryPriceCreateDisks。

    名称 类型 描述
    OriginalPrice Float 预付费云盘预支费用的原价,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    DiscountPrice Float 预付费云盘预支费用的折扣价,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    UnitPrice Float 后付费云盘原单价,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。
    ChargeUnit String 后付费云盘的计价单元,取值范围:
  • HOUR:表示后付费云盘的计价单元是按小时计算。
    注意:此字段可能返回 null,表示取不到有效值。
  • UnitPriceDiscount Float 后付费云盘折扣单价,单位:元。
    注意:此字段可能返回 null,表示取不到有效值。

    Snapshot

    描述了快照的详细信息

    被如下接口引用:DescribeSnapshots。

    名称 类型 描述
    SnapshotId String 快照ID。
    Placement Placement 快照所在的位置。
    DiskUsage String 创建此快照的云硬盘类型。取值范围:
  • SYSTEM_DISK:系统盘
  • DATA_DISK:数据盘。
  • DiskId String 创建此快照的云硬盘ID。
    DiskSize Integer 创建此快照的云硬盘大小,单位GB。
    SnapshotState String 快照的状态。取值范围:
  • NORMAL:正常
  • CREATING:创建中
  • ROLLBACKING:回滚中
  • COPYING_FROM_REMOTE:跨地域复制快照拷贝中。
  • SnapshotName String 快照名称,用户自定义的快照别名。调用ModifySnapshotAttribute可修改此字段。
    Percent Integer 快照创建进度百分比,快照创建成功后此字段恒为100。
    CreateTime Timestamp 快照的创建时间。
    DeadlineTime Timestamp 快照到期时间。如果快照为永久保留,此字段为空。
    Encrypt Boolean 是否为加密盘创建的快照。取值范围:
  • true:该快照为加密盘创建的
  • false:非加密盘创建的快照。
  • IsPermanent Boolean 是否为永久快照。取值范围:
  • true:永久快照
  • false:非永久快照。
  • CopyingToRegions Array of String 快照正在跨地域复制的目的地域,默认取值为[]。
    CopyFromRemote Boolean 是否为跨地域复制的快照。取值范围:
  • true:表示为跨地域复制的快照。
  • false:本地域的快照。
  • Images Array of Image 快照关联的镜像列表。
    ImageCount Integer 快照关联的镜像个数。
    SnapshotType String 快照类型,目前该项取值可以为PRIVATE_SNAPSHOT或者SHARED_SNAPSHOT

    SnapshotOperationLog

    快照操作日志。

    被如下接口引用:DescribeSnapshotOperationLogs。

    名称 类型 描述
    Operator String 操作者的UIN。
    注意:此字段可能返回 null,表示取不到有效值。
    Operation String 操作类型。取值范围:
    SNAP_OPERATION_DELETE:删除快照
    SNAP_OPERATION_ROLLBACK:回滚快照
    SNAP_OPERATION_MODIFY:修改快照属性
    SNAP_OPERATION_CREATE:创建快照
    SNAP_OPERATION_COPY:跨地域复制快照
    ASP_OPERATION_CREATE_SNAP:由定期快照策略创建快照
    ASP_OPERATION_DELETE_SNAP:由定期快照策略删除快照
    SnapshotId String 操作的快照ID。
    OperationState String 操作的状态。取值范围:
    SUCCESS :表示操作成功
    FAILED :表示操作失败
    PROCESSING :表示操作中。
    StartTime String 开始时间。
    EndTime String 结束时间。

    Tag

    标签。

    被如下接口引用:CreateDisks、DescribeDisks。

    名称 类型 必选 描述
    Key String 标签健。
    Value String 标签值。