Help & DocumentationCloud Block StorageAPI DocumentationData Types

Data Types

Last updated: 2020-02-18 16:45:42

PDF

Contents：

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 Type of cloud disk medium. Value range:
  • CLOUD_BASIC: Ordinary cloud disk
  • CLOUD_PREMIUM: Premium cloud storage
  • CLOUD_SSD: SSD cloud disk.
    		•
    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 currently mounted to the CVM.
    SnapshotCount Integer The total number of snapshots of the cloud disk.
    SnapshotSize Integer The total capacity of the snapshots of the cloud disk. Unit: MB.
    BackupDisk Boolean Indicates whether a snapshot should be created for backup when the cloud disk is terminated due to arrears or expiration. True: create a snapshot to backup the disk upon termination. False: terminate the disk without backup

    DiskChargePrepaid

    The billing method of an instance

    Used by actions: CreateDisks、InquiryPriceCreateDisks、InquiryPriceRenewDisks、ModifyDisksChargeType.

    Name Type Required Description
    Period Integer Yes The purchased usage period of a cloud disk (in months). Value range: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    RenewFlag String No Auto Renewal flag. Value range:
  • NOTIFY_AND_AUTO_RENEW: Notify expiry and renew automatically
  • NOTIFY_AND_MANUAL_RENEW: Notify expiry but do not renew automatically
  • DISABLE_NOTIFY_AND_MANUAL_RENEW: Neither notify expiry nor renew automatically

    Default value range: NOTIFY_AND_MANUAL_RENEW: Notify expiry but do not renew automatically.
    		•
    CurInstanceDeadline Timestamp No This parameter is used when you align the expiration time of the cloud disk with that of the mounted server. It is the current expiration time of the server. In this case, the Period passed represents the renewal period of the server, and the cloud disk will be automatically renewed in alignment with the expiration time of the renewed server. Example value: 2018-03-30 20:15:03.

    DiskConfig

    Cloud disk configuration.

    Used by actions: DescribeDiskConfigQuota.

    Name Type Description
    Available Boolean Whether the configuration is available.
    DiskType String Type of cloud disk medium. Value range:
  • CLOUD_BASIC: Ordinary cloud disk
  • CLOUD_PREMIUM: Premium cloud storage
  • CLOUD_SSD: SSD cloud disk.
    		•
    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.
    		•
    MaxDiskSize Integer The maximum configurable cloud disk size (in GB).
    MinDiskSize Integer The minimum configurable cloud disk size (in GB).
    Zone String The Availability Region of the cloud drive.
    DeviceClass String Instance model.
    Note: This field may return null, indicating that no valid value was found.
    InstanceFamily String Instance model series. For more information, please see Instance Models
    Note: This field may return null, indicating that no valid value was found.

    DiskOperationLog

    The operation log of the cloud disk.

    Used by actions: DescribeDiskOperationLogs.

    Name Type Description
    Operator String UIN of operator.
    Operation String Operation type. Value range:
    CBS_OPERATION_ATTACH: Mount cloud disk
    CBS_OPERATION_DETACH: Unmount cloud disk
    CBS_OPERATION_RENEW: Renew
    CBS_OPERATION_EXPAND: Expand
    CBS_OPERATION_CREATE: Create
    CBS_OPERATION_ISOLATE: Isolate
    CBS_OPERATION_MODIFY: Modify cloud disk attributes
    ASP_OPERATION_BIND: Associate scheduled snapshot policy
    ASP_OPERATION_UNBIND: Cancel associated scheduled snapshot policy
    DiskId String Cloud disk ID of operation.
    OperationState String Status of operation. Value range:
    SUCCESS: Operation successful
    FAILED: Operation failed
    PROCESSING: Operation in process
    StartTime String Start time
    EndTime String End time

    Filter

    Key-value pair filters for conditional filtering queries.

    Used by actions: DescribeAutoSnapshotPolicies、DescribeDiskOperationLogs、DescribeDisks、DescribeSnapshotOperationLogs、DescribeSnapshots.

    Name Type Required Description
    Name String Yes Name of filter key.
    Values Array of String Yes One or more filter values.

    Image

    Image

    Used by actions: DescribeSnapshots.

    Name Type Description
    ImageId String Image instance ID.
    ImageName String Image name.

    Placement

    This describes the abstract location of the instance, including the availability zone in which it is located, the projects to which it belongs, and the ID and name of the dedicated clusters to which it belongs.

    Used by actions: CreateDisks、DescribeDisks、DescribeSnapshots.

    Name Type Required Description
    Zone String Yes The ID of the Availability Zone to which the cloud disk belongs. This parameter can be obtained from the Zone field in the returned values of DescribeZones.
    ProjectId Integer No ID of the project to which the instance belongs. This parameter can be obtained from the projectId field in the returned values of DescribeProject. If this is left empty, default project is used.
    CdcId String No ID of dedicated cluster which the instance belongs to. When it is an input parameter, the specified CdcId dedicated cluster resource is operated, and it can be left blank. When it is an output parameter, it is the ID of the dedicated cluster which the resource belongs to, and it can be left blank.
    Note: This field may return null, indicating that no valid value was found.
    CageId String No Cage ID. When it is an input parameter, the specified CageID resource is operated, and it can be left blank. When it is an output parameter, it is the ID of the cage the resource belongs to, and it can be left blank.
    Note: This field may return null, indicating that no valid value was found.
    CdcName String No Dedicated cluster name. When it is an input parameter, it is ignored. When it is an output parameter, it is the name of the dedicated cluster the cloud disk belongs to, and it can be left blank.
    Note: This field may return null, indicating that no valid value was found.

    Policy

    Describes the execution policy for scheduled snapshots. This can be understood as that, on the days specified by DayOfWeek, the scheduled snapshot policy is executed at the hour specified by Hour.

    Used by actions: CreateAutoSnapshotPolicy、DescribeAutoSnapshotPolicies、DescribeDiskAssociatedAutoSnapshotPolicy、ModifyAutoSnapshotPolicyAttribute.

    Name Type Required Description
    DayOfWeek Array of Integer Yes Specifies the days of the week, from Monday to Sunday, on which a scheduled snapshot will be triggered. Value range: [0, 6]. 0 indicates triggering on Sunday, 1-6 indicate triggering on Monday-Saturday.
    Hour Array of Integer Yes Specifies the time that that the scheduled snapshot policy will be triggered. The unit is hour. The value range is [0-23]. 00:00-23:00 is a total of 24 time points that can be selected. 1 indicates 01:00, and so on.

    PrepayPrice

    The cost of a prepaid order.

    Used by actions: InquiryPriceRenewDisks、InquiryPriceResizeDisk.

    Name Type Description
    OriginalPrice Float Original price of the advanced payment for a prepaid cloud disk or snapshot (in CNY).
    DiscountPrice Float Discount price of the advanced payment for a prepaid cloud disk or snapshot (in CNY).

    Price

    Describes the prepaid or postpaid price for the cloud disk.

    Used by actions: InquiryPriceCreateDisks.

    Name Type Description
    OriginalPrice Float Original price of the advanced payment for a prepaid cloud disk (in CNY).
    Note: This field may return null, indicating that no valid value was found.
    DiscountPrice Float Discount price of the advanced payment for a prepaid cloud disk (in CNY).
    Note: This field may return null, indicating that no valid value was found.
    UnitPrice Float Original unit price of a postpaid cloud disk (in CNY).
    Note: This field may return null, indicating that no valid value was found.
    ChargeUnit String Billing unit of a postpaid cloud disk. Value range:
  • HOUR: Billed by hour.
    Note: This field may return null, indicating that no valid value was found.
    		•
    UnitPriceDiscount Float Postpaid cloud disk discount price. Unit: CNY.
    Note: This field may return null, indicating that no valid value was found.

    SharePermission

    Snapshot sharing information set

    Used by actions: DescribeSnapshotSharePermission.

    Name Type Description
    CreatedTime Timestamp Snapshot sharing time
    AccountId String ID of the shared account

    Snapshot

    The details of a snapshot

    Used by actions: DescribeSnapshots.

    Name Type Description
    SnapshotId String Snapshot ID.
    Placement Placement Location of the snapshot.
    DiskUsage String The type of the cloud disk used to create the snapshot. Value range:
  • SYSTEM_DISK: System disk
  • DATA_DISK: Data disk.
    		•
    DiskId String ID of the cloud disk used to create this snapshot.
    DiskSize Integer Size of the cloud disk used to create this snapshot (in GB).
    SnapshotState String Status of the snapshot. Value range:
  • NORMAL: Normal
  • CREATING: Creating
  • ROLLBACKING: Rolling backing
  • COPYING_FROM_REMOTE: Copying snapshot across regions.
    		•
    SnapshotName String Snapshot name, the user-defined snapshot alias. Call ModifySnapshotAttribute to modify this field.
    Percent Integer The progress percentage for snapshot creation. This field is always 100 after the snapshot is created successfully.
    CreateTime Timestamp Creation time of the snapshot.
    DeadlineTime Timestamp The expiration time of the snapshot. If the snapshot is permanently retained, this field is blank.
    Encrypt Boolean Whether the snapshot is created from an encrypted disk. Value range:
  • true: Yes
  • false: No.
    		•
    IsPermanent Boolean Whether it is a permanent snapshot. Value range:
  • true: Permanent snapshot
  • false: Non-permanent snapshot.
    		•
    CopyingToRegions Array of String The destination region to which the snapshot is being replicated. Default value is [ ].
    CopyFromRemote Boolean Whether the snapshot is replicated across regions. Value range:
  • true: Indicates that the snapshot is replicated across regions.
  • false: Indicates that the snapshot belongs to the local region.
    		•
    Images Array of Image List of images associated with snapshot.
    ImageCount Integer Number of images associated with snapshot.
    SnapshotType String Snapshot type. This value can currently be either PRIVATE_SNAPSHOT or SHARED_SNAPSHOT.
    ShareReference Integer Number of snapshots currently shared

    SnapshotOperationLog

    The snapshot operation log.

    Used by actions: DescribeSnapshotOperationLogs.

    Name Type Description
    Operator String UIN of operator.
    Note: This field may return null, indicating that no valid value was found.
    Operation String Operation type. Value range:
    SNAP_OPERATION_DELETE: Delete snapshot
    SNAP_OPERATION_ROLLBACK: Roll back snapshot
    SNAP_OPERATION_MODIFY: Modify snapshot attributes
    SNAP_OPERATION_CREATE: Create snapshot
    SNAP_OPERATION_COPY: Cross-region replication of snapshot
    ASP_OPERATION_CREATE_SNAP: Create snapshot with scheduled snapshot policy
    ASP_OPERATION_DELETE_SNAP: Delete snapshot from scheduled snapshot policy
    SnapshotId String ID of snapshot being operated.
    OperationState String Status of operation. Value range:
    SUCCESS: Operation successful
    FAILED: Operation failed
    PROCESSING: Operation in process
    StartTime String Start time
    EndTime String End time

    Tag

    Tag.

    Used by actions: CreateDisks、DescribeDisks.

    Name Type Required Description
    Key String Yes Tag key.
    Value String Yes Tag value.