Docs
api
Snapshot(USnap)
DescribeSnapshotService

- DescribeSnapshotService

Overview

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribeSnapshotService.Yes
PublicKeystringThe user’s public key can be obtained from ConsoleYes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringYes
ZonestringYes
ProjectIdstringNo
OffsetintNo
LimitintNo
SnapshotServiceIdstringNo
VDiskIdstringNo
SnapshotIdstringNo

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[SnapshotServiceDataSet]No
TotalCountintNo

Data Model

SnapshotServiceDataSet

Field NameTypeDescription InformationRequired
ZonestringNo
CreateTimeintYes
VDiskIdstringYes
StatusstringYes
VDiskTypestringYes
VDiskStatusintYes
VDiskSizeintYes
ServiceIdstringNo
VDiskNamestringNo
ExpiredTimeintNo
ChargeTypestringNo
IsExpirestringNo
AutoRenewstringNo
TagstringNo

Example

Request Example

https://api.dezai.com/?Action=DescribeSnapshotService
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=CeigGZFc
&Offset=9
&Limit=4
&VDiskId=BEjwyiFd
&SnapshotId=JAQOCYXO
&SnapshotId=zSeLTmxM
&SnapshotServiceId=eHiegDYn

Response Example

{
  "Action": "DescribeSnapshotServiceResponse",
  "DataSet": [
    {
      "CreateTime": 5,
      "ServiceId": "PRTbzCzM",
      "Status": "vVArIRBK",
      "VDiskId": "gHjSEVdN"
    }
  ],
  "RetCode": 0,
  "TotalCount": 2
}