PUT 保存前台导航
接口概览
| 项目 | 内容 |
|---|---|
| 文档类型 | 后台接口 |
| 请求方式 | PUT |
| 接口地址 | /DIR_ADMIN/v1/menu/home |
| 所属业务 | 站点内容 |
| 来源模块/系统 | 导航管理 |
| 认证方式 | Bearer Token(管理员令牌) |
完整请求
请求
正在加载示例…失败请求
正在加载示例…接口说明
保存前台导航
请求体
正在加载示例…请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| body | body | object | 是 | — |
menu | body | [object] | 是 | 菜单 |
menu.type | body | string | 是 | 菜单类型 system系统 plugin插件 custom自定义 module产品列表 embedded内嵌 |
menu.name | body | string | 是 | 名称 |
menu.language | body | object | 是 | 语言 |
menu.url | body | string | 否 | 网址 菜单类型为自定义时需要传递 |
menu.second_reminder | body | integer(int32) | 否 | 二次提醒 0否 1是 菜单类型为自定义时需要传递 |
menu.icon | body | string | 否 | 图标 |
menu.nav_id | body | integer(int32) | 否 | 导航ID 菜单类型为系统或插件时需要传递 |
menu.module | body | [string] | 否 | 模块类型 菜单类型为产品列表时可以传递 |
menu.res_module | body | [string] | 否 | res模块类型 菜单类型为产品列表时可以传递 云 whmcs_cloud mf_cloud mf_finance DCIM whmcs_dcim mf_dcim mf_finance_dcim 可以多选 |
menu.product_id | body | [integer] | 否 | 商品ID 菜单类型为产品列表时需要传递 |
menu.is_cross_module | body | integer(int32) | 否 | 是否为跨模块列表 菜单类型为产品列表时可以传递 |
menu.select_field | body | [string] | 否 | 选择字段 area=区域 product_name=商品名称 billing_cycle=计费方式 is_auto_renew=自动续费 base_info=基础信息 ip=IP os=OS active_time=开通时间 due_time=到期时间 status=状态 notes=备注 菜单类型为产品列表时可以传递 |
menu.child | body | [object] | 是 | 子菜单 |
menu.child.type | body | string | 是 | 菜单类型 system系统 plugin插件 custom自定义 module产品列表 embedded内嵌 |
menu.child.name | body | string | 是 | 名称 |
menu.child.language | body | object | 是 | 语言 |
menu.child.url | body | string | 否 | 网址 菜单类型为自定义时需要传递 |
menu.child.second_reminder | body | integer(int32) | 否 | 二次提醒 0否 1是 菜单类型为自定义时需要传递 |
menu.child.icon | body | string | 否 | 图标 |
menu.child.nav_id | body | integer(int32) | 否 | 导航ID 菜单类型为系统或插件时需要传递 |
menu.child.module | body | [string] | 否 | 模块类型 菜单类型为产品列表时可以传递 |
menu.child.res_module | body | [string] | 否 | res模块类型 菜单类型为产品列表时可以传递 |
menu.child.product_id | body | [integer] | 否 | 商品ID 菜单类型为产品列表时需要传递 |
menu.child.is_cross_module | body | integer(int32) | 否 | 是否为跨模块列表 菜单类型为产品列表时可以传递 |
menu.child.select_field | body | [string] | 否 | 选择字段 area=区域 product_name=商品名称 billing_cycle=计费方式 is_auto_renew=自动续费 base_info=基础信息 ip=IP os=OS active_time=开通时间 due_time=到期时间 status=状态 notes=备注 菜单类型为产品列表时可以传递 |
成功响应
正在加载示例…失败响应 400:请求参数或业务校验失败
正在加载示例…失败响应 401:未认证或登录已失效
正在加载示例…失败响应 403:无权执行当前操作
正在加载示例…失败响应 404:接口或业务资源不存在
正在加载示例…失败响应 500:服务器内部错误
正在加载示例…响应状态
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功响应 | 内联对象 |
| 400 | Bad Request | 请求参数或业务校验失败 | 内联对象 |
| 401 | Unauthorized | 未认证或登录已失效 | 内联对象 |
| 403 | Forbidden | 无权执行当前操作 | 内联对象 |
| 404 | Not Found | 接口或业务资源不存在 | 内联对象 |
| 500 | Internal Server Error | 服务器内部错误 | 内联对象 |
响应参数
状态码 200
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
status | integer(int32) | 否 | — | 状态码 |
msg | string | 否 | — | 提示信息 |
data | object | 否 | — | 源码未声明稳定业务字段 |
失败状态码 400、401、403、404、500 共用以下结构:
| 名称 | 类型 | 必选 | 约束 | 说明 |
|---|---|---|---|---|
status | integer(int32) | 是 | — | 错误状态码 |
msg | string | 是 | — | 错误提示 |