前台产品列表页(云/DCIM)
方法概览
| 项目 | 内容 |
|---|---|
| 文档类型 | PHP 类方法 |
| 方法标识 | app\common\model\HostModel::homeHostList |
| 所属业务 | 产品管理 |
| 来源模块/系统 | 产品模型 |
功能说明
前台产品列表页(云/DCIM)
调用示例
$param = ['page' => 1, 'limit' => 1, 'orderby' => 'id', 'sort' => 'string', 'keywords' => '示例关键字', 'country_id' => 1, 'city' => 'string', 'area' => 'string', 'status' => 'Active', 'tab' => 'string', 'same_type_host_id' => 1];
$result = (new \app\common\model\HostModel())->homeHostList($param);参数
| 参数 | 类型 | 必填 | 默认值 | 校验规则 | 说明 |
|---|---|---|---|---|---|
param.page | int | 否 | 1 | — | 页数 |
param.limit | int | 否 | — | — | 每页条数 |
param.orderby | string | 否 | — | — | 排序(id,due_time,status) |
param.sort | string | 否 | — | — | 升/降序 |
param.keywords | string | 否 | — | — | 关键字搜索:商品名称/产品名称/IP |
param.country_id | int | 否 | — | — | 搜索:国家ID |
param.city | string | 否 | — | — | 搜索:城市 |
param.area | string | 否 | — | — | 搜索:区域 |
param.status | string | 否 | — | — | 产品状态(Unpaid=未付款,Pending=开通中,Active=已开通,Suspended=已暂停,Deleted=已删除) |
param.tab | string | 否 | — | — | 状态using使用中expiring即将到期overdue已逾期deleted已删除 |
param.same_type_host_id | int | 否 | — | — | 同类产品搜索:传入产品ID,若为下游则只返回同代理商下游产品,若为本地则只返回本地产品 |
返回值
| 返回项 | 类型 | 说明 |
|---|---|---|
data.list | array | 列表数据 |
data.list[].id | int | 产品ID |
data.list[].product_id | int | 商品ID |
data.list[].name | string | 产品标识 |
data.list[].status | string | 产品状态(Unpaid=未付款,Pending=开通中,Active=已开通,Suspended=已暂停,Deleted=已删除) |
data.list[].active_time | int | 开通时间 |
data.list[].due_time | int | 到期时间 |
data.list[].client_notes | string | 用户备注 |
data.list[].product_name | string | 商品名称 |
data.list[].country | string | 国家 |
data.list[].country_code | string | 国家代码 |
data.list[].country_id | int | 国家ID |
data.list[].city | string | 城市 |
data.list[].area | string | 区域 |
data.list[].power_status | string | 电源状态(on=开机,off=关机,operating=操作中,fault=故障) |
data.list[].image_name | string | 镜像名称 |
data.list[].image_icon | string | 镜像图标(Windows,CentOS,Ubuntu,Debian,ESXi,XenServer,FreeBSD,Fedora,ArchLinux,Rocky,AlmaLinux,OpenEuler,RedHat,其他) |
data.list[].ip_num | int | IP数量 |
data.list[].dedicate_ip | string | 主IP |
data.list[].assign_ip | string | 附加IP(英文逗号分隔) |
data.list[].base_info | string | 产品基础信息 |
data.list[].self_defined_field | `array | object` |
data.list[].show_base_info | int | 产品列表是否展示基础信息:1是默认,0否 |
data.list[].is_auto_renew | int | 是否自动续费(0=否,1=是) |
data.list[].billing_cycle | int | 计费方式(free=免费,onetime=一次性,recurring_prepayment=周期先付,on_demand=按需) |
data.count | int | 总条数 |
data.using_count | int | 使用中产品数量 |
data.expiring_count | int | 即将到期产品数量 |
data.overdue_count | int | 已逾期产品数量 |
data.deleted_count | int | 已删除产品数量 |
data.all_count | int | 全部产品数量 |
data.data_center[].country_id | int | 国家ID |
data.data_center[].city | string | 城市 |
data.data_center[].area | string | 区域 |
data.data_center[].country_name | string | 国家 |
data.data_center[].country_code | string | 国家代码 |
data.data_center[].customfield.multi_language.city | string | 区域多语言 |
data.self_defined_field[].id | int | 自定义字段ID |
data.self_defined_field[].field_name | string | 自定义字段名称 |
data.self_defined_field[].field_type | string | 字段类型(text=文本框,link=链接,password=密码,dropdown=下拉,tickbox=勾选框,textarea=文本区) |
正常返回
{
"data": {
"list": [
{
"id": 1,
"product_id": 1,
"name": "示例名称",
"status": "Active",
"active_time": 1752984000,
"due_time": 1752984000,
"client_notes": "示例说明",
"product_name": "示例名称",
"country": "string",
"country_code": "123456",
"country_id": 1,
"city": "string",
"area": "string",
"power_status": "Active",
"image_name": "示例名称",
"image_icon": "string",
"ip_num": 1,
"dedicate_ip": "192.0.2.1",
"assign_ip": "example-token",
"base_info": "string",
"self_defined_field": [
"string"
],
"show_base_info": 1,
"is_auto_renew": 1,
"billing_cycle": 1
}
],
"count": 1,
"using_count": 1,
"expiring_count": 1,
"overdue_count": 1,
"deleted_count": 1,
"all_count": 1,
"data_center": [
{
"country_id": 1,
"city": "string",
"area": "string",
"country_name": "中国",
"country_code": "123456",
"customfield": {
"multi_language": {
"city": "zh-cn"
}
}
}
],
"self_defined_field": [
{
"id": 1,
"field_name": "示例名称",
"field_type": "string"
}
]
}
}异常情况
| 异常类型 | 说明 |
|---|---|
Throwable | 调用失败时由具体实现抛出异常,异常信息以运行时结果为准。 |