- DescribeSnapshotService

Overview

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	Required
Region	string	Yes
Zone	string	Yes
ProjectId	string	No
Offset	int	No
Limit	int	No
SnapshotServiceId	string	No
VDiskId	string	No
SnapshotId	string	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]		No
TotalCount	int		No

Data Model

SnapshotServiceDataSet

Field Name	Type	Required
Zone	string	No
CreateTime	int	Yes
VDiskId	string	Yes
Status	string	Yes
VDiskType	string	Yes
VDiskStatus	int	Yes
VDiskSize	int	Yes
ServiceId	string	No
VDiskName	string	No
ExpiredTime	int	No
ChargeType	string	No
IsExpire	string	No
AutoRenew	string	No
Tag	string	No

Example

Request Example


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