Skip to content

接口描述

获取节点磁盘信息

请求路径

GET /v1/ant/diskinfo

请求参数

名称类型位置必须描述
Authorizationstringheader鉴权 token
nodeIdsstringform节点id,多个则用","分隔
macsstringformmac地址,多个则用","分隔

注:nodeIds和macs必须二选一传入

返回值

名称类型描述
items[]NodeDiskInfo节点磁盘信息

NodeDiskInfo

名称类型描述
nodeIdstring节点ID
diskInfos[]DiskInfo磁盘信息

DiskInfo

名称类型描述
diskNamestring磁盘名
snstringSN号
isSystembool是否为系统盘
  • true:是
  • false:否
typestring磁盘类型
  • HDD
  • SSD
sizeint磁盘大小,单位:byte
usagefloat磁盘利用率
wIopsfloat写IOPS
rIopsfloat读IOPS
diskMeasureInfoDiskMeasureInfo磁盘压测信息
occupantStatusbool磁盘业务使用状态
  • true:使用中
  • false:未使用

DiskMeasureInfo

名称类型描述
measureCostint压测耗时,单位:秒
startTimestring压测开始时间
statestring压测状态
  • taskComplete:已完成
  • taskProcessing:进行中
  • taskFailure:失败

请求示例

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节点未查找到

如接口返回错误码未列举,可在错误码总览中查找