Get USnap List - DescribeSnapshotService

Overview

Get USnap List

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeSnapshotService`.	Yes
PublicKey	string	The user’s public key can be obtained from Console	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required
Region	string	Region. See List of Regions and Availability Zones	Yes
Zone	string	Availability Zone. See Availability Zone List	Yes
ProjectId	string	Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.	No
Offset	int	Data offset, default is 0	No
Limit	int	Return data length, default is 20	No
SnapshotServiceId	string	Snapshot Service ID (If passed in, the current Snapshot Service ID will be obtained, if not passed in, the list of Snapshot Services in the current available zone will be obtained)	No
VDiskId	string	Disk ID (If provided, get the current disk snapshot service, if not provided, get the list of snapshot services available in the current availability zone)	No
SnapshotId	string	Snapshot ID (If entered, the snapshot service corresponding to the current snapshot disk will be obtained, if not entered, the snapshot service list of the current available zone will be obtained, if both disk ID and snapshot ID are entered, the disk ID will be prioritized)	No

Response Field

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No
DataSet	array[SnapshotServiceDataSet]	Snapshot Service List	No
TotalCount	int	Snapshot Service DataSet Total	No

Data Model

SnapshotServiceDataSet

Field Name	Type	Description Information	Required
Zone	string	Availability Zone Information	No
CreateTime	int	Creation Time	Yes
VDiskId	string	Disk Id	Yes
Status	string	Status: Available (Available), InAvailable (Unavailable), Expired (Arrears)	Yes
VDiskType	string	UDiskData” Cloud Disk Data Disk; “UDiskBoot” Cloud Disk System Disk.	Yes
VDiskStatus	int	Is the disk available, 1 indicates available, 0 indicates not available	Yes
VDiskSize	int	Disk Size (G)	Yes
ServiceId	string	Service ID	No
VDiskName	string	Disk Name	No
ExpiredTime	int	Expiration Time	No
ChargeType	string	Billing Type	No
IsExpire	string	Is the billing expired?	No
AutoRenew	string	Auto-renewal?	No
Tag	string	Business Group	No

Example

Request Example


https://api.nubexcloud.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
}