DCIM API 文档 / 机柜 / 机柜租用列表
▍概述
查询系统下的所有符合条件的机柜租用信息
▍URL
/index.php?m=api&a=cabinetRentListing
▍请求参数
| 字段名 | 变量名 | 必填 | 类型 | 描述 |
|---|---|---|---|---|
| 搜索类型 | search | 否 | string | 搜索类型（house：机房ID，cabinet：机柜ID，key：IP或者邮箱） |
| 搜索内容 | key | 否 | string | 结合搜索类型对机柜租用信息进行搜索，搜索类型为house时，调用/index.php?m=api&a=getHouse获取由id（机房ID）和name（机房名称）组成的二维数组，选择传递ID；搜索类型为cabinet时，调用/index.php?m=api&a=getCabinet获取由id（机柜ID）和name（机柜名称）组成的二维数组，选择传递ID； |
| 分页数量 | listpages | 否 | int | 每一页显示的数据的数量 |
| 排序类型 | orderby | 否 | string | 用来排序的字段 |
| 排序规则 | sorting | 否 | string | 升序 asc 降序 desc |
| 数据偏移量 | offset | 否 | int | 返回数据的偏移指针,与分页数量结合使用 |
▍返回参数
| 字段名 | 变量名 | 类型 | 描述 |
|---|---|---|---|
| 机柜租用列表 | listing | array id 机柜租用id name 机柜租用名称 vlan 机柜vlan bandwidth 带宽 type 机柜租用类型（1：全柜，2：1/2，4：1/4）expiretime 到期时间 clientid 客户id cabinet_p 租用机柜的位置email 客户邮箱 serverid 机柜serverid sum IP总数 cid 所属机柜ID cabinet 所属机柜名称 assort 机柜租用类型（1：机柜，2：带宽） status 机柜租用状态（1：正常，2：到期） groupid 机柜位置分组id switch 交换机端口连接信息 | 根据查询条件查询到的所有机柜租用数据 |
| 机柜总数 | sum | int | 系统内机柜数据的总数 |
| 分页数量 | listpages | int | 每一页显示的数据的数量 |
| 搜索类型 | search | string | 传入的搜索类型 |
| 搜索内容 | key | string | 传入的搜索内容 |
| 排序类型 | orderby | string | 用来排序的字段 |
| 排序规则 | sorting | string | 升序 asc 降序 desc |
| 数据偏移量 | offset | int | 返回数据的偏移指针,与分页数量结合使用 |
| 状态 | status | string | success 成功 error 失败 |