1)接口功能介绍
查询集群可用磁盘信息。
2)接口约束
nodeCode边缘池id需要正确,可通过查看区域集群编码列表接口获取。
3)URI
GET /v1/listDisk。
4)请求参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
nodeCode | 是 | String | 边缘池id,可通过查看区域集群编码列表接口获取。 | cn-guangzhou3 | |
priceType | 是 | String | 价格类型,目前只支持按需付费和包年包月. 付费信息,取值有ANNUAL_OR_MONTHLY,PAY_FOR_USE | PAY_FOR_USE |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | object | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
cloudDiskList | 是 | List | 云盘信息列表 | cloudDiskList | |
lvmDiskList | 是 | List | 本地盘信息列表 | lvmDiskList | |
rawDiskList | 是 | List | 本地裸盘信息列表 | rawDiskList | |
nvmeDiskList | 是 | List | NVMe盘信息列表 | nvmeDiskList |
表cloudDiskList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
offerId | 否 | Integer | 云盘规格id | 123 | |
productInstanceName | 否 | String | 云盘产品实例名称 | hdd.eds | |
ioType | 否 | String | 云盘IO类型。io类型. 磁盘IO类型: NORMAL: HHD , HIGH: SSD 高IO, ULTRA: NVME 超高IO | NORMAL | |
systemDiskType | 否 | String | 创建自定义规格虚机使用的非共享类型系统盘类型 。 UNDEFINE: 未知, Cloud_Disk: cd, LVM_Disk_HDD: lvm_hdd, LVM_Disk_SSD: lvm_ssd, LVM_Disk_NVME: lvm_nvme, RAW_Disk_HDD: raw_hdd, RAW_Disk_SSD: raw_ssd, RAW_Disk_NVME: raw_nvme, LVM_Disk_ALLTYPE: lvm_all_type, RAW_Disk_ALLTYPE: raw_all_type, ZFS_Disk_HDD: zfs hdd, ZFS_Disk_SSD: zfs ssd, Cloud_Disk_SSD: cd ssh, Cloud_Disk_NVME: cd nvme | Cloud_Disk |
表lvmDiskList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
offerId | 否 | Integer | 本地盘规格id | 123 | |
productInstanceName | 否 | String | 本地盘产品实例名称 | ssd.lvm | |
ioType | 否 | String | 本地盘IO类型。磁盘IO类型: NORMAL: HHD , HIGH: SSD 高IO, ULTRA: NVME 超高IO | HIGH | |
systemDiskType | 否 | String | 创建自定义规格虚机使用的非共享类型系统盘类型。UNDEFINE: 未知, Cloud_Disk: cd, LVM_Disk_HDD: lvm_hdd, LVM_Disk_SSD: lvm_ssd, LVM_Disk_NVME: lvm_nvme, RAW_Disk_HDD: raw_hdd, RAW_Disk_SSD: raw_ssd, RAW_Disk_NVME: raw_nvme, LVM_Disk_ALLTYPE: lvm_all_type, RAW_Disk_ALLTYPE: raw_all_type, ZFS_Disk_HDD: zfs hdd, ZFS_Disk_SSD: zfs ssd, Cloud_Disk_SSD: cd ssh, Cloud_Disk_NVME: cd nvme | Cloud_Disk | |
diskType | 否 | String | 本地盘类型。取值类型:LVM、ZFS | LVM |
表rawDiskList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
ioType | 否 | String | 本地裸盘IO类型 | NORMAL | |
specList | 否 | Integer | 当前IO类型本地裸盘规格信息列表 | ||
offerId | 否 | Integer | 本地裸盘销售规格id | 123 | |
specId | 否 | Integer | 本地裸盘规格id | 123 | |
specSize | 否 | Integer | 本地裸盘大小,单位GB | 200 | |
maxCount | 否 | Integer | 当前集群本规格本地裸盘所能使用的最大数量 | 50 |
表nvmeDiskList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
offerId | 否 | Integer | NVMe盘销售规格id | 123 | |
specId | 否 | Integer | NVMe盘规格id | 123 | |
specSize | 否 | Integer | NVMe盘大小,单位GB | 200 | |
maxCount | 否 | Integer | 当前集群本规格NVMe盘所能使用的最大数量 | 50 | |
productInstanceName | 否 | String | NVMe盘产品实例名称 | abc | |
pciResourceName | 否 | String | NVMe直通的设备资源名称 | abc |
6)请求示例
GET https://{host}/v1/listDisk?nodeCode=yn-baoshan-1&priceType=PAY_FOR_USE
7)响应示例
{
"status": {
"message": "Success",
"code": "Success"
},
"data": {
"nvmeDiskList": [],
"rawDiskList": [
{
"specList": [
{
"systemDiskType": "RAW_Disk_HDD",
"specId": 3,
"offerId": 15,
"specSize": 3725,
"maxCount": 6
}
],
"ioType": "NORMAL"
},
{
"specList": [
{
"systemDiskType": "RAW_Disk_SSD",
"specId": 4,
"offerId": 85,
"specSize": 446,
"maxCount": 2
}
],
"ioType": "HIGH"
}
],
"lvmDiskList": [
{
"ioType": "NORMAL",
"systemDiskType": "ZFS_Disk_HDD",
"productInstanceName": "hdd.zfs",
"offerId": 76,
"diskType": "ZFS"
}
],
"cloudDiskList": []
},
"requestId": "fa725dc8-448e-4e13-8f5f-6eb6296adf0f"
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |