cbs — Cloud Block Storage
cbs · type
Disk
42 fields
| Field | Type | Description |
|---|---|---|
| DeleteWithInstance | boolean | Whether the cloud disk terminates along with the instance mounted to it. true: Cloud disk will also be terminated when instance terminates, so only hourly postpaid cloud disk are supported. false: Cloud disk does not terminate when instance terminates. |
| RenewFlag | string | Auto renewal flag. Supported values: NOTIFY_AND_AUTO_RENEW: Notify expiry and renew automatically NOTIFY_AND_MANUAL_RENEW: Notify expiry but not renew automatically DISABLE_NOTIFY_AND_MANUAL_RENEW: Neither notify expiry nor renew automatically. |
| DiskType | string | Cloud disk types. Valid values: CLOUD_BASIC: HDD cloud disk CLOUD_PREMIUM: Premium Cloud Disk CLOUD_BSSD: General Purpose SSD CLOUD_SSD: SSD CLOUD_HSSD: Enhanced SSD CLOUD_TSSD: Tremendous SSD |
| DiskState | string | The state of the cloud disk. Value range: UNATTACHED: Not mounted ATTACHING: Mounting ATTACHED: Mounted DETACHING: Un-mounting EXPANDING: Expanding ROLLBACKING: Rolling back TORECYCE: Pending recycling. DUMPING: Copying the hard drive. |
| SnapshotCount | integer | The total number of snapshots of the cloud disk. |
| AutoRenewFlagError | boolean | Cloud disk already mounted to CVM, and both CVM and cloud disk use monthly subscription. true: CVM has auto-renewal flag set up, but cloud disk does not. false: Cloud disk auto-renewal flag set up normally. |
| Rollbacking | boolean | Whether the cloud disk is in the status of snapshot rollback. Value range: false: No true: Yes |
| InstanceIdList | string[] | For non-shareable cloud disks, this parameter is null. For shareable cloud disks, this parameters indicates this cloud disk's Instance IDs currently mounted to the CVM. |
| Encrypt | boolean | Whether the cloud disk is encrypted. Value range: false: Not encrypted true: Encrypted. |
| DiskName | string | Cloud disk name. |
| BackupDisk | boolean | Specifies whether to create a snapshot when the cloud disk is terminated due to overdue payment or expiration. `true`: create snapshot; `false`: do not create snapshot. |
| Tags | Tag[] | The tag bound to the cloud disk. The value Null is used when no tag is bound to the cloud disk. |
| InstanceId | string | ID of the CVM to which the cloud disk is mounted. |
| AttachMode | string | Cloud disk mount method. Valid values: PF: mount as a PF (Physical Function) VF: mount as a VF (Virtual Function) |
| AutoSnapshotPolicyIds | string[] | ID of the periodic snapshot associated to the cloud disk. This parameter is returned only if the value of parameter ReturnBindAutoSnapshotPolicy is TRUE when the API DescribeDisks is called. |
| ThroughputPerformance | integer | Extra performance for a cloud disk, in MB/sec. |
| Migrating | boolean | Whether cloud disk is in process of type change. Value range: false: Cloud disk not in process of type change. true: Cloud disk type change has been launched, and migration is in process. |
| DiskId | string | Cloud disk ID. |
| SnapshotSize | integer | The total capacity of the snapshots of the cloud disk. Unit: MB. |
| Placement | Placement | Location of the cloud disk. |
| IsReturnable | boolean | Determines whether or not prepaid cloud disk supports active return. true: Active return supported. false: Active return not supported. |
| DeadlineTime | string | Expiration time of the cloud disk. |
| Attached | boolean | Whether the cloud disk is mounted to the CVM. Value range: false: Unmounted true: Mounted. |
| DiskSize | integer | Cloud disk size (in GB). |
| MigratePercent | integer | Migration progress of cloud disk type change, from 0 to 100. |
| DiskUsage | string | Cloud disk type. Value range: SYSTEM_DISK: System disk DATA_DISK: Data disk. |
| DiskChargeType | string | Billing method. Value range: PREPAID: Prepaid, that is, monthly subscription POSTPAID_BY_HOUR: Postpaid, that is, pay as you go. |
| Portable | boolean | Whether it is an elastic cloud disk. false: Non-elastic cloud disk; true: Elastic cloud disk. |
| SnapshotAbility | boolean | Whether the cloud disk has the capability to create snapshots. Value range: false: Cannot create snapshots. true: Can create snapshots. |
| DeadlineError | boolean | This field is only applicable when the instance is already mounted to the cloud disk, and both the instance and the cloud disk use monthly subscription. true: Expiration time of cloud disk is earlier than that of the instance. false:Expiration time of cloud disk is later than that of the instance. |
| RollbackPercent | integer | Rollback progress of a cloud disk snapshot. |
| DifferDaysOfDeadline | integer | Number of days from current time until disk expiration (only applicable for prepaid disks). |
| ReturnFailCode | integer | In circumstances where the prepaid cloud disk does not support active return, this parameter indicates the reason that return is not supported. Value range: 1: The cloud disk has already been returned. 2: The cloud disk has already expired. 3: The cloud disk does not support return. 8: The limit on the number of returns is exceeded. |
| Shareable | boolean | Whether or not cloud disk is shareable cloud disk. |
| CreateTime | string | Creation time of the cloud disk. |
| DeleteSnapshot | integer | Delete the associated non-permanently reserved snapshots upon deletion of the source cloud disk. `0`: No (default). `1`: Yes. To check whether a snapshot is permanently reserved, refer to the `IsPermanent` field returned by the `DescribeSnapshots` API. |
| DiskBackupQuota | integer | Quota of cloud disk backup points, i.e., the maximum number of backup points that a cloud disk can have. |
| DiskBackupCount | integer | Number of used cloud disk backups. |
| InstanceType | string | Type of the instance mounted to the cloud disk. Valid values: CVM EKS |
| LastAttachInsId | string | ID of the last instance to which the cloud disk is attached |
| ErrorPrompt | string | Error message for the last operation of the cloud disk |
| BurstPerformance | boolean | Whether the cloud disk has enabled disk bursting. Note: This field may return null, indicating that no valid values can be obtained. |