tencent cloud

云硬盘

文档云硬盘API 文档Data Types

Data Types

Download
聚焦模式
字号
最后更新时间： 2026-05-12 19:38:07

AdvancedRetentionPolicy

Retention policy for scheduled snapshots. All four parameters are required.

Used by actions: DescribeAutoSnapshotPolicies, DescribeDiskAssociatedAutoSnapshotPolicy.

Name Type Required Description
Days Integer Yes Retains the latest snapshot of each day within the specified number of Days. value range: [0, 100].
Weeks Integer Yes Reserve the latest snapshot of each week for Weeks. value range: [0, 100].
Months Integer Yes Reserve the latest snapshot of each month within Months Months. value range: [0, 100].
Years Integer Yes Reserve the latest snapshot of each year within Years Years. value range: [0, 100].

ApplyDisk

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

Used by actions: ApplySnapshotGroup.

Name Type Required Description
SnapshotId String Yes Specifies the snapshot ID associated with the snapshot group.
DiskId String Yes Specifies the original cloud disk ID of the snapshot associated with the snapshot group.

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.

AutoMountConfiguration

Describes how a newly purchased cloud disk is initialized and attached to a CVM instance.

Used by actions: CreateDisks.

Name Type Required Description
InstanceId Array of String Yes ID of the instance to which the cloud disk is attached.
MountPoint Array of String No Mount point in the instance.
FileSystemType String No File system type. Valid values: ext4, xfs.

AutoSnapshotPolicy

This describes the detailed information of the scheduled snapshot policy.

Used by actions: DescribeAutoSnapshotPolicies, DescribeDiskAssociatedAutoSnapshotPolicy.

Name Type Description
DiskIdSet Array of String It lists IDs of cloud disks that have been bound to the current regular snapshot policy.

In the scenario of DescribeDiskAssociatedAutoSnapshotPolicy, this field returns empty.
IsActivated Boolean Whether scheduled snapshot policy is activated.
AutoSnapshotPolicyState String Status of regular snapshot policy. valid values:.

  • NORMAL: specifies the scaling group is in normal state.
    • .
  • ISOLATED: specifies the instance is isolated.
    • .
IsCopyToRemote Integer Whether it is a cross-account snapshot replication. valid values: 1 (yes), 0 (no).
IsPermanent Boolean Whether the snapshot created by this scheduled snapshot policy is retained permanently.
NextTriggerTime Timestamp The time the scheduled snapshot will be triggered again.
AutoSnapshotPolicyName String Scheduled snapshot policy name.
AutoSnapshotPolicyId String Scheduled snapshot policy ID.
Policy Array of Policy The policy for executing the scheduled snapshot.
CreateTime Timestamp The time the scheduled snapshot policy was created.
RetentionDays Integer Number of days the snapshot created by this scheduled snapshot policy is retained.
CopyToAccountUin String ID of the replication target account
Note: This field may return null, indicating that no valid values can be obtained.
InstanceIdSet Array of String Lists instance ids that are bound to the current periodic snapshot policy.
RetentionMonths Integer Specifies the number of months snapshot can be retained.
RetentionAmount Integer Specifies the maximum retention number of snapshots created by scheduled snapshot.
AdvancedRetentionPolicy AdvancedRetentionPolicy Retention policy for scheduled snapshots.
Note: This field may return null, indicating that no valid values can be obtained.
CopyFromAccountUin String Source account ID of the copied snapshot policy
Note: This field may return null, indicating that no valid values can be obtained.
Tags Array of Tag Tag.

DetailPrice

Pricing details for the cloud disk.

Used by actions: InquiryPriceRenewDisks, InquiryPriceResizeDisk.

Name Type Description
PriceTitle String Name of a billable item.
PriceName String Name of the billable item displayed in the console.
OriginalPrice Float Original price of a monthly subscribed cloud disk, in USD.
Note: This field may return null, indicating that no valid values can be obtained.
DiscountPrice Float Discounted price of a monthly subscribed cloud disk, in USD.
Note: This field may return null, indicating that no valid values can be obtained.
UnitPrice Float Original unit price of a pay-as-you-go cloud disk, in USD.
Note: This field may return null, indicating that no valid values can be obtained.
UnitPriceDiscount Float Discount unit price of a pay-as-you-go cloud disk, in USD.
Note: This field may return null, indicating that no valid values can be obtained.
ChargeUnit String Billing unit for pay-as-you-go cloud disks. Valid value: HOUR (billed hourly).
Note: This field may return null, indicating that no valid values can be obtained.
OriginalPriceHigh String Original highly-precise price of a monthly subscribed cloud disk, in USD.
Note: This field may return null, indicating that no valid values can be obtained.
DiscountPriceHigh String Discounted highly-precise price of a monthly subscribed cloud disk, in USD.
Note: This field may return null, indicating that no valid values can be obtained.
UnitPriceHigh String Original highly-precise unit price of a pay-as-you-go cloud disk, in USD.
Note: This field may return null, indicating that no valid values can be obtained.
UnitPriceDiscountHigh String Discounted highly-precise unit price of a pay-as-you-go cloud disk, in USD.
Note: This field may return null, indicating that no valid values can be obtained.

Disk

The details of a cloud disk

Used by actions: DescribeDisks.

Name Type Description
DeleteWithInstance Boolean Specifies whether the cloud disk is destroyed along with the mounted instance.
  • true: destroy the cloud disk along with the instance. only hourly postpaid cloud disk is supported.
  • false: destroying instance without destroying cloud disk.
    • .
    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 Hard disk media type. valid values:
  • CLOUD_BASIC: BASIC CLOUD disk
  • CLOUD_PREMIUM: high-performance CLOUD block storage
  • CLOUD_BSSD: universal type SSD CLOUD disk
  • CLOUD_SSD: SSD CLOUD disk
  • CLOUD_HSSD: enhanced SSD CLOUD disk
  • CLOUD_TSSD: ultra-fast SSD cbs.
    • .
    DiskState String Cloud disk state. valid values:
  • UNATTACHED: unmounted
  • ATTACHING: mounting
  • ATTACHED: mounted
  • DETACHING: unmounting
  • EXPANDING: EXPANDING
  • ROLLBACKING: rolling back
  • TORECYCLE: to be recycled
  • DUMPING: copying hard drive.
    • .
    SnapshotCount Integer The total number of snapshots of the cloud disk.
    AutoRenewFlagError Boolean Cloud disk mounted to child machine, and both child machine and cloud disk are on a monthly subscription basis.
  • true: auto renewal flag is set for child machine, but cloud disk not set
  • false: cloud disk auto-renewal flag normal
    • .
    Rollbacking Boolean Indicates if the cloud disk is in snapshot rollback status. valid values:
  • false: means not in snapshot rollback status
  • true: means in snapshot rollback status.
    • .
    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.
    Encrypt Boolean Indicates whether the cloud disk is encrypted. valid values:
  • false: non-encrypted disk
  • true: encrypted disk
    • .
    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 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.
    InstanceId String ID of the CVM to which the cloud disk is mounted.
    AttachMode String The mount type of the cloud disk. valid values:
  • PF: PF mount
  • VF: VF mount
    • .
    AutoSnapshotPolicyIds Array of String Regular snapshot ID associated with the cloud disk. return this parameter only when calling the DescribeDisks API with ReturnBindAutoSnapshotPolicy set to TRUE.
    Note: This field may return null, indicating that no valid values can be obtained.
    ThroughputPerformance Integer Specifies the additional performance value of the CBS in MiB/s.
    Migrating Boolean Indicates if the cloud disk is in type change. valid values:
  • false: means the cloud disk is not in type change
  • true: means the cloud disk has initiated type change and is migrating.
    • .
    DiskId String Cloud disk ID.
    SnapshotSize Integer Total snapshot capacity of the cloud disk. unit: MiB.
    Placement Placement Location of the cloud disk.
    IsReturnable Boolean Determines if a prepaid cloud disk supports proactive return.
  • true: supports proactive return
  • false: does not support proactive return.
    • .
    Note: This field may return null, indicating that no valid values can be obtained.
    DeadlineTime Timestamp Expiration time of the cloud disk.
    Attached Boolean Indicates whether the cloud disk is mounted to the cvm. valid values:
  • false: means not mounted
  • true: means mounted.
    • .
    DiskSize Integer Specifies the disk capacity in GiB.
    MigratePercent Integer It indicates the migration progress of cloud disk type change. The value range is 0 to 100.
    DiskUsage String Cloud DISK type. valid values:
  • SYSTEM_DISK: SYSTEM DISK
  • DATA_DISK: DATA DISK.
    • .
    DiskChargeType String Payment mode. valid values:
  • PREPAID: PREPAID, i.e. monthly subscription
  • POSTPAID_BY_HOUR: POSTPAID, i.e. pay-as-you-go.
    • .
    Portable Boolean Whether it is an elastic cloud disk. false: Non-elastic cloud disk; true: Elastic cloud disk.
    SnapshotAbility Boolean Specifies whether the cloud disk has the capability to create snapshots. valid values:
  • false: cannot create snapshots
  • true: can create snapshots.
    • .
    DeadlineError Boolean Indicates whether the cloud disk expiration time is earlier than that of the instance. 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: cloud disk expiration time later than instance.
    • .
    RollbackPercent Integer Rollback progress of a cloud disk snapshot.
    DifferDaysOfDeadline Integer The number of days from the current time to disk expiration (only applicable to prepaid cbs).
    Note: This field may return null, indicating that no valid values can be obtained.
    ReturnFailCode Integer For prepaid cloud disks that do not support proactive return, this parameter indicates the specific reason for not supporting refund. value range:
  • 1: the cloud disk has already been returned.
  • 2: the cloud disk has expired.
  • 3: the cloud disk does not support return.
  • 8: the maximum returnable quantity is exceeded.
  • 10: non-elastic cloud disks, system disks, and pay-as-you-go cloud disks do not support return.
    • .
    Shareable Boolean Whether or not cloud disk is shareable cloud disk.
    CreateTime Timestamp Creation time of the cloud disk.
    DeleteSnapshot Integer Specifies whether to 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. default value: 0. whether a snapshot is permanently retained can be determined through the IsPermanent field in the snapshot description returned by the DescribeSnapshots API (https://www.tencentcloud.com/document/product/362/15647?from_cn_redirect=1). true indicates permanent snapshot, false indicates non-permanent snapshot.
    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 The type of the CBS mounting instance. valid values:
  • CVM
  • EKS
    • .
    LastAttachInsId String ID of the last instance to which the cloud disk is attached
    Note: This field may return null, indicating that no valid values can be obtained.
    ErrorPrompt String Error prompt for the last operation on cbs.
    BurstPerformance Boolean Whether performance burst is enabled for the cloud disk.
    EncryptType String Encryption type of cbs. valid values: ENCRYPT_V1 and ENCRYPT_V2, which indicate first generation and second generation encryption technology respectively. the two kinds are incompatible.
    KmsKeyId String Key ID of the encrypted disk.

    DiskBackup

    Cloud disk backup point.

    Used by actions: DescribeDiskBackups.

    Name Type Description
    DiskBackupId String Cloud disk backup point ID.
    DiskId String ID of the cloud disk with which the backup point is associated.
    DiskSize Integer Specifies the disk capacity in GiB.
    DiskUsage String Cloud disk type. value ranges from...to...
    .
  • SYSTEM_DISK: specifies the system disk.
    • .
  • DATA_DISK: specifies the data disk.
    • .
    DiskBackupName String Backup point name.
    DiskBackupState String

    Specifies the status of the cloud disk backup point. valid values:

    .

    • NORMAL: specifies the scaling group is in normal state.
      • .
    • CREATING: creating.
      • .
    • ROLLBACKING: indicates the rollback is in progress.
      • .
    Percent Integer Specifies the creation percentage of the cloud disk backup point.
    CreateTime Timestamp ISO8601 Creation time of the cloud disk backup point.
    Encrypt Boolean Indicates whether the cloud disk is encrypted. valid values:
  • false: non-encrypted disk
  • true: encrypted disk
    • .

    DiskChargePrepaid

    Billing mode of the instance

    Used by actions: CreateDisks, InquiryPriceCreateDisks, InquiryPriceRenewDisks, RenewDisk.

    Name Type Required Description
    Period Integer Yes Specifies the duration for purchasing cloud block storage (cbs) in months. default unit: month. valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
    RenewFlag String No Automatic renewal flag. valid values:.

    • NOTIFY_AND_AUTO_RENEW: notifies expiry and renews automatically.
      • .
    • NOTIFY_AND_MANUAL_RENEW: notifies expiry but does not renew automatically.
      • .
    • DISABLE_NOTIFY_AND_MANUAL_RENEW: no notification is sent upon expiration, and the instance is not renewed automatically.
      • .

    Default value: NOTIFY_AND_MANUAL_RENEW.
    CurInstanceDeadline Timestamp No Specifies the current expiration time of the child machine when the expiration time of the cloud block storage needs to align with the mounted child machine. you can input this parameter. if Period is input at this time, it indicates the duration of child machine renewal. the cloud disk will automatically renew according to the expiration time after the child machine is renewed.

    DiskConfig

    Cloud disk configuration.

    Used by actions: DescribeDiskConfigQuota.

    Name Type Description
    Available Boolean Whether the configuration is available.
    DiskChargeType String Payment mode. valid values:
  • PREPAID: PREPAID, i.e. monthly subscription

  • POSTPAID_BY_HOUR: POSTPAID, i.e. pay-as-you-go.
    • .
    Zone String The Availability Region of the cloud drive.
    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.
    DiskType String Cloud disk media type. valid values:
    .
    CLOUD_BASIC: specifies the BASIC CLOUD disk.
    CLOUD_PREMIUM: indicates high-performance CLOUD block storage.
    CLOUD_BSSD: indicates a universal type SSD CLOUD disk.
    CLOUD_SSD: indicates SSD CLOUD disk.
    CLOUD_HSSD: indicates the enhanced SSD CLOUD disk.
    CLOUD_TSSD: indicates ultra-fast ssd cbs.
    StepSize Integer Specifies the minimum step size for disk size change in GiB.
    ExtraPerformanceRange Array of Integer Additional performance range.
    Note: This field might return null, indicating that no valid values can be obtained.
    DeviceClass String Instance model.
    Note: This field may return null, indicating that no valid value was found.
    DiskUsage String Cloud DISK type. valid values:
  • SYSTEM_DISK: SYSTEM DISK

  • DATA_DISK: DATA DISK.
    • .
    MinDiskSize Integer Specifies the minimum configurable cloud disk size in GiB.
    MaxDiskSize Integer Specifies the maximum configurable cloud disk size in GiB.
    Price Price Price of a prepaid or postpaid cloud disk.

    Filter

    Filter criteria

    Used by actions: DescribeAutoSnapshotPolicies, DescribeDiskBackups, DescribeDisks, DescribeSnapshotGroups, 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: DescribeSnapshotGroups, 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.
    CageId String No CageId, which can be obtained via DescribeDiskStoragePool. as an input parameter, it operates on resources of the specified cage Id and can be empty. as an output parameter, it indicates the cage Id to which the resource belongs and can be empty.
    Note: This field may return null, indicating that no valid values can be obtained.
    ProjectId Integer No Instance'S project ID, which can be obtained by DescribeProject. by default if left blank, it is 0, indicating the default project.
    ProjectName String No Project to which instance belongs. search via DescribeProject.
    Note: This field may return null, indicating that no valid values can be obtained.
    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.
    CdcId String No The exclusive cluster ID of the instance. can be obtained via DescribeDiskStoragePool. as an input parameter, it indicates operations on resources belonging to the designated CdcId exclusive cluster and can be empty. as an output parameter, it indicates the exclusive cluster ID of the resource and can be empty.
    Note: This field may return null, indicating that no valid values can be obtained.
    DedicatedClusterId String No Dedicated cluster ID

    Policy

    Describes the execution strategy of regular snapshots. it can be understood as executing this scheduled snapshot policy at the moment specified by Hour on the days designated by DayOfWeek/DayOfMonth or at the interval set by IntervalDays. note: DayOfWeek/DayOfMonth/IntervalDays are mutual exclusion rules, required and only one policy rule can be set. if mutual exclusion rules are imported at the same time, only one takes effect, with priority following the sequence listed in the previous context: for example, if all three rules are set, only DayOfWeek comes into effect.

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

    Name Type Required Description
    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.
    DayOfWeek Array of Integer No 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.
    DayOfMonth Array of Integer No Specifies the dates of the month on which a scheduled snapshot will be triggered. Value range: [1, 31]. 1 to 31 indicate the specific dates of the month; for example, 5 indicates the 5th day of the month. Note: If you set a date that does not exist in some months such as 29, 30, and 31, these months will be skipped for scheduled snapshot creation.
    IntervalDays Integer No Specifies the interval for creating scheduled snapshots in days. Value range: [1, 365]. For example, if it is set to 5, scheduled snapshots will be created every 5 days. Note: If you choose to back up by day, the time for the first backup is theoretically the day when the backup policy is created. If the backup policy creation time on the current day is later than the set backup time, the first backup will be performed in the second backup cycle.

    PrepayPrice

    The cost of a prepaid order.

    Used by actions: InquiryPriceRenewDisks, InquiryPriceResizeDisk.

    Name Type Description
    DiscountPrice Float Discounted price of a monthly-subscribed cloud disk or a snapshot, in USD.
    ChargeUnit String Billing unit for postpaid cloud disk. valid values:
  • HOUR: the billing unit for postpaid cloud disk is calculated hourly.
    • .
    Note: This field may return null, indicating that no valid values can be obtained.
    UnitPriceHigh String Original unit price of a pay-as-you-go cloud disk, in USD, with six decimal places.
    Note: this field may return null, indicating that no valid values can be obtained.
    OriginalPriceHigh String Original payment of a monthly-subscribed cloud disk or a snapshot, in USD, with six decimal places.
    OriginalPrice Float Original payment of a monthly-subscribed cloud disk or a snapshot, in USD.
    UnitPriceDiscount Float Discount unit price of a pay-as-you-go cloud disk, in USD.
    Note: this field may return null, indicating that no valid values can be obtained.
    UnitPriceDiscountHigh String Discounted unit price of a pay-as-you-go cloud disk, in USD, with six decimal places.
    Note: this field may return null, indicating that no valid values can be obtained.
    DiscountPriceHigh String Discounted price of a monthly-subscribed cloud disk or a snapshot, in USD, with six decimal places.
    UnitPrice Float Original unit price of a pay-as-you-go cloud disk, in USD.
    Note: this field may return null, indicating that no valid values can be obtained.
    DetailPrices Array of DetailPrice Details list of billable items.

    Price

    Describes the prepaid or postpaid price for the cloud disk.

    Used by actions: DescribeDiskConfigQuota, InquirePriceModifyDiskBackupQuota, InquirePriceModifyDiskExtraPerformance, InquiryPriceCreateDisks.

    Name Type Description
    UnitPriceDiscount Float Discount unit price of a pay-as-you-go cloud disk, in USD.
    Note: this field may return null, indicating that no valid values can be obtained.
    DiscountPrice Float Discounted price of a monthly-subscribed cloud disk, in USD.
    Note: this field may return null, indicating that no valid values can be obtained.
    UnitPrice Float Original unit price of a pay-as-you-go cloud disk, in USD.
    Note: this field may return null, indicating that no valid values can be obtained.
    UnitPriceHigh String Original unit price of a pay-as-you-go cloud disk, in USD, with six decimal places.
    Note: this field may return null, indicating that no valid values can be obtained.
    OriginalPriceHigh String Original payment of a monthly-subscribed cloud disk, in USD, with six decimal places.
    Note: this field may return null, indicating that no valid values can be obtained.
    OriginalPrice Float Original price of a monthly-subscribed cloud disk, in USD.
    Note: this field may return null, indicating that no valid values can be obtained.
    DiscountPriceHigh String Discounted payment price of a monthly-subscribed cloud disk, in USD, with six decimal places.
    Note: this field may return null, indicating that no valid values can be obtained.
    UnitPriceDiscountHigh String Discounted unit price of a pay-as-you-go cloud disk, in USD, with six decimal places.
    Note: this field may return null, indicating that no valid values can be obtained.
    ChargeUnit String Billing unit for postpaid cloud disk. valid values:
  • HOUR: the billing unit for postpaid cloud disk is calculated hourly.
    • .
    Note: This field may return null, indicating that no valid values can be obtained.

    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
    Placement Placement Location of the snapshot.
    CopyFromRemote Boolean Specifies whether the snapshot is for cross-region replication. value range:.

    • true: indicates a snapshot for cross-region replication.
      • .
    • false: snapshot of the local region.
      • .
    SnapshotState String Snapshot status. valid values:.

    • NORMAL: specifies the scaling group is normal.
      • .
    • CREATING: creating
      • .
    • ROLLBACKING: indicates the rollback is in progress.
      • .
    • COPYING_FROM_REMOTE: cross geo-replication in progress.
      • .
    • CHECKING_COPIED: copying check in progress.
      • .
    • TORECYCLE: to be recycled.
      • .
    IsPermanent Boolean Whether it is a permanent snapshot. valid values:.

    • true: permanent snapshot.
      • .
    • false: non-permanent snapshot.
      • .
    SnapshotName String Snapshot name, the user-defined snapshot alias. Call ModifySnapshotAttribute to modify this field.
    DeadlineTime Timestamp The expiration time of the snapshot. If the snapshot is permanently retained, this field is blank.
    Percent Integer The progress percentage for snapshot creation. This field is always 100 after the snapshot is created successfully.
    Images Array of Image List of images associated with snapshot.
    ShareReference Integer Number of snapshots currently shared
    SnapshotType String Specifies the SNAPSHOT type. valid values: PRIVATE_SNAPSHOT (PRIVATE SNAPSHOT) or SHARED_SNAPSHOT (SHARED SNAPSHOT).
    DiskSize Integer Specifies the disk capacity of the CBS for creating this snapshot, in GiB.
    DiskId String ID of the cloud disk used to create this snapshot.
    CopyingToRegions Array of String Destination region of the snapshot currently under cross region replication. if not, return [].
    Encrypt Boolean Indicates whether the snapshot is created for an encrypted disk. valid values:.

    • true: specifies the snapshot is created by encrypted disks.
      • .
    • false: snapshot created for non-encrypted disk.
      • .
    CreateTime Timestamp Creation time of the snapshot.
    ImageCount Integer Number of images associated with snapshot.
    DiskUsage String Specifies the cloud disk type of the CBS for creating this snapshot. valid values:.

    • SYSTEM_DISK: system disk
      • .
    • DATA_DISK: specifies the data disk.
      • .
    SnapshotId String Snapshot ID.
    TimeStartShare Date The time when the snapshot sharing starts
    Tags Array of Tag List of tags associated with the snapshot.

    SnapshotCopyResult

    Result of the cross-region replication task

    Used by actions: CopySnapshotCrossRegions.

    Name Type Description
    SnapshotId String ID of the snapshot replica
    Message String Error message. It’s null if the request succeeds.
    Code String Error code. It’s Success if the request succeeds.
    DestinationRegion String Destination region of the replication task

    SnapshotGroup

    It describes the snapshot group details.

    Used by actions: DescribeSnapshotGroups.

    Name Type Description
    SnapshotGroupId String Specifies the snapshot group ID.
    SnapshotGroupType String Snapshot group type. NORMAL: common snapshot group, non-consistent snapshot.
    ContainRootSnapshot Boolean Specifies whether the snapshot group contains a system disk snapshot.
    SnapshotIdSet Array of String Specifies the snapshot ID list included in the snapshot group.
    SnapshotGroupState String

    • NORMAL: specifies the scaling group is in normal state.
      • .
    • CREATING: creating.
      • .
    • ROLLBACKING: indicates the rollback is in progress.
      • .
    Percent Integer Specifies the snapshot group creation progress.
    CreateTime Timestamp ISO8601 Specifies the snapshot group creation time.
    ModifyTime Timestamp ISO8601 Latest modification time of the snapshot group.
    Images Array of Image Specifies the image list associated with the snapshot group.
    SnapshotGroupName String Specifies the snapshot group name.
    ImageCount Integer Number of images associated with the snapshot group.
    IsPermanent Boolean Specifies whether the snapshot group has permanent retention.
    DeadlineTime Timestamp ISO8601 Specifies the snapshot group expiration time.
    Note: This field may return null, indicating that no valid values can be obtained.
    AutoSnapshotPolicyId String Source automatic snapshot policy ID.
    Note: This field may return null, indicating that no valid values can be obtained.

    Tag

    Tag.

    Used by actions: CreateDisks, CreateSnapshot, CreateSnapshotGroup, DescribeAutoSnapshotPolicies, DescribeDiskAssociatedAutoSnapshotPolicy, DescribeDisks, DescribeSnapshots.

    Name Type Required Description
    Key String Yes Tag key.
    Value String Yes Tag value.
    上一篇: ModifyDiskExtraPerformance下一篇: Error Codes

    帮助和支持

    本页内容是否解决了您的问题？

    填写满意度调查问卷，共创更好文档体验。

    文档反馈