智简魔方文档

机柜租用列表

本文说明智简魔方 DCIM 系统中“机柜租用列表”相关的接口或函数信息,供开发人员在集成、调用和排查问题时参考。

概述

查询系统下的所有符合条件的机柜租用信息

URL

/index.php?m=api&a=cabinetRentListing

请求参数

字段名变量名必填类型描述
搜索类型searchstring搜索类型(house:机房 ID,cabinet:机柜 ID,key:IP 或者邮箱)
搜索内容keystring结合搜索类型对机柜租用信息进行搜索,搜索类型为 house 时,调用/index.php?m=api&a=getHouse 获取由 id(机房 ID)和 name(机房名称)组成的二维数组,选择传递 ID;搜索类型为 cabinet 时,调用/index.php?m=api&a=getCabinet 获取由 id(机柜 ID)和 name(机柜名称)组成的二维数组,选择传递 ID;
分页数量listpagesint每一页显示的数据的数量
排序类型orderbystring用来排序的字段
排序规则sortingstring升序 asc 降序 desc
数据偏移量offsetint返回数据的偏移指针,与分页数量结合使用

返回参数

字段名变量名类型描述
机柜租用列表listingarray
id 机柜租用idname 机柜租用名称vlan 机柜vlanbandwidth 带宽type 机柜租用类型(1:全柜,2:1/2,4:1/4)
expiretime 到期时间clientid 客户idcabinet_p 租用机柜的位置
email 客户邮箱
serverid 机柜serverid
sum IP总数
cid 所属机柜ID
cabinet 所属机柜名称
assort 机柜租用类型(1:机柜,2:带宽)
status 机柜租用状态(1:正常,2:到期)
groupid 机柜位置分组idswitch 交换机端口连接信息
根据查询条件查询到的所有机柜租用数据
机柜总数sumint系统内机柜数据的总数
分页数量listpagesint每一页显示的数据的数量
搜索类型searchstring传入的搜索类型
搜索内容keystring传入的搜索内容
排序类型orderbystring用来排序的字段
排序规则sortingstring升序 asc 降序 desc
数据偏移量offsetint返回数据的偏移指针,与分页数量结合使用
状态statusstringsuccess 成功 error 失败