1)接口功能介绍
查看用户所在集群的本地盘列表。
2)接口约束
确定正确的nodeCode,可通过查看区域集群编码列表接口获取。
3)URI
GET /v1/describeLvmDisks。
4)请求参数
Query参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
nodeCode | 是 | String | 边缘池id,可通过查看区域集群编码列表接口获取 | cn-guangzhou3 | |
instanceType | 否 | String | 挂载的实例类型。 未知 UNKNOWN = 0; emc EMC = 1; eci ECI = 2; evm EVM = 3; | EVM | |
name | 否 | String | 硬盘名称(customName)或绑定实例名称(instanceName) | evm-opb0 | |
diskInstanceName | 否 | String | 云盘实例名称 | ||
page | 否 | Integer | 默认值为1 当前页数 | 1 | |
perPageNum | 否 | Integer | 每页显示的记录条数,默认值为10 | 10 | |
state | 否 | Integer | 硬盘状态, 查询所有: -1, 查询正常: 0, 查询已释放: 1, 查询已删除: 2, 查询删除中: 3, 查询挂载中: 4, 查询卸载中: 5, 查询可用: 6 | 1 |
5)响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
requestId | 是 | String | 请求id | b84233d3-0796-xxx | |
status | 是 | Object | 应答状态 | status | |
data | 是 | List | 返回数据 | data |
表 status
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
message | 是 | String | 状态描述 | Success | |
code | 是 | String | 状态码 | Success |
表 data
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
totalPage | 是 | Integer | 1 | 总页数 | |
total | 是 | Integer | 6 | 记录总个数 | |
page | 是 | Integer | 1 | 当前页数 | |
perPageNum | 是 | Integer | 10 | 每页显示的记录条数 | |
diskInfos | 是 | List | * | 磁盘信息列表 | diskInfos |
表 diskInfos
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
id | 是 | Integer | 硬盘ID | 1583 | |
customName | 是 | String | 用户自定义硬盘名 | cd-abc* | |
isSystemDisk | 是 | Boolean | 是否系统盘 | false | |
diskSize | 是 | Integer | 硬盘容量大小,单位为G | 10 | |
state | 否 | String | 硬盘状态 正常 ACTIVE = 0; 已释放 RELEASED = 1; 已删除 DELETED = 2; 删除中 DELETING = 3; 挂载中MOUNTING = 4; 卸载中 UNMOUNTING= 5; 可用 AVAILABLE = 6; 所有 ALLSTATE = -1; | ACTIVE | |
instanceType | 是 | String | 挂载的实例类型。 未知 UNKNOWN = 0; emc EMC = 1; eci ECI = 2; evm EVM = 3; | EVM | |
instanceId | 是 | Integer | 挂载的实例ID | 150 | |
instanceName | 是 | List | 挂载的实例名称 | * | |
vmName | 是 | List | 挂载的虚机名称 | * | |
diskIOType | 是 | String | 硬盘IO类型。 HHD 普通IO NORMAL = 0; SSD 高IO HIGH = 1; NVME 超高IO ULTRA = 2; 列表接口默查所有类型 ALL_IO_TYPE = -1; | HIGH | |
createTime | 是 | String | 创建时间 | 142334534 | |
modifyTime | 是 | String | 修改时间 | 142334534 | |
diskInstanceName | 是 | String | 硬盘实例id | cd-lskdjfl** | |
priceType | 是 | Integer | 计费类型.价格类型,目前只支持按需付费和包年包月. 付费信息,取值有ANNUAL_OR_MONTHLY,PAY_FOR_USE FIXED_BANDWIDTH: 按固定带宽 TRAFFIC_BILLING: 按流量计费 AV_DAILY_PEAK_95: 按月均日95峰值 ANNUAL_OR_MONTHLY: 包年包月 BANDWIDTH_FACTOR: 带宽折算 PAY_FOR_USE: 按需付费 FREE: 免费 MONTHLY_PEAK_95: 月95峰 PRICE_TYPE_UNDEFINED: 未定义 | 1 | |
subnetIp | 否 | String | evm 内网ip | 190.14.2.212 | |
address | 否 | List`` | 外网ip | * | |
bus | 是 | String | 磁盘驱动类型, 存储驱动类型,virtio驱动支持离线挂载/卸载,SCSI驱动支持在线挂载/卸载 | SCSI |
6)请求示例
GET https://{host}/v1/describeLvmDisks?nodeCode=jx-xxx-1&instanceType=EVM&instanceName=evm-xxx&diskInstanceName=lvm-xxx&page=1&perPageNum=10
7)响应示例
{
"status": {
"message": "Success",
"code": "Success"
},
"data": {
"totalPage": 1,
"total": 1,
"page": 1,
"perPageNum": 10,
"diskInfos": [
{
"instanceId": 0,
"instanceName": [
"evm-xxx"
],
"customName": "disk-o7m0",
"diskInstanceName": "lvm-xxx",
"subnetIp": "",
"vmName": [
"evm-eop-test"
],
"createTime": "1669647170",
"id": 3807,
"diskIOType": "NORMAL",
"state": "ACTIVE",
"diskSize": 20,
"modifyTime": "1669647170",
"bus": "SCSI",
"address": [],
"isSystemDisk": true,
"instanceType": "EVM",
"priceType": 1
}
]
},
"requestId": "83dc4ca6-b3b2-4c8d-91d3-78d2853d85e3"
}
8)状态码
状态码 | 描述 |
---|---|
Success | 表示请求成功。 |