主题
接口描述
获取节点磁盘信息
请求路径
GET
/v1/ant/diskinfo
请求参数
名称 | 类型 | 位置 | 必须 | 描述 |
---|---|---|---|---|
Authorization | string | header | 是 | 鉴权 token |
nodeIds | string | form | 否 | 节点id,多个则用","分隔 |
macs | string | form | 否 | mac地址,多个则用","分隔 |
注:nodeIds和macs必须二选一传入
返回值
名称 | 类型 | 描述 |
---|---|---|
items | []NodeDiskInfo | 节点磁盘信息 |
NodeDiskInfo
名称 | 类型 | 描述 |
---|---|---|
nodeId | string | 节点ID |
diskInfos | []DiskInfo | 磁盘信息 |
DiskInfo
名称 | 类型 | 描述 |
---|---|---|
diskName | string | 磁盘名 |
sn | string | SN号 |
isSystem | bool | 是否为系统盘
|
type | string | 磁盘类型
|
size | int | 磁盘大小,单位:byte |
usage | float | 磁盘利用率 |
wIops | float | 写IOPS |
rIops | float | 读IOPS |
diskMeasureInfo | DiskMeasureInfo | 磁盘压测信息 |
occupantStatus | bool | 磁盘业务使用状态
|
DiskMeasureInfo
名称 | 类型 | 描述 |
---|---|---|
measureCost | int | 压测耗时,单位:秒 |
startTime | string | 压测开始时间 |
state | string | 压测状态
|
请求示例
http://niulinkcloud-example/v1/ant/diskinfo?nodeIds=ant8efb80e1c8f502ba2bb
返回值示例
json
正常请求:
http code 200
{
"items": [
{
"nodeId": "ant8efb80e1c8f502ba2bb",
"diskInfos": [
{
"diskName": "dev1",
"sn": "123456",
"isSystem": true,
"type": "HDD",
"size": 119,
"usage": 10,
"wIops": 100,
"rIops": 100,
"diskMeasureInfo": {
"measureCost": 3600,
"startTime": "2024-02-26 17:02:44",
"state": "taskComplete"
},
"occupantStatus": true
}
]
}
]
}
异常请求:
http code 4xx/5xx
{
"code": 4000001,
"desc": ""
}
错误码列表
错误码 | 描述 |
---|---|
401 | 鉴权失败 |
4000002 | 节点未查找到 |
如接口返回错误码未列举,可在错误码总览中查找