All Products
Search
Document Center

Hybrid Backup Recovery:DescribeUdmSnapshots

Last Updated:Nov 14, 2022

Queries the backup snapshots of an Elastic Compute Service (ECS) instance.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
SourceTypestringYes

The type of the data source. Valid values:

  • ECS_FILE: ECS file
  • OSS: Object Storage Service (OSS) bucket
  • NAS: Apsara File Storage NAS file system
  • UDM_DISK: ECS instance
UDM_ECS
StartTimelongYes

The beginning of the time range to query. This value must be a UNIX timestamp. Unit: seconds.

1642057551
EndTimelongYes

The end of the time range to query. This value must be a UNIX timestamp. Unit: seconds.

1643092168
UdmRegionIdstringYes

The ID of the region where the ECS instance resides.

cn-hangzhou
InstanceIdstringYes

The ID of the ECS instance.

i-bp18x2k7sw925ir7ofh8
DiskIdstringNo

The ID of the disk.

d-bp1560750pclffpzxy70
JobIdstringNo

The ID of the backup job.

job-*********************
SnapshotIdsobjectNo

The list of backup snapshots.

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The HTTP status code. The status code 200 indicates that the call is successful.

200
Messagestring

The message that is returned. If the call is successful, "successful" is returned. If the call fails, an error message is returned.

successful
RequestIdstring

The ID of the request.

51CDEECB-7001-51CC-94AC-2A0F2A4B71D2
TotalCountlong

The total number of backup snapshots.

3
Successboolean

Indicates whether the call is successful.

  • true: The call is successful.
  • false: The call fails.
true
Snapshotsarray

The details about backup snapshots.

object

The details about backup snapshots.

Statusstring

The status of the backup job. Valid values:

  • COMPLETE: The backup job is completed.
  • PARTIAL_COMPLETE: The backup job is partially completed.
  • FAILED: The backup job has failed.
COMPLETE
SnapshotHashstring

The hash value of the backup snapshot.

f2fe...
BackupTypestring

The backup type. Valid value: COMPLETE, which indicates full backup.

COMPLETE
CreateTimelong

The time when the backup snapshot was created.

1607436917
ActualBytesstring

The size of the backup snapshot. Unit: bytes.

600
SourceTypestring

The type of the data source. Valid values:

  • ECS_FILE: ECS file
  • OSS: OSS bucket
  • NAS: NAS file system
  • OTS_TABLE: Tablestore instance
  • UDM_DISK: ECS instance
UDM_ECS
Prefixstring

The prefix of the backup snapshot.

example/
DiskIdstring

The ID of the cloud disk or local disk.

d-2ze86h5fga5r******a8ef
BytesTotallong

The total amount of data. Unit: bytes.

1000
NativeSnapshotInfostring

The snapshot information.

{ "sourceDiskId":"d-bp17misjuy636t82v7b0", "lastModifiedTime":"2022-03-09T11:35:12Z", "snapshotSN":"64588-429372675-857161235", "snapshotId":"s-bp1fbtwv3e6xr6wpe9e0", "creationTime":"2022-03-09T11:31:12Z", "snapshotType":"user", "usage":"none", "description":"", "sourceStorageType":"disk", "tags":[ { "tagValue":"job-0007e0wqjl0imbrtkmnm", "tagKey":"HBR JobId" } ], "productCode":"", "encrypted":false, "sourceDiskType":"system", "retentionDays":30, "snapshotName":"Created-from-HBR-job:job-0007e0wqjl0imbrtkmnm", "kMSKeyId":"", "progress":"100%", "category":"standard", "sourceDiskSize":"20", "status":"accomplished" }
CompleteTimelong

The time when the backup snapshot was completed. This value is a UNIX timestamp. Unit: seconds.

1646895666
Retentionlong

The retention period of the backup snapshot. Unit: days.

7
CreatedTimelong

The time when the backup snapshot was created. This value is a UNIX timestamp. Unit: seconds.

1642496679
RealSnapshotTimelong

The timestamp of the backup snapshot. Unit: milliseconds.

1642496679
ParentSnapshotHashstring

The hash value of the parent backup snapshot.

f2fe..
InstanceIdstring

The ID of the ECS instance.

i-bp1f0pe78dxi******gxd
StartTimelong

The start time of the backup snapshot. This value is a UNIX timestamp. Unit: seconds.

1554347313
UpdatedTimelong

The time when the backup snapshot was updated. This value is a UNIX timestamp. Unit: seconds.

1642496679
SnapshotIdstring

The ID of the backup snapshot.

s-00047mxg17p26*****b
JobIdstring

The ID of the backup job.

job-00030j3chkt******2
NativeSnapshotIdstring

The ID of the snapshot.

s-00047mg17p26x*****b
Detailobject

The snapshot details.

DiskDevNamestring

The name of the disk.

/dev/xvdb
DowngradeReasonstring

The reason for the downgrade.

HBR.NoRamRoleBound
OsDiskIdstring

The ID of the system disk.

d-bp1e6427vhd320hifvc
OsNamestring

The name of the operating system.

Debian 10.10 64-bit (UEFI)
ContainOsDiskboolean

Indicates whether the system disk is included.

true
ConsistentLevelstring

The consistency level.

CRASH
VmNamestring

The name of the instance.

BNSHSVR42 IPGUARD
DiskHbrSnapshotIdWithDeviceMapobject

The mapping between the device and the recovery point ID.

InstanceIdWithDiskIdListMapobject

The mapping between the instance ID and the disk ID.

InstanceNamestring

The name of the instance.

swh-hbr
OsTypestring

The type of the operating system. Valid values: linux and windows.

windows
Platformstring

The system platform.

CentOS
OsNameEnstring

The English name of the operating system.

Debian 11.1 64 bit
SystemDiskboolean

Indicates whether the disk is a system disk.

true
DiskIdListarray

The ID of the disk that is backed up at the recovery point.

string

The ID of the disk that is backed up at the recovery point.

d-bp1e6427vhd320hifvs
NativeSnapshotIdListarray

The ID of the snapshot.

string

The ID of the snapshot.

s-0004bl6yr5pt89jjsv5a
SnapshotGroupIdstring

The ID of the snapshot group.

ssg-uf6856txcaq31uj***

Example

Request example

http(s)://[Endpoint]/?Action=DescribeUdmSnapshots
&SourceType=UDM_DISK
&StartTime=1642057551
&EndTime=1643092168
&UdmRegionId=cn-hangzhou
&InstanceId=i-bp18x2k7sw925ir7ofh8
&DiskId=d-bp1560750pclffpzxy70
&JobId=job-*********************
&Common request parameters

Normal return example

JSONFormat

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "51CDEECB-7001-51CC-94AC-2A0F2A4B71D2",
  "TotalCount": 3,
  "Success": true,
  "Snapshots": [
    {
      "Status": "COMPLETE",
      "SnapshotHash": "f2fe...",
      "BackupType": "COMPLETE",
      "CreateTime": 1607436917,
      "ActualBytes": "600",
      "SourceType": "UDM_ECS",
      "Prefix": "example/",
      "DiskId": "d-2ze86h5fga5r******a8ef",
      "BytesTotal": 1000,
      "NativeSnapshotInfo": "{\n\t\t\t\t\t\"sourceDiskId\":\"d-bp17misjuy636t82v7b0\",\n\t\t\t\t\t\"lastModifiedTime\":\"2022-03-09T11:35:12Z\",\n\t\t\t\t\t\"snapshotSN\":\"64588-429372675-857161235\",\n\t\t\t\t\t\"snapshotId\":\"s-bp1fbtwv3e6xr6wpe9e0\",\n\t\t\t\t\t\"creationTime\":\"2022-03-09T11:31:12Z\",\n\t\t\t\t\t\"snapshotType\":\"user\",\n\t\t\t\t\t\"usage\":\"none\",\n\t\t\t\t\t\"description\":\"\",\n\t\t\t\t\t\"sourceStorageType\":\"disk\",\n\t\t\t\t\t\"tags\":[\n\t\t\t\t\t\t{\n\t\t\t\t\t\t\t\"tagValue\":\"job-0007e0wqjl0imbrtkmnm\",\n\t\t\t\t\t\t\t\"tagKey\":\"HBR JobId\"\n\t\t\t\t\t\t}\n\t\t\t\t\t],\n\t\t\t\t\t\"productCode\":\"\",\n\t\t\t\t\t\"encrypted\":false,\n\t\t\t\t\t\"sourceDiskType\":\"system\",\n\t\t\t\t\t\"retentionDays\":30,\n\t\t\t\t\t\"snapshotName\":\"Created-from-HBR-job:job-0007e0wqjl0imbrtkmnm\",\n\t\t\t\t\t\"kMSKeyId\":\"\",\n\t\t\t\t\t\"progress\":\"100%\",\n\t\t\t\t\t\"category\":\"standard\",\n\t\t\t\t\t\"sourceDiskSize\":\"20\",\n\t\t\t\t\t\"status\":\"accomplished\"\n\t\t\t\t}",
      "CompleteTime": 1646895666,
      "Retention": 7,
      "CreatedTime": 1642496679,
      "RealSnapshotTime": 1642496679,
      "ParentSnapshotHash": "f2fe..",
      "InstanceId": "i-bp1f0pe78dxi******gxd",
      "StartTime": 1554347313,
      "UpdatedTime": 1642496679,
      "SnapshotId": "s-00047mxg17p26*****b",
      "JobId": "job-00030j3chkt******2",
      "NativeSnapshotId": "s-00047mg17p26x*****b",
      "Detail": {
        "DiskDevName": "/dev/xvdb",
        "DowngradeReason": "HBR.NoRamRoleBound",
        "OsDiskId": "d-bp1e6427vhd320hifvc",
        "OsName": "Debian 10.10 64-bit (UEFI)",
        "ContainOsDisk": true,
        "ConsistentLevel": "CRASH",
        "VmName": "BNSHSVR42 IPGUARD",
        "DiskHbrSnapshotIdWithDeviceMap": {
          "test": "test",
          "test2": 1
        },
        "InstanceIdWithDiskIdListMap": {
          "test": "test",
          "test2": 1
        },
        "InstanceName": "swh-hbr",
        "OsType": "windows",
        "Platform": "CentOS",
        "OsNameEn": "Debian  11.1 64 bit",
        "SystemDisk": true,
        "DiskIdList": [
          "d-bp1e6427vhd320hifvs"
        ],
        "NativeSnapshotIdList": [
          "s-0004bl6yr5pt89jjsv5a"
        ],
        "SnapshotGroupId": "ssg-uf6856txcaq31uj***"
      }
    }
  ]
}

Error codes

For a list of error codes, visit the API error center.