接口功能介绍

查询某可用区全部云硬盘详情。

接口约束

无。

URI

GET /v4/ebs/list-ebs

路径参数 无

Query参数

参数	是否必填	参数类型	说明	示例
regionID	是	String	资源池ID。	41f64827f25f468595ffa3a5deb5d15d
pageNo	否	Integer	默认为1。	1
pageSize	否	Integer	默认为10，最大值为300。	10
decPoolID	否	String	专属云存储池ID，可以查询该专属池下的所有磁盘。	342319ae-d623-4e9e-9dce-2d8ce3ed2681
decPoolName	否	String	专属云存储池名称，可以查询该专属池下的所有磁盘。	test-pool
azName	否	String	可用区。	az1
projectID	否	String	企业项目。	0
diskType	否	String	云硬盘类型。取值为： ●SATA：普通IO。 ●SAS：高IO。 ●SSD：超高IO。 ●FAST-SSD：极速型SSD、 ●XSSD-0、XSSD-1、XSSD-2：X系列云硬盘。	SAS
diskMode	否	String	云硬盘模式。取值为： ●VBD：虚拟块存储设备。 ●ISCSI：小型计算机系统接口。 ●FCSAN：光纤通道协议的SAN网络。	VBD
multiAttach	否	String	是否共享盘。取值为： ●true：共享盘。 ●false：非共享盘。	true
isSystemVolume	否	String	是否为系统盘。取值为： ●true：系统盘。 ●false：数据盘。	false
isEncrypt	否	String	是否加密盘。取值为： ●true：加密盘。 ●false：非加密盘。	false
queryContent	否	String	模糊查询盘的信息，包括盘ID、盘名称、挂载主机ID、挂载主机名称等信息。	test
queryKeys	否	String	指定模糊查询的键。只有传入queryContent才生效，目前支持的值为name（云硬盘名称）、diskID（云硬盘id）、instanceID(挂载云主机id)。指定多个键则用“,”分隔。	name,diskID

请求参数

请求头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

参数	参数类型	说明	示例	下级对象
diskList	Array of Objects	返回数据集合。		diskList
diskTotal	Integer	总数。	2
currentCount	Integer	当前页记录数目。	1
totalCount	Integer	总记录数。	10
totalPage	Integer	总页数。	1
表 diskList

参数	参数类型	说明	示例	下级对象
diskName	String	云硬盘名称。	ebs-hw87
diskID	String	云硬盘ID。	0ae97ef5-6ee2-44af-9d05-1a509b0a1be6
diskSize	Integer	磁盘大小，单位为GB。	10
diskType	String	磁盘规格类型，取值为：
●SATA：普通IO。
●SAS：高IO。
●SSD：超高IO。
●FAST-SSD：极速型SSD。
●XSSD-0、XSSD-1、XSSD-2：X系列云硬盘。	SATA
diskMode	String	云硬盘磁盘模式，取值为：
●VBD（Virtual Block Device）：虚拟块存储设备。
●ISCSI （Internet Small Computer System Interface）：小型计算机系统接口。
●FCSAN（Fibre Channel SAN）：光纤通道协议的SAN网络。	FCSAN
diskStatus	String	参考云硬盘使用状态	available
createTime	Long	创建时刻，epoch时戳，精度为毫秒。	1678501018000
updateTime	Long	更新时刻，epoch时戳，精度为毫秒。	1678501018000
expireTime	Long	过期时刻，epoch时戳，精度为毫秒。	1678501018000
isSystemVolume	Boolean	只有为系统盘时才返回该字段。	true
isPackaged	Boolean	是否随云主机一起订购。	true
instanceName	String	绑定的云主机名称，有挂载时才返回。	ins-jwe8
instanceID	String	绑定的云主机ID，有挂载时才返回。	0ae97ef5-6ee2-44af-9d05-1a509b0a1be6
instanceStatus	String	云主机状态，参考云主机使用状态	running
multiAttach	Boolean	是否是共享云硬盘。	false
attachments	Array of Objects	挂载信息。如果是共享挂载云硬盘，则返回多项；无挂载时不返回该字段。		attachments
projectID	String	云硬盘所属的企业项目ID。	0
isEncrypt	Boolean	是否是加密盘。	true
kmsUUID	String	加密盘密钥UUID，是加密盘时才返回。	0ae97ef5-6ee2-44af-9d05-1a509b0a1be6
regionID	String	资源池ID。	81f7728662dd11ec810800155d307d5b
azName	String	多可用区下的可用区名字，非多可用区不返回该字段。	az2
diskFreeze	Boolean	云硬盘是否已冻结。	false
provisionedIops	Integer	XSSD类型盘的预配置iops，未配置返回0，其他类型云硬盘不返回。	1
decPoolID	String	专属云存储池ID，只有磁盘为专属云盘时才返回。	342319ae-d623-4e9e-9dce-2d8ce3ed2681
decPoolName	String	专属云存储池名称，只有磁盘为专属云盘时才返回。	test-pool
deleteSnapWithEbs	String	是否随云硬盘释放快照。只有支持快照的资源池会返回。	true
snapshotPolicyID	String	云硬盘绑定的快照策略。只有支持快照的资源池会返回。	e7b8dd3d-7628-4470-9d65-ee67d428df6a
iops	Integer	云硬盘iops。只有资源池支持展示iops才会返回。	1800
throughput	Float	云硬盘吞吐量，单位MB/s。只有资源池支持展示吞吐量才会返回。	131
volumeSourceType	String	云硬盘创建源类型。只有单独订购的盘在有数据源场景下返回，取值为:image/snapshot/backup。	backup
volumeSourceID	String	云硬盘创建源ID。只有单独订购的盘在有数据源场景下返回。	0ae97ef5-6ee2-44af-9d05-1a509b0a1be6
表 attachments

参数	参数类型	说明	示例
instanceID	String	绑定的云主机ID。	24690060-c475-ed64-fd2c-7e96f9a1df37
attachmentID	String	挂载ID。	24690060-c475-ed64-fd2c-7e96f9a1df37
device	String	挂载的设备名，例如/dev/sda。	/dev/sda

枚举参数

无

请求示例

请求url

.../v4/ebs/list-ebs?regionID=81f7728662dd11ec810800155d307d5b&pageNo=1&pageSize=20

请求头header

{}

请求体body

无

响应示例

{
	"returnObj": {
		"diskList": [
		{
			"diskName": "ebs-newspec-test0211v7",
			"diskFreeze": false,
			"isPackaged": false,
			"diskMode": "VBD",
			"multiAttach": false,
			"projectID": "0",
			"regionID": "81f7728662dd11ec810800155d307d5b",
			"updateTime": 1676081845000,
			"diskType": "SATA",
			"expireTime": 1678501018000,
			"isEncrypt": false,
			"diskSize": 10,
			"azName": "az2",
			"diskStatus": "available",
			"createTime": 1676081790000,
			"diskID": "0ae97ef5-6ee2-44af-9d05-1a509b0a1be6"
		},
		{
			"diskName": "ebs-newspec-test0211v6",
			"diskFreeze": false,
			"isPackaged": false,
			"diskMode": "VBD",
			"multiAttach": false,
			"projectID": "0",
			"regionID": "81f7728662dd11ec810800155d307d5b",
			"updateTime": 1676081593000,
			"diskType": "SATA",
			"expireTime": 1678500768000,
			"isEncrypt": false,
			"diskSize": 10,
			"azName": "az2",
			"diskStatus": "available",
			"createTime": 1676081534000,
			"diskID": "db9d4a8d-32ba-40d5-b367-3427e42062dd"
		},
		],
		"diskTotal": 2,
		"currentCount": 2,
		"totalCount": 2,
		"totalPage": 2
	},
	"details": "",
	"message": "SUCCESS",
	"description": "成功",
	"statusCode": 800
}

状态码

请参考状态码

错误码

请参考错误码

智算服务

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

云硬盘

云硬盘

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码

活动

智算服务

应用商城

定价

合作伙伴

开发者

支持与服务

了解天翼云

云硬盘

云硬盘

接口功能介绍

接口约束

URI

请求参数

响应参数

枚举参数

请求示例

响应示例

状态码

错误码