Class Disk

    • Constructor Summary

      Constructors 
      Constructor Description
      Disk()  
      Disk​(Disk source)
      NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Boolean getAttached()
      Get 云盘是否挂载到云主机上。取值范围:
      false:表示未挂载
      true:表示已挂载。
      String getAttachMode()
      Get 云盘的挂载类型。取值范围:
      PF: PF挂载
      VF: VF挂载 注意:此字段可能返回 null,表示取不到有效值。
      Boolean getAutoRenewFlagError()
      Get 云盘已挂载到子机,且子机与云盘都是包年包月。
      true:子机设置了自动续费标识,但云盘未设置
      false:云盘自动续费标识正常。 注意:此字段可能返回 null,表示取不到有效值。
      String[] getAutoSnapshotPolicyIds()
      Get 云盘关联的定期快照ID。只有在调用DescribeDisks接口时,入参ReturnBindAutoSnapshotPolicy取值为TRUE才会返回该参数。 注意:此字段可能返回 null,表示取不到有效值。
      Boolean getBackupDisk()
      Get 云硬盘因欠费销毁或者到期销毁时, 是否使用快照备份数据的标识。true表示销毁时创建快照进行数据备份。false表示直接销毁,不进行数据备份。
      String getCreateTime()
      Get 云硬盘的创建时间。
      Boolean getDeadlineError()
      Get 在云盘已挂载到实例,且实例与云盘都是包年包月的条件下,此字段才有意义。
      true:云盘到期时间早于实例。
      false:云盘到期时间晚于实例。 注意:此字段可能返回 null,表示取不到有效值。
      String getDeadlineTime()
      Get 云硬盘的到期时间。
      Boolean getDeleteWithInstance()
      Get 云盘是否与挂载的实例一起销毁。
      true:销毁实例时会同时销毁云盘,只支持按小时后付费云盘。
      false:销毁实例时不销毁云盘。 注意:此字段可能返回 null,表示取不到有效值。
      Long getDifferDaysOfDeadline()
      Get 当前时间距离盘到期的天数(仅对预付费盘有意义)。 注意:此字段可能返回 null,表示取不到有效值。
      String getDiskChargeType()
      Get 付费模式。取值范围:
      PREPAID:预付费,即包年包月
      POSTPAID_BY_HOUR:后付费,即按量计费。
      String getDiskId()
      Get 云硬盘ID。
      String getDiskName()
      Get 云硬盘名称。
      Long getDiskSize()
      Get 云硬盘大小,单位GB。
      String getDiskState()
      Get 云盘状态。取值范围:
      UNATTACHED:未挂载
      ATTACHING:挂载中
      ATTACHED:已挂载
      DETACHING:解挂中
      EXPANDING:扩容中
      ROLLBACKING:回滚中
      TORECYCLE:待回收
      DUMPING:拷贝硬盘中。
      String getDiskType()
      Get 硬盘介质类型。取值范围:
      CLOUD_BASIC:表示普通云硬盘
      CLOUD_PREMIUM:表示高性能云硬盘
      CLOUD_SSD:表示SSD云硬盘
      CLOUD_HSSD:表示增强型SSD云硬盘
      CLOUD_TSSD:表示极速型SSD云硬盘。
      String getDiskUsage()
      Get 云硬盘类型。取值范围:
      SYSTEM_DISK:系统盘
      DATA_DISK:数据盘。
      Boolean getEncrypt()
      Get 云盘是否为加密盘。取值范围:
      false:表示非加密盘
      true:表示加密盘。
      String getInstanceId()
      Get 云硬盘挂载的云主机ID。
      String[] getInstanceIdList()
      Get 对于非共享型云盘,该参数为空数组。对于共享型云盘,则表示该云盘当前被挂载到的CVM实例InstanceId
      Boolean getIsReturnable()
      Get 判断预付费的云盘是否支持主动退还。
      true:支持主动退还
      false:不支持主动退还。 注意:此字段可能返回 null,表示取不到有效值。
      Long getMigratePercent()
      Get 云盘类型变更的迁移进度,取值0到100。 注意:此字段可能返回 null,表示取不到有效值。
      Boolean getMigrating()
      Get 云盘是否处于类型变更中。取值范围:
      false:表示云盘不处于类型变更中
      true:表示云盘已发起类型变更,正处于迁移中。 注意:此字段可能返回 null,表示取不到有效值。
      Placement getPlacement()
      Get 云硬盘所在的位置。
      Boolean getPortable()
      Get 是否为弹性云盘,false表示非弹性云盘,true表示弹性云盘。
      String getRenewFlag()
      Get 自动续费标识。取值范围:
      NOTIFY_AND_AUTO_RENEW:通知过期且自动续费
      NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费
      DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费。 注意:此字段可能返回 null,表示取不到有效值。
      Long getReturnFailCode()
      Get 预付费云盘在不支持主动退还的情况下,该参数表明不支持主动退还的具体原因。取值范围:
      1:云硬盘已经退还
      2:云硬盘已过期
      3:云盘不支持退还
      8:超过可退还数量的限制。 注意:此字段可能返回 null,表示取不到有效值。
      Boolean getRollbacking()
      Get 云盘是否处于快照回滚状态。取值范围:
      false:表示不处于快照回滚状态
      true:表示处于快照回滚状态。
      Long getRollbackPercent()
      Get 云盘快照回滚的进度。
      Boolean getShareable()
      Get 云盘是否为共享型云盘。
      Boolean getSnapshotAbility()
      Get 云盘是否具备创建快照的能力。取值范围:
      false表示不具备
      true表示具备。
      Long getSnapshotCount()
      Get 云盘拥有的快照总数。
      Long getSnapshotSize()
      Get 云盘拥有的快照总容量,单位为MB。
      Tag[] getTags()
      Get 与云盘绑定的标签,云盘未绑定标签则取值为空。 注意:此字段可能返回 null,表示取不到有效值。
      Long getThroughputPerformance()
      Get 云硬盘额外性能值,单位MB/s。 注意:此字段可能返回 null,表示取不到有效值。
      void setAttached​(Boolean Attached)
      Set 云盘是否挂载到云主机上。取值范围:
      false:表示未挂载
      true:表示已挂载。
      void setAttachMode​(String AttachMode)
      Set 云盘的挂载类型。取值范围:
      PF: PF挂载
      VF: VF挂载 注意:此字段可能返回 null,表示取不到有效值。
      void setAutoRenewFlagError​(Boolean AutoRenewFlagError)
      Set 云盘已挂载到子机,且子机与云盘都是包年包月。
      true:子机设置了自动续费标识,但云盘未设置
      false:云盘自动续费标识正常。 注意:此字段可能返回 null,表示取不到有效值。
      void setAutoSnapshotPolicyIds​(String[] AutoSnapshotPolicyIds)
      Set 云盘关联的定期快照ID。只有在调用DescribeDisks接口时,入参ReturnBindAutoSnapshotPolicy取值为TRUE才会返回该参数。 注意:此字段可能返回 null,表示取不到有效值。
      void setBackupDisk​(Boolean BackupDisk)
      Set 云硬盘因欠费销毁或者到期销毁时, 是否使用快照备份数据的标识。true表示销毁时创建快照进行数据备份。false表示直接销毁,不进行数据备份。
      void setCreateTime​(String CreateTime)
      Set 云硬盘的创建时间。
      void setDeadlineError​(Boolean DeadlineError)
      Set 在云盘已挂载到实例,且实例与云盘都是包年包月的条件下,此字段才有意义。
      true:云盘到期时间早于实例。
      false:云盘到期时间晚于实例。 注意:此字段可能返回 null,表示取不到有效值。
      void setDeadlineTime​(String DeadlineTime)
      Set 云硬盘的到期时间。
      void setDeleteWithInstance​(Boolean DeleteWithInstance)
      Set 云盘是否与挂载的实例一起销毁。
      true:销毁实例时会同时销毁云盘,只支持按小时后付费云盘。
      false:销毁实例时不销毁云盘。 注意:此字段可能返回 null,表示取不到有效值。
      void setDifferDaysOfDeadline​(Long DifferDaysOfDeadline)
      Set 当前时间距离盘到期的天数(仅对预付费盘有意义)。 注意:此字段可能返回 null,表示取不到有效值。
      void setDiskChargeType​(String DiskChargeType)
      Set 付费模式。取值范围:
      PREPAID:预付费,即包年包月
      POSTPAID_BY_HOUR:后付费,即按量计费。
      void setDiskId​(String DiskId)
      Set 云硬盘ID。
      void setDiskName​(String DiskName)
      Set 云硬盘名称。
      void setDiskSize​(Long DiskSize)
      Set 云硬盘大小,单位GB。
      void setDiskState​(String DiskState)
      Set 云盘状态。取值范围:
      UNATTACHED:未挂载
      ATTACHING:挂载中
      ATTACHED:已挂载
      DETACHING:解挂中
      EXPANDING:扩容中
      ROLLBACKING:回滚中
      TORECYCLE:待回收
      DUMPING:拷贝硬盘中。
      void setDiskType​(String DiskType)
      Set 硬盘介质类型。取值范围:
      CLOUD_BASIC:表示普通云硬盘
      CLOUD_PREMIUM:表示高性能云硬盘
      CLOUD_SSD:表示SSD云硬盘
      CLOUD_HSSD:表示增强型SSD云硬盘
      CLOUD_TSSD:表示极速型SSD云硬盘。
      void setDiskUsage​(String DiskUsage)
      Set 云硬盘类型。取值范围:
      SYSTEM_DISK:系统盘
      DATA_DISK:数据盘。
      void setEncrypt​(Boolean Encrypt)
      Set 云盘是否为加密盘。取值范围:
      false:表示非加密盘
      true:表示加密盘。
      void setInstanceId​(String InstanceId)
      Set 云硬盘挂载的云主机ID。
      void setInstanceIdList​(String[] InstanceIdList)
      Set 对于非共享型云盘,该参数为空数组。对于共享型云盘,则表示该云盘当前被挂载到的CVM实例InstanceId
      void setIsReturnable​(Boolean IsReturnable)
      Set 判断预付费的云盘是否支持主动退还。
      true:支持主动退还
      false:不支持主动退还。 注意:此字段可能返回 null,表示取不到有效值。
      void setMigratePercent​(Long MigratePercent)
      Set 云盘类型变更的迁移进度,取值0到100。 注意:此字段可能返回 null,表示取不到有效值。
      void setMigrating​(Boolean Migrating)
      Set 云盘是否处于类型变更中。取值范围:
      false:表示云盘不处于类型变更中
      true:表示云盘已发起类型变更,正处于迁移中。 注意:此字段可能返回 null,表示取不到有效值。
      void setPlacement​(Placement Placement)
      Set 云硬盘所在的位置。
      void setPortable​(Boolean Portable)
      Set 是否为弹性云盘,false表示非弹性云盘,true表示弹性云盘。
      void setRenewFlag​(String RenewFlag)
      Set 自动续费标识。取值范围:
      NOTIFY_AND_AUTO_RENEW:通知过期且自动续费
      NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费
      DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费。 注意:此字段可能返回 null,表示取不到有效值。
      void setReturnFailCode​(Long ReturnFailCode)
      Set 预付费云盘在不支持主动退还的情况下,该参数表明不支持主动退还的具体原因。取值范围:
      1:云硬盘已经退还
      2:云硬盘已过期
      3:云盘不支持退还
      8:超过可退还数量的限制。 注意:此字段可能返回 null,表示取不到有效值。
      void setRollbacking​(Boolean Rollbacking)
      Set 云盘是否处于快照回滚状态。取值范围:
      false:表示不处于快照回滚状态
      true:表示处于快照回滚状态。
      void setRollbackPercent​(Long RollbackPercent)
      Set 云盘快照回滚的进度。
      void setShareable​(Boolean Shareable)
      Set 云盘是否为共享型云盘。
      void setSnapshotAbility​(Boolean SnapshotAbility)
      Set 云盘是否具备创建快照的能力。取值范围:
      false表示不具备
      true表示具备。
      void setSnapshotCount​(Long SnapshotCount)
      Set 云盘拥有的快照总数。
      void setSnapshotSize​(Long SnapshotSize)
      Set 云盘拥有的快照总容量,单位为MB。
      void setTags​(Tag[] Tags)
      Set 与云盘绑定的标签,云盘未绑定标签则取值为空。 注意:此字段可能返回 null,表示取不到有效值。
      void setThroughputPerformance​(Long ThroughputPerformance)
      Set 云硬盘额外性能值,单位MB/s。 注意:此字段可能返回 null,表示取不到有效值。
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.
    • Constructor Detail

      • Disk

        public Disk()
      • Disk

        public Disk​(Disk source)
        NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
    • Method Detail

      • getDeleteWithInstance

        public Boolean getDeleteWithInstance()
        Get 云盘是否与挂载的实例一起销毁。
      • true:销毁实例时会同时销毁云盘,只支持按小时后付费云盘。
      • false:销毁实例时不销毁云盘。 注意:此字段可能返回 null,表示取不到有效值。
Returns:
DeleteWithInstance 云盘是否与挂载的实例一起销毁。
  • true:销毁实例时会同时销毁云盘,只支持按小时后付费云盘。
  • false:销毁实例时不销毁云盘。 注意:此字段可能返回 null,表示取不到有效值。
  • Parameters:
    DeleteWithInstance - 云盘是否与挂载的实例一起销毁。
  • true:销毁实例时会同时销毁云盘,只支持按小时后付费云盘。
  • false:销毁实例时不销毁云盘。 注意:此字段可能返回 null,表示取不到有效值。