Skip to Content
快照服务 USnap获取磁盘快照服务列表 - DescribeSnapshotService

获取磁盘快照服务列表 - DescribeSnapshotService

简介

获取磁盘快照服务列表

定义

公共参数

参数名类型描述信息必填
Actionstring对应的 API 指令名称,当前 API 为 DescribeSnapshotServiceYes
PublicKeystring用户公钥,可从 控制台 获取Yes
Signaturestring根据公钥及 API 指令生成的用户签名,参见 签名算法Yes

请求参数

参数名类型描述信息必填
Regionstring地域。 参见 地域和可用区列表Yes
Zonestring可用区。参见 可用区列表Yes
ProjectIdstring项目ID。不填写为默认项目,子帐号必须填写。 请参考GetProjectList接口No
Offsetint数据偏移量, 默认为0No
Limitint返回数据长度, 默认为20No
SnapshotServiceIdstring快照服务ID(传入则获取当前快照服务ID, 不传则获取当前可用区快照服务列表)No
VDiskIdstring磁盘ID (传入则获取当前盘快照服务, 不传则获取当前可用区快照服务列表)No
SnapshotIdstring快照ID (传入则获取当前快照对应盘的快照服务, 不传则获取当前可用区快照服务列表,磁盘ID和快照ID同时传入以磁盘ID为准)No

响应字段

字段名类型描述信息必填
RetCodeint返回状态码,为 0 则为成功返回,非 0 为失败Yes
Actionstring操作指令名称Yes
Messagestring返回错误消息,当 RetCode 非 0 时提供详细的描述信息No
DataSetarray[SnapshotServiceDataSet]快照服务列表No
TotalCountint快照服务DataSet总数No

数据模型

SnapshotServiceDataSet

字段名类型描述信息必填
Zonestring可用区信息No
CreateTimeint创建时间Yes
VDiskIdstring磁盘IdYes
Statusstring状态:Available(可用),InAvailable(不可用),Expired(欠费)Yes
VDiskTypestring”UDiskData” 云盘数据盘; ”UDiskBoot“ 云盘系统盘Yes
VDiskStatusint磁盘是否可用,1表示可用,0表示不可用Yes
VDiskSizeint磁盘大小 (G)Yes
ServiceIdstring服务IDNo
VDiskNamestring磁盘名No
ExpiredTimeint过期时间No
ChargeTypestring计费类型No
IsExpirestring计费是否过期No
AutoRenewstring是否自动续费No
Tagstring业务组No

示例

请求示例

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

响应示例

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