public class Disk extends AbstractModel
header, skipSign| Constructor and 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.
|
| Modifier and Type | Method and Description |
|---|---|
Boolean |
getAttached()
Get 云盘是否挂载到云主机上。取值范围：
false:表示未挂载true:表示已挂载。 |
String |
getAttachMode()
Get 云盘的挂载类型。取值范围：
PF: PF挂载VF: VF挂载 |
Boolean |
getAutoRenewFlagError()
Get 云盘已挂载到子机，且子机与云盘都是包年包月。
true：子机设置了自动续费标识，但云盘未设置false：云盘自动续费标识正常。 |
String[] |
getAutoSnapshotPolicyIds()
Get 云盘关联的定期快照ID。只有在调用[DescribeDisks](/document/product/362/16315)接口时，入参ReturnBindAutoSnapshotPolicy取值为TRUE才会返回该参数。
注意：此字段可能返回 null，表示取不到有效值。
|
Boolean |
getBackupDisk()
Get 云硬盘因欠费销毁或者到期销毁时， 是否使用快照备份数据的标识。true表示销毁时创建快照进行数据备份。false表示直接销毁，不进行数据备份。
|
Boolean |
getBurstPerformance()
Get 云盘是否开启性能突发
|
String |
getCreateTime()
Get 云硬盘的创建时间。
|
Boolean |
getDeadlineError()
Get 在云盘已挂载到实例，且实例与云盘都是包年包月的条件下，此字段才有意义。
true:云盘到期时间早于实例。false：云盘到期时间晚于实例。 |
String |
getDeadlineTime()
Get 云硬盘的到期时间。
|
Long |
getDeleteSnapshot()
Get 销毁云盘时删除关联的非永久保留快照。0 表示非永久快照不随云盘销毁而销毁，1表示非永久快照随云盘销毁而销毁，默认取0。快照是否永久保留可以通过[DescribeSnapshots](https://cloud.tencent.com/document/product/362/15647)接口返回的快照详情的IsPermanent字段来判断，true表示永久快照，false表示非永久快照。
|
Boolean |
getDeleteWithInstance()
Get 云盘是否与挂载的实例一起销毁。
true:销毁实例时会同时销毁云盘，只支持按小时后付费云盘。false：销毁实例时不销毁云盘。 |
Long |
getDifferDaysOfDeadline()
Get 当前时间距离云硬盘到期的天数（仅对预付费云硬盘有意义）
注意：此字段可能返回 null，表示取不到有效值。
|
Long |
getDiskBackupCount()
Get 云硬盘备份点已使用的数量。
|
Long |
getDiskBackupQuota()
Get 云硬盘备份点配额。表示最大可以保留的备份点数量。
|
String |
getDiskChargeType()
Get 付费模式。取值范围：
PREPAID：预付费，即包年包月POSTPAID_BY_HOUR：后付费，即按量计费。 |
String |
getDiskId()
Get 云硬盘ID。
|
String |
getDiskName()
Get 云硬盘名称。
|
Long |
getDiskSize()
Get 云硬盘大小，单位GiB。
|
String |
getDiskState()
Get 云盘状态。取值范围：
UNATTACHED：未挂载ATTACHING：挂载中ATTACHED：已挂载DETACHING：解挂中EXPANDING：扩容中ROLLBACKING：回滚中TORECYCLE：待回收DUMPING：拷贝硬盘中。 |
String |
getDiskType()
Get 硬盘介质类型。取值范围：
CLOUD_BASIC：表示普通云硬盘CLOUD_PREMIUM：表示高性能云硬盘CLOUD_BSSD：表示通用型SSD云硬盘CLOUD_SSD：表示SSD云硬盘CLOUD_HSSD：表示增强型SSD云硬盘CLOUD_TSSD：表示极速型SSD云硬盘。 |
String |
getDiskUsage()
Get 云硬盘类型。取值范围：
SYSTEM_DISK：系统盘DATA_DISK：数据盘。 |
Boolean |
getEncrypt()
Get 云盘是否为加密盘。取值范围：
false:表示非加密盘true:表示加密盘。 |
String |
getEncryptType()
Get 云硬盘加密类型，值为ENCRYPT_V1和ENCRYPT_V2，分别表示第一代和第二代加密技术，两种加密技术互不兼容
|
String |
getErrorPrompt()
Get 云硬盘最后一次操作错误提示
|
String |
getInstanceId()
Get 云硬盘挂载的云主机ID。
|
String[] |
getInstanceIdList()
Get 对于非共享型云盘，该参数为空数组。对于共享型云盘，则表示该云盘当前被挂载到的CVM实例InstanceId
|
String |
getInstanceType()
Get 云硬盘挂载实例的类型。取值范围：
CVMEKS |
Boolean |
getIsReturnable()
Get 判断预付费的云盘是否支持主动退还。
true:支持主动退还false:不支持主动退还。 注意：此字段可能返回 null，表示取不到有效值。 |
String |
getKmsKeyId()
Get 加密盘密钥ID
|
String |
getLastAttachInsId()
Get 云硬盘最后一次挂载的实例ID
注意：此字段可能返回 null，表示取不到有效值。
|
Long |
getMigratePercent()
Get 云盘类型变更的迁移进度，取值0到100。
|
Boolean |
getMigrating()
Get 云盘是否处于类型变更中。取值范围：
false:表示云盘不处于类型变更中true:表示云盘已发起类型变更，正处于迁移中。 |
Placement |
getPlacement()
Get 云硬盘所在的位置。
|
Boolean |
getPortable()
Get 是否为弹性云盘，false表示非弹性云盘，true表示弹性云盘。
|
String |
getRenewFlag()
Get 自动续费标识。取值范围：
NOTIFY_AND_AUTO_RENEW：通知过期且自动续费NOTIFY_AND_MANUAL_RENEW：通知过期不自动续费DISABLE_NOTIFY_AND_MANUAL_RENEW：不通知过期不自动续费。 |
Long |
getReturnFailCode()
Get 预付费云盘在不支持主动退还的情况下，该参数表明不支持主动退还的具体原因。取值范围：
1：云硬盘已经退还2：云硬盘已过期3：云盘不支持退还8：超过可退还数量的限制。10：非弹性云硬盘、系统盘、后付费云硬盘等不支持退还 |
Boolean |
getRollbacking()
Get 云盘是否处于快照回滚状态。取值范围：
false:表示不处于快照回滚状态true:表示处于快照回滚状态。 |
Long |
getRollbackPercent()
Get 云盘快照回滚的进度。
|
Boolean |
getShareable()
Get 云盘是否为共享型云盘。
|
Boolean |
getSnapshotAbility()
Get 云盘是否具备创建快照的能力。取值范围：
false表示不具备true表示具备。 |
Long |
getSnapshotCount()
Get 云盘拥有的快照总数。
|
Long |
getSnapshotSize()
Get 云盘拥有的快照总容量，单位为MiB。
|
Tag[] |
getTags()
Get 与云盘绑定的标签，云盘未绑定标签则取值为空。
|
Long |
getThroughputPerformance()
Get 云硬盘额外性能值，单位MiB/s。
|
void |
setAttached(Boolean Attached)
Set 云盘是否挂载到云主机上。取值范围：
false:表示未挂载true:表示已挂载。 |
void |
setAttachMode(String AttachMode)
Set 云盘的挂载类型。取值范围：
PF: PF挂载VF: VF挂载 |
void |
setAutoRenewFlagError(Boolean AutoRenewFlagError)
Set 云盘已挂载到子机，且子机与云盘都是包年包月。
true：子机设置了自动续费标识，但云盘未设置false：云盘自动续费标识正常。 |
void |
setAutoSnapshotPolicyIds(String[] AutoSnapshotPolicyIds)
Set 云盘关联的定期快照ID。只有在调用[DescribeDisks](/document/product/362/16315)接口时，入参ReturnBindAutoSnapshotPolicy取值为TRUE才会返回该参数。
注意：此字段可能返回 null，表示取不到有效值。
|
void |
setBackupDisk(Boolean BackupDisk)
Set 云硬盘因欠费销毁或者到期销毁时， 是否使用快照备份数据的标识。true表示销毁时创建快照进行数据备份。false表示直接销毁，不进行数据备份。
|
void |
setBurstPerformance(Boolean BurstPerformance)
Set 云盘是否开启性能突发
|
void |
setCreateTime(String CreateTime)
Set 云硬盘的创建时间。
|
void |
setDeadlineError(Boolean DeadlineError)
Set 在云盘已挂载到实例，且实例与云盘都是包年包月的条件下，此字段才有意义。
true:云盘到期时间早于实例。false：云盘到期时间晚于实例。 |
void |
setDeadlineTime(String DeadlineTime)
Set 云硬盘的到期时间。
|
void |
setDeleteSnapshot(Long DeleteSnapshot)
Set 销毁云盘时删除关联的非永久保留快照。0 表示非永久快照不随云盘销毁而销毁，1表示非永久快照随云盘销毁而销毁，默认取0。快照是否永久保留可以通过[DescribeSnapshots](https://cloud.tencent.com/document/product/362/15647)接口返回的快照详情的IsPermanent字段来判断，true表示永久快照，false表示非永久快照。
|
void |
setDeleteWithInstance(Boolean DeleteWithInstance)
Set 云盘是否与挂载的实例一起销毁。
true:销毁实例时会同时销毁云盘，只支持按小时后付费云盘。false：销毁实例时不销毁云盘。 |
void |
setDifferDaysOfDeadline(Long DifferDaysOfDeadline)
Set 当前时间距离云硬盘到期的天数（仅对预付费云硬盘有意义）
注意：此字段可能返回 null，表示取不到有效值。
|
void |
setDiskBackupCount(Long DiskBackupCount)
Set 云硬盘备份点已使用的数量。
|
void |
setDiskBackupQuota(Long DiskBackupQuota)
Set 云硬盘备份点配额。表示最大可以保留的备份点数量。
|
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 云硬盘大小，单位GiB。
|
void |
setDiskState(String DiskState)
Set 云盘状态。取值范围：
UNATTACHED：未挂载ATTACHING：挂载中ATTACHED：已挂载DETACHING：解挂中EXPANDING：扩容中ROLLBACKING：回滚中TORECYCLE：待回收DUMPING：拷贝硬盘中。 |
void |
setDiskType(String DiskType)
Set 硬盘介质类型。取值范围：
CLOUD_BASIC：表示普通云硬盘CLOUD_PREMIUM：表示高性能云硬盘CLOUD_BSSD：表示通用型SSD云硬盘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 |
setEncryptType(String EncryptType)
Set 云硬盘加密类型，值为ENCRYPT_V1和ENCRYPT_V2，分别表示第一代和第二代加密技术，两种加密技术互不兼容
|
void |
setErrorPrompt(String ErrorPrompt)
Set 云硬盘最后一次操作错误提示
|
void |
setInstanceId(String InstanceId)
Set 云硬盘挂载的云主机ID。
|
void |
setInstanceIdList(String[] InstanceIdList)
Set 对于非共享型云盘，该参数为空数组。对于共享型云盘，则表示该云盘当前被挂载到的CVM实例InstanceId
|
void |
setInstanceType(String InstanceType)
Set 云硬盘挂载实例的类型。取值范围：
CVMEKS |
void |
setIsReturnable(Boolean IsReturnable)
Set 判断预付费的云盘是否支持主动退还。
true:支持主动退还false:不支持主动退还。 注意：此字段可能返回 null，表示取不到有效值。 |
void |
setKmsKeyId(String KmsKeyId)
Set 加密盘密钥ID
|
void |
setLastAttachInsId(String LastAttachInsId)
Set 云硬盘最后一次挂载的实例ID
注意：此字段可能返回 null，表示取不到有效值。
|
void |
setMigratePercent(Long MigratePercent)
Set 云盘类型变更的迁移进度，取值0到100。
|
void |
setMigrating(Boolean Migrating)
Set 云盘是否处于类型变更中。取值范围：
false:表示云盘不处于类型变更中true:表示云盘已发起类型变更，正处于迁移中。 |
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：不通知过期不自动续费。 |
void |
setReturnFailCode(Long ReturnFailCode)
Set 预付费云盘在不支持主动退还的情况下，该参数表明不支持主动退还的具体原因。取值范围：
1：云硬盘已经退还2：云硬盘已过期3：云盘不支持退还8：超过可退还数量的限制。10：非弹性云硬盘、系统盘、后付费云硬盘等不支持退还 |
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 云盘拥有的快照总容量，单位为MiB。
|
void |
setTags(Tag[] Tags)
Set 与云盘绑定的标签，云盘未绑定标签则取值为空。
|
void |
setThroughputPerformance(Long ThroughputPerformance)
Set 云硬盘额外性能值，单位MiB/s。
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonStringpublic Disk()
public Disk(Disk source)
public Boolean getDeleteWithInstance()
public void setDeleteWithInstance(Boolean DeleteWithInstance)
DeleteWithInstance - 云盘是否与挂载的实例一起销毁。public String getRenewFlag()
public void setRenewFlag(String RenewFlag)
RenewFlag - 自动续费标识。取值范围：public String getDiskType()
public void setDiskType(String DiskType)
DiskType - 硬盘介质类型。取值范围：public String getDiskState()
public void setDiskState(String DiskState)
DiskState - 云盘状态。取值范围：public Long getSnapshotCount()
public void setSnapshotCount(Long SnapshotCount)
SnapshotCount - 云盘拥有的快照总数。public Boolean getAutoRenewFlagError()
public void setAutoRenewFlagError(Boolean AutoRenewFlagError)
AutoRenewFlagError - 云盘已挂载到子机，且子机与云盘都是包年包月。public Boolean getRollbacking()
public void setRollbacking(Boolean Rollbacking)
Rollbacking - 云盘是否处于快照回滚状态。取值范围：public String[] getInstanceIdList()
public void setInstanceIdList(String[] InstanceIdList)
InstanceIdList - 对于非共享型云盘，该参数为空数组。对于共享型云盘，则表示该云盘当前被挂载到的CVM实例InstanceIdpublic Boolean getEncrypt()
public void setEncrypt(Boolean Encrypt)
Encrypt - 云盘是否为加密盘。取值范围：public String getDiskName()
public void setDiskName(String DiskName)
DiskName - 云硬盘名称。public Boolean getBackupDisk()
public void setBackupDisk(Boolean BackupDisk)
BackupDisk - 云硬盘因欠费销毁或者到期销毁时， 是否使用快照备份数据的标识。true表示销毁时创建快照进行数据备份。false表示直接销毁，不进行数据备份。public Tag[] getTags()
public void setTags(Tag[] Tags)
Tags - 与云盘绑定的标签，云盘未绑定标签则取值为空。public String getInstanceId()
public void setInstanceId(String InstanceId)
InstanceId - 云硬盘挂载的云主机ID。public String getAttachMode()
public void setAttachMode(String AttachMode)
AttachMode - 云盘的挂载类型。取值范围：public String[] getAutoSnapshotPolicyIds()
public void setAutoSnapshotPolicyIds(String[] AutoSnapshotPolicyIds)
AutoSnapshotPolicyIds - 云盘关联的定期快照ID。只有在调用[DescribeDisks](/document/product/362/16315)接口时，入参ReturnBindAutoSnapshotPolicy取值为TRUE才会返回该参数。
注意：此字段可能返回 null，表示取不到有效值。public Long getThroughputPerformance()
public void setThroughputPerformance(Long ThroughputPerformance)
ThroughputPerformance - 云硬盘额外性能值，单位MiB/s。public Boolean getMigrating()
public void setMigrating(Boolean Migrating)
Migrating - 云盘是否处于类型变更中。取值范围：public String getDiskId()
public void setDiskId(String DiskId)
DiskId - 云硬盘ID。public Long getSnapshotSize()
public void setSnapshotSize(Long SnapshotSize)
SnapshotSize - 云盘拥有的快照总容量，单位为MiB。public Placement getPlacement()
public void setPlacement(Placement Placement)
Placement - 云硬盘所在的位置。public Boolean getIsReturnable()
public void setIsReturnable(Boolean IsReturnable)
IsReturnable - 判断预付费的云盘是否支持主动退还。public String getDeadlineTime()
public void setDeadlineTime(String DeadlineTime)
DeadlineTime - 云硬盘的到期时间。public Boolean getAttached()
public void setAttached(Boolean Attached)
Attached - 云盘是否挂载到云主机上。取值范围：public Long getDiskSize()
public void setDiskSize(Long DiskSize)
DiskSize - 云硬盘大小，单位GiB。public Long getMigratePercent()
public void setMigratePercent(Long MigratePercent)
MigratePercent - 云盘类型变更的迁移进度，取值0到100。public String getDiskUsage()
public void setDiskUsage(String DiskUsage)
DiskUsage - 云硬盘类型。取值范围：public String getDiskChargeType()
public void setDiskChargeType(String DiskChargeType)
DiskChargeType - 付费模式。取值范围：public Boolean getPortable()
public void setPortable(Boolean Portable)
Portable - 是否为弹性云盘，false表示非弹性云盘，true表示弹性云盘。public Boolean getSnapshotAbility()
public void setSnapshotAbility(Boolean SnapshotAbility)
SnapshotAbility - 云盘是否具备创建快照的能力。取值范围：public Boolean getDeadlineError()
public void setDeadlineError(Boolean DeadlineError)
DeadlineError - 在云盘已挂载到实例，且实例与云盘都是包年包月的条件下，此字段才有意义。public Long getRollbackPercent()
public void setRollbackPercent(Long RollbackPercent)
RollbackPercent - 云盘快照回滚的进度。public Long getDifferDaysOfDeadline()
public void setDifferDaysOfDeadline(Long DifferDaysOfDeadline)
DifferDaysOfDeadline - 当前时间距离云硬盘到期的天数（仅对预付费云硬盘有意义）
注意：此字段可能返回 null，表示取不到有效值。public Long getReturnFailCode()
public void setReturnFailCode(Long ReturnFailCode)
ReturnFailCode - 预付费云盘在不支持主动退还的情况下，该参数表明不支持主动退还的具体原因。取值范围：public Boolean getShareable()
public void setShareable(Boolean Shareable)
Shareable - 云盘是否为共享型云盘。public String getCreateTime()
public void setCreateTime(String CreateTime)
CreateTime - 云硬盘的创建时间。public Long getDeleteSnapshot()
public void setDeleteSnapshot(Long DeleteSnapshot)
DeleteSnapshot - 销毁云盘时删除关联的非永久保留快照。0 表示非永久快照不随云盘销毁而销毁，1表示非永久快照随云盘销毁而销毁，默认取0。快照是否永久保留可以通过[DescribeSnapshots](https://cloud.tencent.com/document/product/362/15647)接口返回的快照详情的IsPermanent字段来判断，true表示永久快照，false表示非永久快照。public Long getDiskBackupQuota()
public void setDiskBackupQuota(Long DiskBackupQuota)
DiskBackupQuota - 云硬盘备份点配额。表示最大可以保留的备份点数量。public Long getDiskBackupCount()
public void setDiskBackupCount(Long DiskBackupCount)
DiskBackupCount - 云硬盘备份点已使用的数量。public String getInstanceType()
public void setInstanceType(String InstanceType)
InstanceType - 云硬盘挂载实例的类型。取值范围：public String getLastAttachInsId()
public void setLastAttachInsId(String LastAttachInsId)
LastAttachInsId - 云硬盘最后一次挂载的实例ID
注意：此字段可能返回 null，表示取不到有效值。public String getErrorPrompt()
public void setErrorPrompt(String ErrorPrompt)
ErrorPrompt - 云硬盘最后一次操作错误提示public Boolean getBurstPerformance()
public void setBurstPerformance(Boolean BurstPerformance)
BurstPerformance - 云盘是否开启性能突发public String getEncryptType()
public void setEncryptType(String EncryptType)
EncryptType - 云硬盘加密类型，值为ENCRYPT_V1和ENCRYPT_V2，分别表示第一代和第二代加密技术，两种加密技术互不兼容public String getKmsKeyId()
public void setKmsKeyId(String KmsKeyId)
KmsKeyId - 加密盘密钥IDCopyright © 2025. All rights reserved.