智简魔方文档

服务器销售列表

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

概述

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

URL

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

请求参数

字段名变量名必填类型描述
搜索类型search否string搜索类型(house:机房 ID,cabinet:机柜 ID,power:电源状态,status:销售状态,key:IP 或者物理标签或者内部标签或者 MAC 地址,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:未知)其一传递;搜索类型为销售状态时,选择(1:空闲,2:到期,3:正常,4:故障)其一传递
分页数量listpages否int每页显示的数据的数量
排序类型orderby否string用来排序的字段
排序规则sorting否string升序 asc 降序 desc
数据偏移量offset否int返回数据的偏移指针,与分页数量结合使用
服务器类型type否string搜索的服务器类型,(all:全部状态)
cpucpu否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
PCIpci否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时使用),PCI 数量
search为special时,pci数组和pci_num数组的值根据下标一一对应代表搜索x个a/c,y个b/d
IPip否string高级搜索参数(search 的值为 highgrade 时使用),IP 地址
IP 数量ip_num否int高级搜索参数(search 的值为 highgrade 时使用),IP 数量
电源状态power否array高级搜索参数(search 的值为 highgrade 时使用),电源状态(on:开机,off:关机,error:未知)
销售状态status否array高级搜索参数(search 的值为 highgrade 时使用),销售状态(1:空闲,2:到期,3:正常,4:故障)
销售类型sales是string搜索的销售类型(rent:租用,trust:托管)
内存容量ram_capacity否int特殊搜索参数(search 的值为 special 时使用),内存容量
过滤规则filter否int特殊搜索参数(search 的值为 special 时使用),0:一致,1:包含

返回参数

字段名变量名类型描述
服务器销售列表listingarray
id:服务器软件 ID
hid:服务器硬件 ID
wltag:物理标签
nbtag:内部标签
cpu:CPU 数组
ram:内存数组
disk:硬盘数组
pci:PCI 设备数组
time:上架时间
type:类型(1:租用,2:自用,5:托管,8:机柜客户)
power:电源状态
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
vlanport_mac:连接交换机端口 MAC 地址数组
mac_diff:MAC 地址是否与交换机端口记录不同
typename:硬件型号名称
pid:连接 PDU 设备 ID
pdu:连接 PDU 设备名称
pdu_num:连接 PDU 设备端口
showtype:PDU 端口显示类型
ipmi_support:是否支持 IPMI 控制
cname:所属机柜名称
house:机房 ID
house_name:机房名称
osname:操作系统
os_id:操作系统 ID
os_group_id:操作系统分组 ID
osusername:系统账号
ospassword:系统密码
sum:分配 IP 总数
ip:分配 IP 数组
productid:产品 ID
clientid:客户 ID
email:客户邮箱
token:密钥
根据查询条件查询到的所有服务器销售数据
服务器销售总数sumint系统内服务器销售数据的总数
分页数量listpagesint每页显示的数据的数量
搜索类型searchstring搜索类型
搜索内容keystring自定义的搜索内容
排序类型orderbystring用来排序的字段
排序规则sortingstring升序 asc 降序 desc
数据偏移量offsetint返回数据的偏移指针,与分页数量结合使用
服务器类型typestring搜索的服务器类型
提示信息msgstring出错提示信息
状态statusstringsuccess 成功 error 失败