服务器列表/服务器/DCIM API 文档 - 智简魔方

DCIM API 文档

返回首页

DCIM API 文档 / 服务器 / 服务器列表

▍概述

查询系统下的所有符合条件的服务器硬件信息

▍URL

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

▍请求参数

字段名	变量名	必填	类型	描述
搜索类型	search	否	string	搜索类型（house：机房ID，cabinet：机柜ID，power：电源状态，key：IP或者物理标签或者内部标签，highgrade：高级搜索，special：特殊搜索）
搜索内容	key	否	string	对服务器硬件信息的搜索，搜索类型为house时，调用/index.php?m=api&a=getHouse获取由id（机房ID）和name（机房名称）组成的二维数组，选择传递ID；搜索类型为cabinet时，调用/index.php?m=api&a=getCabinet获取由id（机柜ID）和name（机柜名称）组成的二维数组，选择传递ID；搜索类型为电源状态时，选择（on：开机，off：关机，error：未知）其一传递；
分页数量	listpages	否	int	每一页显示的数据的数量
排序类型	orderby	否	string	用来排序的字段
排序规则	sorting	否	string	升序 asc 降序 desc
数据偏移量	offset	否	int	返回数据的偏移指针,与分页数量结合使用
服务器类型	type	否	string	搜索的服务器类型，（1：租用，2：自用，5：托管）
cpu	cpu	否	array	高级/特殊搜索参数（search的值为highgrade或special时使用），CPU的ID，调用/index.php?m=api&a=getCpu获取由id（CPU ID）和name（CPU名称）组成的二维数组
cpu数量	cpu_num	否	int	高级/特殊搜索参数（search的值为highgrade或special时使用），CPU数量
内存	ram	否	array search为special时为二维数组	高级/特殊搜索参数（search的值为highgrade或special时使用），内存ID，调用/index.php?m=api&a=getRam获取由id（内存ID）和name（内存名称）组成的二维数组
内存数量	ram_num	否	search为highgrade时为int search为special时为array	高级/特殊搜索参数（search的值为highgrade或special时使用），内存数量 search为special时，ram数组和ram_num数组的值根据下标一一对应代表搜索x个a/c，y个b/d
硬盘	disk	否	array search为special时为二维数组	高级/特殊搜索参数（search的值为highgrade或special时使用），硬盘ID，调用/index.php?m=api&a=getDisk获取由id（硬盘ID）和name（硬盘名称）组成的二维数组
硬盘数量	disk_num	否	search为highgrade时为int search为special时为array	高级/特殊搜索参数（search的值为highgrade或special时使用），硬盘数量 search为special时，disk数组和disk_num数组的值根据下标一一对应代表搜索x个a/c，y个b/d
PCI	pci	否	array search为special时为二维数组	高级/特殊搜索参数（search的值为highgrade或special时使用），PCI ID，调用/index.php?m=api&a=getPci获取由id（PCI ID）和name（PCI名称）组成的二维数组
PCI数量	pci_num	否	search为highgrade时为int search为special时为array	高级/特殊搜索参数（search的值为highgrade或special时使用），硬盘数量 search为special时，pci数组和pci_num数组的值根据下标一一对应代表搜索x个a/c，y个b/d
ip	ip	否	string	高级搜索参数（search的值为highgrade时使用），IP地址
ip数量	ip_num	否	int	高级搜索参数（search的值为highgrade时使用），IP数量
内存容量	ram_capacity	否	int	特殊搜索参数（search的值为special时使用），内存容量
过滤规则	filter	否	int	特殊搜索参数（search的值为special时使用），0：一致，1：包含

▍返回参数

字段名	变量名	类型	描述
服务器硬件列表	listing	array id 服务器硬件id wltag 物理标签 nbtag 内部标签 cpu 一维数组（name：cpu名称，num：cpu数量） ram 二维数组（name：内存名称，num：内存数量） disk 二维数组（name：硬盘名称，num：硬盘数量） pci 二维数组（name：pci名称，num：pci数量） time 上架时间 serverid 服务器软件ID stype 类型（1租用，2自用，5托管，8机柜客户） power 电源状态（error：错误，on：开机，off：关机，nonsupport：不支持） intranet_id 内网ID lock 锁定mac（0：不锁定，1：锁定） mac mac地址 ipmi_name ipmi用户名 ipmi_pass ipmi密码 power_msg 电源状态信息 zhuip 主IP subnetmask 子网掩码 gateway 网关 ipmi_ip IPMI IP vlan 连接交换机可用vlan switch_id 连接交换机id switch_num 连接交换机端口号 switch_num_name 连接交换机端口号名称 in_bw 连接交换机端口入口带宽 out_bw 连接交换机端口出口带宽 vlanid 连接交换机端口vlan port_mac 连接交换机端口mac地址（数组） mac_diff mac地址和交换机端口mac地址是否不同（0：相同。1：不同） typename 硬件型号名称 pid 连接PDU设备ID pdu 连接PDU设备名称 pdu_num 连接PDU设备端口 showtype pdu端口显示类型（0：数字，1：字母） ipmi_support 支持IPMI控制（true，false） cid 所属机柜ID cname 所属机柜名称 house 机房id house_name 机房名称 osname 操作系统 os_id 操作系统id os_group_id 操作系统分组id osusername 系统账号 ospassword 系统密码 sum 分配ip总数 ip 分配ip（数组）	根据查询条件查询到的所有服务器硬件数据
服务器内网	intranetServer	array id 服务器id wltag 服务器物理标签	服务器内网，数组下标为服务器软件ID
服务器连接交换机	switch	array sid 交换机ID sname 交换机名称 switch_num 交换机端口号	服务器连接交换机，数组下标为服务器硬件ID
服务器总数	sum	int	系统内服务器硬件数据的总数
分页数量	listpages	int	每一页显示的数据的数量
搜索类型	search	string	搜索类型
搜索内容	key	string	自定义的搜索内容
排序类型	orderby	string	用来排序的字段
排序规则	sorting	string	升序 asc 降序 desc
数据偏移量	offset	int	返回数据的偏移指针,与分页数量结合使用
服务器类型	type	string	搜索的服务器类型
状态	status	string	success 成功 error 失败

0