Docs
api
Cloud Disk(UDisk)
CreateUDiskSnapshot

Create Snapshot - CreateUDiskSnapshot

Overview

Create snapshot

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is CreateUDiskSnapshot.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 ListYes
ProjectIdstringProject ID. If not filled in, the default project is used, and the sub-account must be filled in. Please refer to the GetProjectList interface.No
UDiskIdstringSnapshot's UDisk IdYes
NamestringSnapshot NameYes
QuantityintPurchase Duration Default: 1 (Deprecated)No
ChargeTypestringYear, Month, Dynamic Default: Dynamic (Deprecated)No
CommentstringSnapshot DescriptionNo

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
SnapshotIdarray[string]Snapshot IdYes

Example

Request Example

https://api.ucloud-global.com/?Action=CreateUDiskSnapshot
&Region=cn-bj2
&Zone=cn-bj2-04
&UDiskId=bs-xxx
&Name=test_snapshot
&Comment=test

Response Example

{
  "Action": "CreateUDiskSnapshotResponse",
  "RetCode": 0,
  "SnapshotId": [
    "bsSnap-xxx"
  ]
}