Cloud Disk(UDisk)

Get Snapshot List - DescribeUDiskSnapshot


Get UDisk Snapshot


Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribeUDiskSnapshot.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringRegion. See List of Regions and Availability ZonesYes
ZonestringAvailability Zone. See Availability Zone ListNo
ProjectIdstringProject ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.No
OffsetintData offset, default is 0No
LimitintReturn data length, default is 20No
UDiskIdstringUDiskId, returns the snapshot made of this disk. (Zone must be passed at the same time)No
SnapshotIdstringSnapshot id, SnapshotId, UDiskId, pass SnapshotId as a priority if both are givenNo

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
DataSetarray[UDiskSnapshotSet]JSON format Snapshot list, see UDiskSnapshotSet for detailsNo
TotalCountintTotal count based on filter conditionsNo

Data Model


Field NameTypeDescription InformationRequired
ZonestringAvailability ZoneYes
SnapshotIdstringSnapshot IdYes
NamestringSnapshot NameYes
UDiskIdstringThe source UDisk's Id of the snapshotYes
UDiskNamestringSource UDisk Name of the Snapshot.Yes
CreateTimeintCreation TimeYes
SizeintCapacity Unit GBYes
StatusstringSnapshot Status, Normal: Normal, Failed: Failed, Creating: In ProgressYes
DiskTypeintDisk type, 0: General data disk; 1: General system disk; 2: SSD data disk; 3: SSD system disk; 4: RSSD data disk; 5: RSSD system disk.Yes
ExpiredTimeint[Deprecated] Expiration TimeNo
CommentstringSnapshot DescriptionNo
IsUDiskAvailablebooleanIs the corresponding disk in an available state?No
VersionstringSnapshot VersionNo
UHostIdstringThe host mounted when creating a snapshot for the corresponding diskNo
UKmsModestring[Deprecated] Is it an encrypted disk snapshot? Yes: "Yes", No: "No"No
CmkIdstring[Deprecated] The cmk id of this snapshotNo
DataKeystring[Deprecated] The encrypted key of this snapshotNo
CmkIdStatusstring[Deprecated] The status of the snapshot cmk, Enabled (Normal), Disabled (Invalid), Deleted (Deleted), NoCmkId (Non-encrypted disk)No
CmkIdAliasstring[Deprecated] cmk id aliasNo


Request Example

Response Example

  "Action": "DescribeUDiskSnapshotResponse",
  "DataSet": [
      "ChargeType": "Year",
      "Comment": "test",
      "CreateTime": 1402039500,
      "DiskType": 0,
      "ExpiredTime": 1402039500,
      "IsUDiskAvailable": true,
      "Name": "test",
      "Size": "100",
      "SnapshotId": "bsSnap-xxx",
      "Status": "Normal",
      "UDiskId": "bs-xxx",
      "UDiskName": "apidoctest",
      "UHostId": "uhost-xxx",
      "Version": "1.0"
  "RetCode": 0,
  "TotalCount": 1
  • Company
  • ContactUs
  • Blog
Copyright © 2024 SurferCloud All Rights Reserved
  • Contact our sales to help your business.
  • Contact our sales to help your business.