Data Types

Last updated: 2021-04-06 19:23:38

    AttachDetail

    This describes the number of mounted and mountable data disks of an instance.

    Used by actions: DescribeInstancesDiskNum.

    Name Type Description
    InstanceId String Instance ID
    AttachedDiskCount Integer The number of instances mounted to data disk.
    MaxAttachCount Integer The maximum number of instances that can be mounted to data disk.

    AutoSnapshotPolicy

    This describes the detailed information of the scheduled snapshot policy.

    Used by actions: DescribeAutoSnapshotPolicies, DescribeDiskAssociatedAutoSnapshotPolicy.

    Name Type Description
    AutoSnapshotPolicyId String Scheduled snapshot policy ID.
    AutoSnapshotPolicyName String Scheduled snapshot policy name.
    AutoSnapshotPolicyState String Scheduled snapshot policy state. Value range:
  • NORMAL: Normal
  • ISOLATED: Isolated.
  • IsActivated Boolean Whether scheduled snapshot policy is activated.
    IsPermanent Boolean Whether the snapshot created by this scheduled snapshot policy is retained permanently.
    RetentionDays Integer Number of days the snapshot created by this scheduled snapshot policy is retained.
    CreateTime Timestamp The time the scheduled snapshot policy was created.
    NextTriggerTime Timestamp The time the scheduled snapshot will be triggered again.
    Policy Array of Policy The policy for executing the scheduled snapshot.
    DiskIdSet Array of String The list of cloud disk IDs that the current scheduled snapshot policy is bound to.

    Disk

    The details of a cloud disk

    Used by actions: DescribeDisks.

    Name Type Description
    DiskId String Cloud disk ID.
    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.
    Placement Placement Location of the cloud disk.
    SnapshotAbility Boolean Whether the cloud disk has the capability to create snapshots. Value range:
  • false: Cannot create snapshots. true: Can create snapshots.
  • DiskName String Cloud disk name.
    DiskSize Integer Cloud disk size (in GB).
    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.
  • DiskType String Cloud disk media type. Valid values:
  • CLOUD_BASIC: HDD cloud disk
  • CLOUD_PREMIUM: Premium Cloud Storage
  • CLOUD_SSD: SSD
  • CLOUD_HSSD: Enhanced SSD
  • CLOUD_TSSD: Tremendous SSD
  • Attached Boolean Whether the cloud disk is mounted to the CVM. Value range:
  • false: Unmounted
  • true: Mounted.
  • InstanceId String ID of the CVM to which the cloud disk is mounted.
    CreateTime Timestamp Creation time of the cloud disk.
    DeadlineTime Timestamp Expiration time of the cloud disk.
    Rollbacking Boolean Whether the cloud disk is in the status of snapshot rollback. Value range:
  • false: No
  • true: Yes
  • RollbackPercent Integer Rollback progress of a cloud disk snapshot.
    Encrypt Boolean Whether the cloud disk is encrypted. Value range:
  • false: Not encrypted
  • true: Encrypted.
  • 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.
    Note: This field may return null, indicating that no valid value was found.
  • 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.
    Note: This field may return null, indicating that no valid value was found.
  • 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.
    Note: This field may return null, indicating that no valid value was found.
  • IsReturnable Boolean Determines whether or not prepaid cloud disk supports active return.
  • true: Active return supported.
  • false: Active return not supported.
    Note: This field may return null, indicating that no valid value was found.
  • 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.
    Note: This field may return null, indicating that no valid value was found.
  • AutoSnapshotPolicyIds Array of 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.
    Note: This field may return null, indicating that no valid value was found.
    Tags Array of Tag The tag bound to the cloud disk. The value Null is used when no tag is bound to the cloud disk.
    Note: This field may return null, indicating that no valid value was found.
    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.
    Note: This field may return null, indicating that no valid value was found.
  • DifferDaysOfDeadline Integer Number of days from current time until disk expiration (only applicable for prepaid disks).
    Note: This field may return null, indicating that no valid value was found.
    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.
    Note: This field may return null, indicating that no valid value was found.
  • MigratePercent Integer Migration progress of cloud disk type change, from 0 to 100.
    Note: This field may return null, indicating that no valid value was found.
    Shareable Boolean Whether or not cloud disk is shareable cloud disk.
    InstanceIdList Array of String For non-shareable cloud disks, this parameter is null. For shareable cloud disks, this parameters indicates this cloud disk's Instance IDs