Tenant Cloud Storage Cloud Block Storage Data structure

Data structure

Last Updated At: 2026-08-02 00:04:26

ApplyDisk

This parameter is used as the input for the snapshot group rollback API, indicating the cloud disk to be rolled back, and the snapshot list.

Referenced by the following interfaces: ApplySnapshotGroup

name required NULL allowed type description
SnapshotId yes no String Snapshot ID
Example: snap-cznei4gl
DiskId yes no String Original Cloud Disk ID for Snapshot
Example: disk-1ly0wu8c

ResourcesDetail

It describes the details of the user resource.

Referenced by the following interfaces: DescribeUserDiskResources

name required NULL allowed type description
Region yes no String Resource region.
Example: region1
SnapshotNumberTotal yes no Uint64 Snapshot user quantity quota.
Example: 99
SnapshotNumberUsed yes no Uint64 Number of used snapshots.
Example: 29
SnapshotCapacityTotal yes no Uint64 Snapshot capacity quota.
Example: 13
SnapshotCapacityUsed yes no Uint64 Used snapshot capacity (in GB).
Example: 425
DiskNumber yes no Int64 Number of cloud disks.
Example: 14
NewDiskFlag yes no Bool It indicates whether the current region includes newly purchased cloud disks.
Example: true
SnapshotSupportCrossCopy yes no Bool It indicates whether the current region supports cross-region replication
Example: false
DiskNumberIsolated yes no Uint64 Number of cloud disks in the recycle bin.
Example: 0
ExpiredNumber yes no Int64 Number of expired cloud disks.
Example: 0
DiskNumberExpireIn7days yes no Int64 Number of cloud disks that will expire within 7 days.
Example: 0
DiskNumberUnderDataProtection yes no Int64 Number of protected cloud disks.
Example: 0

Policy

It describes the execution strategy of regular snapshots.

Referenced by the following interfaces: CreateAutoSnapshotPolicy, DescribeAutoSnapshotPolicies, DescribeCopyAutoSnapshotPolicy, DescribeDiskAssociatedAutoSnapshotPolicy, ModifyAutoSnapshotPolicyAttribute

name required NULL allowed type description
DayOfWeek no no Array of Uint64 Selects a day from Monday to Sunday to create snapshots. The value range is from 0 to 6. 0 indicates triggered on Monday, and so on.
Example: [0,1,2]
Hour yes no Array of Uint64 It specifies the trigger time for the regular snapshot policy in the unit of hours. The value range is from 0 to 23. A total of 24 options from 00:00 to 23:00 are available, with 1 indicating 01:00, and so on.
Example: [11,12,13]
IntervalDays no no Uint64 Specifies the interval days for creating automatic snapshots. Value range: [1, 365]. For example, if it is set to 5, creating a automatic snapshot will be triggered every 5 days. Note: When you choose daily backups, theoretically, the time for the first backup is on the day when the backup policy is created. If the time of policy creation on that day is later than the specified backup time, the first backup occurs on the second backup cycle.
Example: 50
DayOfMonth no no Array of Uint64 Specified days in each month to trigger snapshot creation.
Example: [0]

Tag

Tag.

Referenced by the following interfaces: CreateDisks, CreateSnapshot, DescribeAutoSnapshotPolicies, DescribeCopyAutoSnapshotPolicy, DescribeDiskAssociatedAutoSnapshotPolicy, DescribeDiskAssociatedSnapshots, DescribeDisks, DescribeSnapshotGroups, DescribeSnapshots, DescribeSnapshotsInternal, SwitchParameterCreateDisks

name required NULL allowed type description
Key yes no String Tag key.
Example: TagKey
Value yes no String Tag value.
Example: TagValue

GoodsDetail

Product details.

Referenced by the following interfaces: SwitchParameterCreateDisks, SwitchParameterRenewDisks, SwitchParameterResizeDisk

name required NULL allowed type description
TimeSpan no no Uint64 Duration for purchasing or renewing a cloud disk.
Example: 1
Pid no no Uint64 Product ID.
Example: 99903
DiskType no no String It indicates the cloud disk type. Options are system disk or data disk.
Example: CLOUD_TSSD
ProductInfo no no Array of ProductInfo Product information description.
Example:View
MediumType no no String Cloud disk media type.
Example: CLOUD_HSSD
TimeUnit no no String Unit of duration "TimeSpan".
Example: m
CbsSize no no Uint64 Cloud disk size.
Example: 50

Filter

It describes the key-value pair filter, used for conditional filter query.

Referenced by the following interfaces: DescribeAutoSnapshotPolicies, DescribeCopyAutoSnapshotPolicy, DescribeDisks, DescribeSnapshotGroups, DescribeSnapshots, DescribeSnapshotsInternal

name required NULL allowed type description
Name yes no String Filter key name.
Example: snapshot-id
Values yes no Array of String One or more filter values.
Example: snap-9asdgcsq

SnapshotGroup

It describes the snapshot group details.

Referenced by the following interfaces: DescribeSnapshotGroups

name required NULL allowed type description
SnapshotGroupId yes no String Snapshot Group ID
Example: csnap-csoplz7u
SnapshotGroupType yes yes String Snapshot group type. NORMAL: common snapshot group, non-consistency snapshot
Example: NORMAL
ContainRootSnapshot yes yes Bool It indicates whether the snapshot group includes a system disk snapshot.
Example: true
SnapshotIdSet yes no Array of String ID List of Snapshots in Snapshot Group
Example: ["snap-31gfd8na"]
SnapshotGroupState yes yes String Snapshot group status.
  • NORMAL: Normal
  • CREATING: Creating
  • DELETED: Deleted
  • FAILED: Creation failed
  • DISMISS: Dismissed
  • ROLLBACKING: Rolling back
    Example: NORMAL
    		•
    Percent yes yes Uint64 Snapshot Group Creation Progress
    Example: 100
    CreateTime yes yes String Creation Time
    Example: 2022-05-25T12:14:53.243893+08:00
    ModifyTime yes yes String Last Modification Time
    Example: 2022-05-25T12:14:53.243893+08:00
    Images yes no Array of Image List of Images Associated with Snapshot Group
    Example:View
    SnapshotGroupName yes yes String Snapshot Group Name
    Example: snp092101
    ImageCount yes yes Uint64 Number of Images Associated with Snapshot Group
    Example: 0
    LatestOperationState yes yes String Result of Last Executed Asynchronous Task
    Example: SUCCESS
    LatestOperationRequestId yes yes String It indicates the API RequestId corresponding to the last executed asynchronous task.
    Example: 597205a3-68c8-4f8a-bd3d-91cf0fa5a46c
    LatestOperation yes yes String Last Executed Asynchronous Task Operation
    Example: ApplySnapshot
    OperationFailedResourceIdSet yes yes Array of String List of Resources for Which Last Asynchronous Task Operation Failed
    Example: snap-dwi9zt6l
    OperationSuccessResourceIdSet yes yes Array of String List of Successfully Operated Resources in Last Asynchronous Operation
    Example: snap-phsfv2l3
    ErrorPrompt yes yes String Prompt Code of Last Asynchronous Operation Result
    Example: SUCCESS
    IsPermanent yes yes Bool Whether the snapshots copied across regions are retained permanently. The default value is True, indicating the snapshots are retained permanently. Currently, this parameter is only valid for snapshots automatically initiated by ASP. Snapshots initiated by users are retained permanently by default.
    Example: true
    DeadlineTime yes yes Datetime_iso Deadline
    Example: 2022-05-25T12:14:53.243893+08:00
    Tags yes no Array of Tag Tag Value
    Example:View

    DiskResizeConfig

    Cloud disk scaling configuration. It is used for the output of the SwitchParameterResizeDisk API.

    Referenced by the following interfaces: SwitchParameterModifyDiskAttributes

    name required NULL allowed type description
    Pid yes no Uint64 Product ID.
    Example: 8000
    CbsSize yes no Uint64 Cloud disk size.
    Example: 50
    MediumType yes no String Cloud disk media type.
    Example: CbsPremium

    SnapOverview

    User snapshot information overview. It includes the total number and total capacity of created snapshots.

    Referenced by the following interfaces: DescribeUserDiskResources

    name required NULL allowed type description
    SnapshotCapacityUsedTotal yes no Float Total snapshot capacity created by the user.
    Example: 0.0
    SnapshotNumberUsedTotal yes no Int64 Total number of snapshots created by the user.
    Example: 24

    DiskConfig

    Cloud disk configuration.

    Referenced by the following interfaces: DescribeDiskConfigQuota

    name required NULL allowed type description
    Available no no Bool Whether the configuration is available.
    Example: false
    DiskType no no String Cloud disk media type. Value range:
  • CLOUD_BASIC: standard cloud disk
  • CLOUD_PREMIUM: high-performance cloud disk
  • CLOUD_SSD: SSD cloud disk
    Example: CLOUD_BASIC
    		•
    DiskUsage no no String Cloud disk type. Value range:
  • SYSTEM_DISK: system disk
  • DATA_DISK: data disk.
    Example: DATA_DISK
    		•
    DiskChargeType no no String Payment mode. Value range:
  • PREPAID: Indicates prepaid, that is, monthly subscriptions
  • POSTPAID_BY_HOUR: Indicates postpaid, that is, pay-as-you-go.
    Example: POSTPAID_BY_HOUR
    		•
    MaxDiskSize no no Uint64 Maximum configurable cloud disk size.
    Example: 32000
    MinDiskSize no no Uint64 Minimum configurable cloud disk size.
    Example: 10
    Zone no no String Availability zone.
    Example: ap-region1-2
    DeviceClass no yes String Instance model.
    Example: VSELF_2
    InstanceFamily no yes String Instance model series. For details, see the instance types.
    Example: N1
    StepSize yes yes Uint64 Step length
    Example: 10
    ExtraPerformanceRange no yes Array of Int64 Additional performance range.
    Example: 0
    RecommendDiskSize no yes Uint64 Recommended size for the current type of cloud disk, in GB.
    Example: 100

    AdvancedRetentionPolicy

    Advanced Snapshot Retention Policy

    Referenced by the following interfaces: CreateAutoSnapshotPolicy, DescribeAutoSnapshotPolicies, DescribeCopyAutoSnapshotPolicy, DescribeDiskAssociatedAutoSnapshotPolicy, ModifyAutoSnapshotPolicyAttribute

    name required NULL allowed type description
    Days no yes Uint64 The latest snapshot of each day within Days is retained.
    Example: 6
    Weeks no yes Uint64 The latest snapshot of each week within Weeks is retained.
    Example: 8
    Months no yes Uint64 The latest snapshot of each month within Months is retained.
    Example: 3
    Years no yes Uint64 The latest snapshot of each year within Years is retained.
    Example: 1

    SharePermission

    Snapshot Sharing Information Set

    Referenced by the following interfaces: DescribeSnapshotSharePermission

    name required NULL allowed type description
    CreatedTime yes no Datetime Time of Snapshot Sharing
    Example: 2023-02-26 01:21:03
    AccountId yes no String Shared Account ID
    Example: 100022975249

    Disk

    It describes the details of the cloud disk.

    Referenced by the following interfaces: DescribeDisks

    name required NULL allowed type description
    DiskId no no String Cloud disk ID.
    Example: disk-pe1vkgim
    DiskUsage no no String Cloud disk type. Value range:
  • SYSTEM_DISK: system disk
  • DATA_DISK: data disk.
    Example: SYSTEM_DISK
    		•
    DiskChargeType no no String Payment MODE. Value range:
  • PREPAID: prepaid, that is, monthly subscription
  • POSTPAID_BY_HOUR: postpaid, that is, pay-as-you-go.
    Example: PREPAID
    		•
    Portable no no Bool It indicates whether it is an elastic cloud disk. The value false indicates non-elastic cloud disk, and the value true indicates elastic cloud disk.
    Example: true
    Placement no no Placement Location of a cloud disk.
    Example:View
    SnapshotAbility no no Bool It indicates whether the cloud disk has the capability to create a snapshot. Value range:
  • false: Do not have this capacity
  • true: Have this capacity.
    Example: true
    		•
    DiskName no no String Cloud disk name.
    Example: unname
    DiskSize no no Uint64 Cloud disk size.
    Example: 50
    DiskState no no String Cloud disk status. Value range:
  • UNATTACHED: Unmounted
  • ATTACHING: Mounting
  • ATTACHED: Mounted
  • DETACHING: Unmounting
  • EXPANDING: Expanding
  • ROLLBACKING: Rolling back.
    Example: UNATTACHED
    		•
    DiskType no no String It indicates the type of cloud disk media. Value range:
  • CLOUD_BASIC: Indicates a basic cloud disk.
  • CLOUD_PREMIUM: Indicates a high-performance cloud disk.
  • CLOUD_SSD: Indicates an SSD cloud disk.
    Example: CLOUD_SSD
    		•
    Attached no no Bool It indicates whether the cloud disk is mounted to the cloud host. Value range:
  • false: Not mounted
  • true: Mounted.
    Example: false
    		•
    InstanceId no no String ID of the cloud host to which the cloud disk is mounted.
    Example: ins-9oxguxa
    CreateTime no no String Creation time of cloud disks.
    Example: 2021-01-01 12:00:00
    DeadlineTime no no String Expiration time of cloud disks.
    Example: 2021-02-01 12:00:00
    Rollbacking no no Bool It indicates whether the cloud disk is in snapshot rollback status. Value range:
  • false: It is not in snapshot rollback status
  • true: It is in snapshot rollback status.
    Example: false
    		•
    RollbackPercent no no Uint64 Progress of cloud disk snapshot rollback.
    Example: 0
    Encrypt no no Bool It indicates whether the cloud disk is encrypted. Value range:
  • false: Indicates an unencrypted disk.
  • true: Indicates an encrypted disk.
    Example: false
    		•
    AutoRenewFlagError no no Bool The cloud disk has been mounted to the child machine, and both the child machine and the cloud disk are on a monthly subscription basis.
  • true: The auto renewal flag is set to the child machine but not to the cloud disk.
  • false: The cloud disk's auto-renewal flag is normal.
    Example: true
    		•
    RenewFlag no no String Auto renewal flag. Value range:
  • NOTIFY_AND_AUTO_RENEW: Notify that the account is about to expire and automatically renew the account.
  • NOTIFY_AND_MANUAL_RENEW: Notify that the account is about to expire but do not automatically renew the account.
  • DISABLE_NOTIFY_AND_MANUAL_RENEW: Neither notify that the account is about to expire nor automatically renew the account.
    Example: NOTIFY_AND_AUTO_RENEW
    		•
    DeadlineError no no Bool This field is valid only when the cloud disk is mounted to the instance, and both the instance and the cloud disk are on a monthly subscription basis.
  • true: The expiration time of the cloud disk is earlier than that of the instance.
  • false: The expiration time of the cloud disk is later than that of the instance.
    Example: true
    		•
    IsReturnable no yes Bool It determines if a prepaid cloud disk supports proactive return.
  • true: It supports proactive return.
  • false: It does not support proactive return.
    Example: true
    		•
    ReturnFailCode no yes Uint64 For prepaid cloud disks that do not support proactive returns, this parameter indicates the specific reason for the lack of support. Value range:
  • 1: The cloud disk has been returned.
  • 2: The cloud disk has expired.
  • 3: The cloud disk does not support return.
  • 8: The maximum number that can be returned is exceeded.
    Example: 10
    		•
    AutoSnapshotPolicyIds no yes Array of String Regular snapshot ID associated with the cloud disk. This parameter is only returned when the DescribeDisks API is called and ReturnBindAutoSnapshotPolicy is set to TRUE.
    Example: ["asp-ljylgbyo"]
    Tags yes yes Array of Tag It indicates the tag bound to the cloud disk. If the cloud disk is not bound to any tag, the value is empty.
    Example:View
    DeleteWithInstance yes yes Bool It indicates whether the cloud disk is destroyed along with the mounted instance.
  • true: The cloud disk is destroyed along with the instance. Only hourly postpaid cloud disks are supported.
  • false: The cloud disk is not destroyed when the instance is destroyed.
    Example: false
    		•
    DifferDaysOfDeadline yes yes Int64 Days until disk expiration (only valid for prepaid disks).
    Example: 20
    Migrating yes yes Bool It indicates whether the cloud disk currently is undergoing a type change. Value range:
  • false: Indicates the cloud disk is not undergoing a type change.
  • true: Indicates the cloud disk has initiated a type change and is in the process of migrating.
    Example: false
    		•
    MigratePercent yes yes Uint64 It indicates the migration progress of cloud disk type change. The value range is 0 to 100.
    Example: 0
    Shareable yes yes Bool Is the cloud disk a shared cloud disk.
    Example: false
    InstanceIdList yes yes Array of String For non-shared cloud disks, this parameter is an empty array. For shared cloud disks, it indicates the CVM instance ID to which the cloud disk is currently mounted.
    Example: ["ins-9oxguxa"]
    SnapshotCount yes yes Int64 Total number of snapshots owned by the cloud disk.
    Example: 0
    SnapshotSize yes yes Uint64 Total snapshot capacity of the cloud disk, in MB.
    Example: 0
    PlatformProjectId yes yes String Project ID
    Example: pr-42749a13
    BackupDisk yes yes Bool When a cloud disk is destroyed due to overdue or expiration, the flag indicates whether to use snapshot backup data. The value true indicates creating a snapshot for data backup on destruction. The value false indicates direct destruction without data backup.
    Example: true
    InstanceType yes yes String Model of Child Machine to Which Disk Mounted
    Example: CVM
    DiskStoragePoolGroup yes yes String Resource Pool to Which Disk Belongs
    Example: pool-ec
    LatestOperationRequestId yes yes String It indicates the API RequestId corresponding to the last executed asynchronous task.
    Example: 597205a3-68c8-4f8a-bd3d-91cf0fa5a46c
    ThroughputPerformance yes yes Uint64 Additional cloud disk performance value (in MB/s).
    Example: 0
    LatestOperation yes yes String Last executed asynchronous task operation.
    Example: ApplySnapshot
    LastAttachInsId yes yes String ID of Last Cloud Virtual Machine to Which Cloud Disk Mounted
    Example: ins-9oxguxa
    LatestOperationState yes yes String Result of the last executed asynchronous task.
    Example: SUCCESS
    DeleteSnapshot yes yes Int64 Delete associated non-permanently retained snapshots when destroying the cloud disk. 0 indicates non-permanent snapshots are not deleted with cloud disk destruction, 1 indicates non-permanent snapshots are deleted with cloud disk destruction, and the default value is 0. Whether a snapshot is permanently retained is determined by the IsPermanent field in the snapshot details returned by the DescribeSnapshots API. The value true indicates permanent snapshot, and the value false indicates non-permanent snapshot.
    Example: 0
    ErrorPrompt yes yes String Error Message Returned to User upon Failure
    Example: "SUCCESS"
    EncryptAlgorithm yes yes String Encryption algorithm type. SM4: National Standard; AES256: Non-National Standard
    Example: SM4
    DiskBackupQuota no yes Uint64 Quota of cloud disk backup points. It indicates the maximum number of backup points that can be retained for a cloud disk.
    Example: 0
    DiskBackupCount no yes Uint64 Number of cloud disk backup points used.
    Example: 0
    BurstPerformance no yes Bool Whether performance burst is enabled for the cloud disk.
    Example: false

    DetailPrice

    Price of a prepaid or postpaid cloud disk.

    Referenced by the following interfaces: InquirePriceModifyDiskExtraPerformance, InquiryPriceCreateDisks, InquiryPriceCreateSnapshots, InquiryPriceModifyDiskAttributes, InquiryPriceRenewDisks, InquiryPriceResizeDisk

    name required NULL allowed type description
    PriceTitle no yes String Name of a billable item.
    Example: DiskSpace
    PriceName no yes String Name of the billable item, which is displayed in the user console.
    Example: CBS space
    OriginalPrice no yes Float Original price of a prepaid cloud disk, in USD.
    Example: 100.0
    DiscountPrice no yes Float Discounted price of a prepaid cloud disk, in USD.
    Example: 100.0
    UnitPrice no yes Float Original unit price of postpaid cloud disks (in USD).
    Example: 10.0
    UnitPriceDiscount no yes Float Discounted unit price of postpaid cloud disks (in USD).
    Example: 10.0
    ChargeUnit no yes String Billing unit for a postpaid cloud disk. Valid value: HOUR: indicates that the billing unit of a postpaid cloud disk is hour.
    Example: HOUR
    OriginalPriceHigh no yes String Original price of a high-precision prepaid cloud disk, in USD.
    Example: 100
    DiscountPriceHigh no yes String Discounted price of a high-precision prepaid cloud disk, in USD.
    Example: 100
    UnitPriceHigh no yes String Original unit price of a high-precision postpaid cloud disk, in USD.
    Example: 100
    UnitPriceDiscountHigh no yes String Discounted unit price of a high-precision postpaid cloud disk, in USD.
    Example: 100

    ResizeGoodsDetail

    Product renewal details. It is only used for the SwitchParameterResizeDisks API.

    Referenced by the following interfaces: SwitchParameterModifyDiskAttributes

    name required NULL allowed type description
    Pid yes no Uint64 Product ID.
    Example: 8000
    ResourceId yes no String Cloud disk ID.
    Example: disk-7q2iy7gp
    CurDeadline yes no String Current expiration time of the cloud disk.
    Example: 2023-03-21 12:00:00
    ProductInfo yes no Array of ProductInfo Product information description.
    Example:View
    NewConfig yes no DiskResizeConfig Cloud disk configuration after scaling.
    Example:View
    OldConfig yes no DiskResizeConfig Configuration before cloud disk scaling.
    Example:View

    SnapshotGroupDeniedAction

    Operation Mask of Single Snapshot Group

    Referenced by the following interfaces: DescribeSnapshotGroupsDeniedActions

    name required NULL allowed type description
    SnapshotGroupId yes no String Snapshot Group ID
    Example: csnap-csoplz7u
    DeniedActions yes no Array of DeniedAction Specific Operation Mask Information for Snapshot
    Example:View

    ProductInfo

    It describes the product information output by the order parameter conversion API.

    Referenced by the following interfaces: SwitchParameterCreateDisks, SwitchParameterModifyDiskAttributes, SwitchParameterRenewDisks, SwitchParameterResizeDisk

    name required NULL allowed type description
    Name yes no String Attribute name.
    Example: CBS instance alias
    Value yes no String Attribute value.
    Example: Unnamed

    ResizeDiskOrder

    Order parameters for request billing (scaling).

    Referenced by the following interfaces: SwitchParameterModifyDiskAttributes

    name required NULL allowed type description
    GoodsCategoryId yes no Uint64 Product category.
    Example: 100000
    GoodsNum yes no Uint64 Number of products.
    Example: 1
    ProjectId yes no Uint64 Project ID.
    Example: 0
    GoodsDetail yes no ResizeGoodsDetail Product details.
    Example:View
    RegionId yes no Uint64 Region ID.
    Example: 10
    ZoneId yes no Uint64 Availability zone ID.
    Example: 100001
    PayMode yes no Uint64 Payment mode.
    Example: 1
    Type yes yes String Cloud disk type.
    Example: cbs
    SubProductCode yes yes String Sub-product ID.
    Example: sp_cbs_snr

    DeniedAction

    API That Cannot Be Executed by Cloud Disk

    Referenced by the following interfaces: DescribeDisksDeniedActions, DescribeSnapshotGroupsDeniedActions, DescribeSnapshotsDeniedActions

    name required NULL allowed type description
    Action yes no String Name of the inoperable API. For example, when you query the cloud disk list "DescribeDisks"; for multipurpose APIs, the response is in the form of "API name.input parameter", such as "ModifyDiskAttributes.DiskType".
    Example: DetachDisks
    Message yes no String Reason Why the API Cannot Be Operated
    Example: Only mounted elastic data disks support uninstallation.
    Code yes no String Error Code for API Operation Failure
    Example: ResourceUnavailable.NotSupported

    DiskStoragePoolGroupInfo

    Storage Pool Group of Cloud Disk

    Referenced by the following interfaces: DescribeDiskStoragePoolGroups

    name required NULL allowed type description
    DiskStoragePoolGroupName yes no String Name of Storage Resource Group
    Example: ec
    PoolBoundType yes no String Binding type
    Example: OPTIONAL
    DiskStoragePoolGroup yes no String Storage Resource Pool Group
    Example: pool-ec
    Zone yes no String Availability Zone
    Example: az1
    DiskType yes no String Cloud disk type
    Example: CLOUD_TSSD
    Available yes no Bool Sold Out or Not
    Example: true
    Message yes no String Sell-out Information
    Example: ""
    PoolCustomAttributes no yes PoolCustomAttributes It describes the CPU information of the resource pool.
    Example:View

    DiskChargePrepaid

    It describes the instance billing mode.

    Referenced by the following interfaces: CreateDisks, InquiryPriceCreateDisks, InquiryPriceCreateSnapshots, InquiryPriceRenewDisks, RenewDisk, SwitchParameterCreateDisks, SwitchParameterRenewDisks

    name required NULL allowed type description
    Period yes no Uint64 Duration of cloud disk purchase. The default unit is month, with options 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, and 36.
    Example: 1
    RenewFlag no no String Auto-renewal flag. Value range:
  • NOTIFY_AND_AUTO_RENEW: Notify that the account is about to expire and automatically renew the account.
  • NOTIFY_AND_MANUAL_RENEW: Notify that the account is about to expire but do not automatically renew the account.
  • DISABLE_NOTIFY_AND_MANUAL_RENEW: Neither notify that the account is about to expire nor automatically renew the account.

    Default value: NOTIFY_AND_MANUAL_RENEW: Notify that the account is about to expire but do not automatically renew the account.
    Example: NOTIFY_AND_AUTO_RENEW
    		•
    CurInstanceDeadline no no Datetime When it is necessary to align the expiration time of the cloud disk with the mounted child machine, this parameter can be input. This parameter indicates the current expiration time of the child machine. At this time, if Period is input, it indicates the duration that the child machine needs to renew, and the cloud disk will automatically renew according to the expiration time after the child machine is renewed.
    Example: 2018-03-30 20:15:03

    DiskConfigSet

    Cloud Disk Configuration

    Referenced by the following interfaces: DescribeZoneDiskConfigInfos

    name required NULL allowed type description
    DiskUsage yes no String System Disk or Data Disk
    Example: DATA_DISK
    DiskType yes no String CLOUD_BASIC, CLOUD_PREMIUM, CLOUD_SSD
    Example: CLOUD_SSD
    DiskSize yes no Int64 Cloud Disk Size
    Example: 100
    SnapshotId no no String Snapshot ID
    Example: snap-7vhf65a5

    DedicatedClusterDiskStatistic

    Cloud disk statistical information of CDC exclusive clusters.

    Referenced by the following interfaces: DescribeDedicatedClusterDiskStatistics

    name required NULL allowed type description
    DiskType yes no String Hard disk media type.
    Example: CLOUD_SSD
    TotalDiskSize yes no Uint64 Total cloud disk capacity.
    Example: 1000
    UsedDiskSize yes no Uint64 Used cloud disk capacity.
    Example: 100
    AvailableDiskSize yes no Uint64 Available cloud disk capacity.
    Example: 900

    Image

    Image Associated with Snapshot

    Referenced by the following interfaces: DescribeDiskAssociatedSnapshots, DescribeSnapshotGroups, DescribeSnapshots, DescribeSnapshotsInternal

    name required NULL allowed type description
    ImageId yes yes String Image instance ID.
    Example: img-m0w653yh
    ImageName yes yes String Image name.
    Example: image-1

    DiskOrder

    Order parameters for request billing.

    Referenced by the following interfaces: SwitchParameterCreateDisks, SwitchParameterRenewDisks, SwitchParameterResizeDisk

    name required NULL allowed type description
    GoodsCategoryId no no Uint64 Product category.
    Example: 100000
    GoodsNum no no Uint64 Number of products.
    Example: 10
    ProjectId no no Uint64 Project ID.
    Example: 1002189
    GoodsDetail no no GoodsDetail Product details.
    Example:View
    RegionId no no Uint64 Region ID.
    Example: 10
    ZoneId no no Uint64 Availability zone ID.
    Example: 100001
    PayMode no no Uint64 Payment mode.
    Example: 2
    Type no no String Cloud disk type.
    Example: CLOUD_TSSD

    PoolCustomAttributes

    It describes the custom attributes of the user resource pool.

    Referenced by the following interfaces: DescribeDiskStoragePoolGroups

    name required NULL allowed type description
    CpuArchitecture no yes Array of String CPU architecture.
    Example: aarch64
    CpuModel no yes Array of String CPU model.
    Example: Virtual

    Snapshot

    It describes the details of the snapshot.

    Referenced by the following interfaces: DescribeDiskAssociatedSnapshots, DescribeSnapshots, DescribeSnapshotsInternal

    name required NULL allowed type description
    SnapshotId no no String Snapshot ID.
    Example: snap-4zgc8cnk
    Placement no no Placement Location of the snapshot.
    Example:View
    DiskUsage no no String Type of the cloud disk that created this snapshot. Value range:
  • SYSTEM_DISK: system disk
  • DATA_DISK: data disk.
    Example: SYSTEM_DISK
    		•
    DiskId no no String ID of the cloud disk that created this snapshot.
    Example: disk-pe1vkgim
    DiskSize no no Uint64 Size of the cloud disk that created this snapshot.
    Example: 10
    SnapshotState no no String Snapshot status. Value range:
  • NORMAL: normal
  • CREATING: creating
  • ROLLBACKING: rolling back
  • COPYING_FROM_REMOTE: copying snapshots cross regions.
    Example: NORMAL
    		•
    SnapshotName no no String Snapshot name, which is a custom snapshot alias. This field can be modified by calling the ModifySnapshotAttribute API.
    Example: snap-1
    Percent no no Uint64 Snapshot creation progress percentage. This field is always 100 after the snapshot is created successfully.
    Example: 100
    CreateTime no no String Snapshot creation time.
    Example: 2019-07-15 00:00:00
    DeadlineTime no no String Snapshot expiration time. If the snapshot is permanently retained, this field is empty.
    Example: 2021-11-24 16:00:00
    Encrypt no no Bool Snapshot created by encrypted disks. Value range:
  • true: This snapshot is created by an encrypted disk.
  • false: This snapshot is not created by an encrypted disk.
    Example: false
    		•
    IsPermanent no no Bool It indicates whether the snapshot is a permanent snapshot. Value range:
  • true: permanent snapshot
  • false: non-permanent snapshot.
    Example: true
    		•
    CopyingToRegions yes yes Array of String It indicates the destination region of the snapshot currently under cross region replication. The default value is [].
    Example: ["region1"]
    CopyFromRemote yes yes Bool It indicates whether the snapshot is a snapshot for cross region replication. Value range:
  • true: Indicates a snapshot for cross region replication.
  • false: Snapshot of this region.
    Example: false
    		•
    Images yes yes Array of Image List of images associated with snapshots.
    Example:View
    ImageCount yes yes Uint64 Number of images associated with the snapshot.
    Example: 0
    SnapshotType yes yes String Snapshot type. Currently, the type PRIVATE_SNAPSHOT or SHARED_SNAPSHOT is supported.
    Example: PRIVATE_SNAPSHOT
    ShareReference yes yes Uint64 Number of Snapshots Currently Shared
    Example: 0
    Tags no yes Array of Tag List of snapshot tags.
    Example:View
    PlatformProjectId no yes String Internal project ID of the snapshot.
    Example: pr-42749a13
    EncryptAlgorithm no yes String Encryption algorithm.
    Example: AES256
    SavePlaceName no yes String Snapshot storage location.
    Example: ttttst
    SnapFormat no yes String Snapshot format type. Valid values: {"RAW", "QCOW2"}.
    Example: RAW
    SnapSize no yes Uint64 Snapshot size
    Example: 50
    CopyFromBackupDetail no yes CopyFromBackupDetail Snapshot replicated from a backup, obtaining the information of the corresponding backup.
    Example:View

    Price

    It describes the price of the cloud disk.

    Referenced by the following interfaces: InquirePriceModifyDiskExtraPerformance, InquiryPriceCreateDisks, InquiryPriceCreateSnapshots, InquiryPriceModifyDiskAttributes, InquiryPriceRenewDisks, InquiryPriceResizeDisk

    name required NULL allowed type description
    OriginalPrice no yes Float Original price of pre-payment (in USD).
    Example: 1.0
    DiscountPrice no yes Float Prepaid discounted price (in USD).
    Example: 1.0
    UnitPriceDiscount no yes Float Discounted unit price of postpaid cloud disks (in USD).
    Example: 1.0
    UnitPrice no yes Float Original unit price of postpaid cloud disks (in USD).
    Example: 1.0
    UnitPriceHigh no yes String Original Unit Price of High-precision Postpaid Cloud Disk (in USD)
    Example: "1.00"
    OriginalPriceHigh no yes String Original price of high-precision prepaid cloud disks (in USD).
    Example: "1.00"
    DiscountPriceHigh no yes String Discounted Price of High-precision Prepaid Cloud Disk (in USD)
    Example: "1.00"
    UnitPriceDiscountHigh no yes String Discounted Unit Price of High-precision Postpaid Cloud Disk (in USD)
    Example: "1.00"
    ChargeUnit no yes String It indicates the billing cell of the postpaid cloud disk. Value range:
  • HOUR: Indicates the billing cell of the postpaid cloud disk is calculated on an hourly basis.
    Example: "h"
    		•
    DetailPrices no yes Array of DetailPrice Details list of billable items.
    Example:View

    CopyFromBackupDetail

    Snapshot replicated from a backup, obtaining the information of the corresponding backup.

    Referenced by the following interfaces: DescribeDiskAssociatedSnapshots, DescribeSnapshots, DescribeSnapshotsInternal

    name required NULL allowed type description
    BackupGroupId yes yes String Backup group ID.
    Example: cbackup-ccy6hfmj
    CreateTime yes yes Datetime Backup creation time.
    Example: 2024-08-09 15:03:44
    BackupDiskId yes yes String Backup disk ID.
    Example: disk-pe1vkgim
    BackupId yes yes String Backup ID, which is the unique identifier of a backup.
    Example: backup-c9agada4

    BlockStorage

    It describes the details of the block storage.

    Referenced by the following interfaces: DescribeBlockStorages

    name required NULL allowed type description
    DiskId yes no String Block storage ID.
    Example: disk-pe1vkgim
    DiskName yes no String Block storage name.
    Example: CBS instance name-zzl
    DiskSize yes no Uint64 Block storage size (in GB).
    Example: 50
    DiskType yes no String Block Storage Medium Type. Value range:
  • CLOUD_BASIC
  • CLOUD_PREMIUM
  • CLOUD_SSD
  • CLOUD_ENHANCEDSSD
  • LOCAL_BASIC
  • LOCAL_SSD
    Example: CLOUD_TSSD
    		•
    DiskUsage yes no String Block storage type. Value range:
  • SYSTEM_DISK: system disk
  • DATA_DISK: data disk.
    Example: DATA_DISK
    		•
    InstanceId yes yes String ID of the instance to which block storage is mounted.
    Example: ins-9oxguxa
    InstanceName yes no String Name of the instance to which block storage is mounted.
    Example: lhins-kailwve

    DiskDeniedAction

    Operation Mask of Single Cloud Disk

    Referenced by the following interfaces: DescribeDisksDeniedActions

    name required NULL allowed type description
    DiskId yes no String It indicates the cloud disk ID, such as "disk-7rf24jvb".
    Example: disk-pe1vkgim
    DeniedActions yes no Array of DeniedAction Specific Cloud Disk Operation Mask Information
    Example:View

    DiskOverview

    User cloud disk information overview. It includes the total number of cloud disks, the number of expired cloud disks, and the number of cloud disks expiring within 7 days.

    Referenced by the following interfaces: DescribeUserDiskResources

    name required NULL allowed type description
    DiskNumberTotal yes no Int64 Total number of cloud disks.
    Example: 10
    ExpiredNumberTotal yes no Int64 Total number of expired cloud disks.
    Example: 5
    DiskNumberExpireIn7days yes no Int64 Total Number of Cloud Disks Expiring Within 7 days
    Example: 2
    DiskNumberUnderDataProtection yes no Int64 Number of protected disks.
    Example: 1

    Placement

    It describes the abstract location of the instance, including its availability zone and the project it belongs to.

    Referenced by the following interfaces: CreateDisks, DescribeDiskAssociatedSnapshots, DescribeDisks, DescribeSnapshots, DescribeSnapshotsInternal, InquiryPriceCreateSnapshots, SwitchParameterCreateDisks

    name required NULL allowed type description
    Zone yes no String ID of the availability zone to which the instance belongs. This parameter can also be obtained from the Zone field returned by calling the DescribeZones API.
    Example: ap-region1-2
    ProjectId no no Uint64 ID of the project to which the instance belongs. This parameter can be obtained from the projectId field returned by calling the DescribeProjects API. If this parameter is not specified, the default project is used.
    Example: 0
    CdcId no yes String ID of the exclusive cluster to which the instance belongs. As an input parameter, it indicates operating the resources of the specified CdcId exclusive cluster, which can be empty. As an output parameter, it indicates the ID of the exclusive cluster to which the resource belongs, which can be empty.
    Example: cdc-98asazxd
    CageId no yes String Cage ID. As an input parameter, it indicates operating the resources of a specified cage ID, which can be empty. As an output parameter, it indicates the cage ID to which the resource belongs, which can be empty.
    Example: cage-axqr92da
    CdcName no yes String Name of the exclusive cluster. As an input parameter, ignore this parameter. As an output parameter, it indicates the name of the exclusive cluster the cloud disk belongs to, which can be empty.
    Example: TesetCdcName
    ProjectName no yes String Project Name
    Example: Default Project
    DedicatedClusterId no yes String ID of the CVM exclusive cluster. As an input parameter, it indicates operating on the resources of the specified exclusive cluster. As an output parameter, it indicates the ID of the exclusive cluster to which the resource belongs, which can be empty.
    Example: cluster-ay3cdplf
    ClusterGroupId no yes String Cluster group ID.
    Example: ""

    DiskFeature

    Features supported by a cloud disk product.

    Referenced by the following interfaces: DescribeDiskSupportFeatures

    name required NULL allowed type description
    TradeType yes yes String Billing system used by the cloud disk. Value range:
  • bmppro: billing system
  • bmp: metering system
    Example: bmp
    		•

    SnapshotCopyResult

    It describes the results of snapshot cross-region replication.

    Referenced by the following interfaces: CopySnapshotCrossRegions

    name required NULL allowed type description
    DestinationRegion yes no String Target region for cross-region replication.
    Example: "ap-region1"
    SnapshotId yes no String New snapshot ID copied to the target region.
    Example: snap-hdbc13ad
    Code no no String Returned Status Code
    Example: Success
    Message no no String Return Message
    Example: Success

    AutoSnapshotPolicy

    It describes the details of the regular snapshot policy.

    Referenced by the following interfaces: DescribeAutoSnapshotPolicies, DescribeCopyAutoSnapshotPolicy, DescribeDiskAssociatedAutoSnapshotPolicy

    name required NULL allowed type description
    AutoSnapshotPolicyId no no String Regular snapshot policy ID.
    Example: asp-nz3ytdwj
    AutoSnapshotPolicyName no no String Name of the regular snapshot policy.
    Example: cloud_demo
    AutoSnapshotPolicyState no no String Status of the regular snapshot policy. Value range:
  • NORMAL: normal
  • ISOLATED: isolated.
    Example: NORMAL
    		•
    IsActivated no no Bool It indicates whether the regular snapshot policy is activated.
    Example: true
    IsPermanent no no Bool It indicates whether snapshots created by this regular snapshot policy are permanently retained.
    Example: false
    RetentionDays no no Uint64 It indicates the retention days for snapshots created by the regular snapshot policy.
    Example: 1
    CreateTime no no Datetime Creation time of the regular snapshot policy.
    Example: 2022-01-11 10:45:51
    NextTriggerTime no no Datetime Next trigger time of regular snapshots.
    Example: 2022-05-31 11:00:00
    Policy no no Array of Policy Execution policy of regular snapshots.
    Example:View
    DiskIdSet no no Array of String It lists IDs of cloud disks that have been bound to the current regular snapshot policy.
    Example: ["disk-pe1vkgim"]
    IsCopyToRemote yes yes Uint64 Cross-account Snapshot Replication or Not
    Example: 0
    CopyFromAccountUin yes yes String Source Account UIN
    Example: 100004603241
    CopyToAccountUin yes yes String Destination Account UIN
    Example: 100004603246
    InstanceIdSet no no Array of String List of instances bound to the current regular snapshot policy.
    Example: ["ins-og3j7lue"]
    RetentionMonths no no Uint64 Maximum Retention Months for Snapshots Created by This Regular Snapshot Policy
    Example: 1
    RetentionAmount no no Uint64 Maximum Number of Retained Snapshots Created by This Regular Snapshot Policy
    Example: 5
    AdvancedRetentionPolicy no yes AdvancedRetentionPolicy Advanced Snapshot Retention Policy
    Example:View
    IsCrossRegion no yes Bool Whether cross-region snapshot replication is enabled in the regular snapshot policy.
    Example: false
    Tags no yes Array of Tag Tag.
    Example:View
    CrossRegionRetentionDays no yes Int64 Retention days for cross-region snapshots created by using this scheduled snapshot policy. The default value is 7 days. This parameter cannot conflict with the CrossRegionIsPermanent parameter.
    Example: 7
    CrossRegionIsPermanent no yes Bool Whether cross-region snapshots created by using this scheduled snapshot policy are retained permanently. The default value is 0, indicating the snapshots are not retained permanently.
    Example: false

    SnapshotDeniedAction

    Operation Mask of Single Snapshot

    Referenced by the following interfaces: DescribeSnapshotsDeniedActions

    name required NULL allowed type description
    SnapshotId yes no String Based on Snapshot ID
    Example: snap-hdbc13ad
    DeniedActions yes no Array of DeniedAction Specific Operation Mask Information for Snapshot
    Example:View

    Filters

    It describes the key-value pair filter, used for conditional filter query.

    Referenced by the following interfaces: DescribeDiskStoragePoolGroups

    name required NULL allowed type description
    Name yes no String Filter key name.
    Example: snapshot-group-id
    Values yes no Array of String One or more filter values.
    Example: csnap-c44200bd

    AttachDetail

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

    Referenced by the following interfaces: DescribeInstancesDiskNum

    name required NULL allowed type description
    InstanceId yes yes String Instance ID.
    Example: ins-jw0vit58
    AttachedDiskCount yes yes Uint64 Number of data disks mounted to the instance.
    Example: 1
    MaxAttachCount yes yes Uint64 Maximum number of data disks to which an instance can mount.
    Example: 20