接口功能介绍

无。

接口约束

无。

URI

GET /v4/ebs_snapshot/list-ebs-snap

路径参数 无

Query参数

参数	是否必填	参数类型	说明	示例
regionID	是	String	资源池ID，请根据查询资源池列表接口返回值进行传参，获取“regionId”参数。	fc862f71-d629-4a0e-9fe0-b104963b3f05
diskID	否	String	云硬盘ID。	61f69121-4036-4f31-a148-457eb8a45fee
snapshotID	否	String	云硬盘快照ID。	cafa8c74-42e7-4e32-921c-d7b2c75dac27
snapshotName	否	String	云硬盘快照名称。支持输入名称的一部分做模糊匹配。	test-snap
snapshotStatus	否	String	云硬盘快照状态。取值为： ●available：可用。 ●freezing：冻结。 ●creating：创建中。 ●deleting：删除中。 ●rollbacking：回滚中。 ●cloning：从快照创建云硬盘中。 ●error：错误。	available
snapshotType	否	String	云硬盘快照创建类型。取值为： ●manu：手动。 ●timer：自动。	manu
volumeAttr	否	String	云硬盘属性。取值为： ●data：数据盘。 ●system：系统盘。	data
retentionPolicy	否	String	云硬盘快照保留策略。取值为： ●forever：永久保留。 ●custom：自定义保留天数。	custom
maxResults	否	Integer	期望返回快照的数量，默认10，最大值为1000。默认值仅当参数nextToken指定了参数值时才有效，否则默认值及整个参数都无效。受此参数限制而未返回的快照，可通过nextToken参数带入返回消息中returnObj对象里同名参数的值进行接续查询。	10
nextToken	否	String	期望返回的首个快照的标志，默认为满足以上请求参数过滤条件的最后创建的快照的标志。默认值仅当参数maxResults指定了参数值时才有效，否则默认值及整个参数都无效。返回的快照数受参数maxResults限制，一般首次请求不为此参数指定参数值，后续指定返回消息中returnObj对象里同名参数的值进行接续查询。	cafa8c74-42e7-4e32-921c-d7b2c75dac27

请求参数

请求头header参数 无

请求体body参数 无

响应参数

参数	参数类型	说明	示例	下级对象
statusCode	Integer	返回状态码（800为成功，900为失败）。	800
message	String	成功或失败时的描述，一般为英文描述。	region info empty
description	String	成功或失败时的描述，一般为中文描述。	资源池信息为空。
returnObj	Object	返回数据结构体。		returnObj
errorCode	String	业务细分码，为product.module.code三段式码。请参考错误码。	ebs.regionInfo.empty
error	String	业务细分码，为product.module.code三段式大驼峰码。请参考错误码。	Ebs.RegionInfo.Empty
表 returnObj

参数	参数类型	说明	示例	下级对象
snapshotSize	Integer	云硬盘快照使用量，单位为B。	1024
snapshotTotal	Integer	云硬盘快照总个数。	24
snapshotList	Array of Objects	云硬盘快照列表。		snapshotList
snapshotManuTotal	Integer	云硬盘手动快照总个数，只有传diskID时返回此字段。	8
nextToken	String	下一个快照的标志。当下一个快照不存在时，此字段没有有效返回值。仅当请求参数指定nextToken或maxResults时此参数才有意义。	cafa8c74-42e7-4e32-921c-d7b2c75dac27
表 snapshotList

参数	参数类型	说明	示例
availabilityZone	String	可用区名称。	可用区2
snapshotName	String	云硬盘快照名称。	test
snapshotStatus	String	云硬盘快照状态， creating/deleting/rollbacking /cloning/available/error，分别对应创建中/ 删除中/回滚中 /从快照创建云硬盘中/ 可用/错误	available
createTime	String	创建时间。	2022-11-08T10:07:28Z
azName	String	可用区名称。	az2
deleteTime	String	删除时间。	2022-11-08T10:07:28Z
description	String	描述信息。	test
expireTime	String	过期时间。	2022-11-08T10:07:28Z
freezing	Boolean	是否被冻结。	true
isEncryted	Boolean	是否是加密盘。	true
isMaz	Boolean	是否跨AZ。	true
regionID	String	资源池ID。	81f7728662dd11ec810800155d307d5b
isTalkOrder	Boolean	是否是按需计费资源。	true
retentionPolicy	String	快照保留策略，取值为：
●custom：自定义保留天数。
●forever：永久保留。	custom
retentionTime	String	快照保留时间。	0
snapshotID	String	快照ID。	cafa8c74-42e7-4e32-921c-d7b2c75dac27
snapshotType	String	快照类型，取值为：
●manu：手动。
●timer：自动。	timer
updateTime	String	更新时间。	2022-11-08T10:07:28Z
volumeAttr	String	云硬盘属性，取值为：
●data：数据盘。
●system：系统盘。	data
volumeName	String	云硬盘名称。	test
volumeSize	Integer	云硬盘大小。	24
volumeSource	String	云硬盘来源，如果为空，则是普通云硬盘，如果不为空，则是由快照创建而来，显示来源快照ID	cafa8c74-42e7-4e32-921c-d7b2c75da123
volumeStatus	String	云硬盘的状态，请参考云硬盘使用状态	in-use
diskID	String	云硬盘ID。	61f69121-4036-4f31-a148-457eb8a45123
volumeType	String	云硬盘类型，取值为：
●SATA：普通IO。
●SAS：高IO。
●SSD：超高IO。
●FAST-SSD：极速型SSD。
●XSSD-0、XSSD-1、XSSD-2：X系列云硬盘。	SATA

枚举参数

无

请求示例

请求url

无

请求头header

{}

请求体body

{
	"regionID":"fc862f71-d629-4a0e-9fe0-b104963b3f05",
	"diskID ":"61f69121-4036-4f31-a148-457eb8a45fee"
}

响应示例

{
	"statusCode": 800,
	"returnObj": {
		"snapshotTotal": 1,
        "snapshotManuTotal": 1,
		"snapshotSize": 1024,
		"snapshotList":[
		            {
		                "availabilityZone" : "可用区2",
		                "azName" :  "az2",
		                "createTime" : "2022-11-08T10:07:28Z",
		                "deleteTime" : null,
		                "description" : "",
		                "expireTime" : null,
		                "freezing" : false,
		                "isEncryted" : false,
		                "isMaz" : false,
		                "isTalkOrder" : true,
		                "snapshotName" : "ksjdhfkkasjdhfk",
		                "regionID" : "73f321ea-62ff-11ec-a8bc-005056898fe0",
		                "retentionPolicy" : "forever",
		                "retentionTime" : 0,
		                "snapshotID" : "cafa8c74-42e7-4e32-921c-d7b2c75dac27",
		                "snapshotType" : "manu",
		                "snapshotStatus" : "available",
		                "updateTime" : "2022-11-08T10:07:28Z",
		                "volumeAttr" : "data",
		                "volumeName" : "ecm-bin005-volume-001",
		                "volumeSize" : 5,
		                "volumeSource" : "",
		                "volumeStatus" : "in-use",
		                "volumeType" : "SAS",
		                "diskID" : "61f69121-4036-4f31-a148-457eb8a45fee",
		            }
		],
	},
	"message": "SUCCESS",
	"description": "成功"
}

状态码

请参考状态码

错误码

请参考错误码

智算服务

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

云硬盘

云硬盘

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码

活动

智算服务

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

云硬盘

云硬盘

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码