网关实例组

CodeLong2025/7/10大约 12 分钟

网关实例组

POST 创建网关实例组

POST /gateway-group/create

创建网关实例组

Body 请求参数

{
  "id": 0,
  "groupName": "string",
  "groupKey": "string"
}

请求参数

名称	位置	类型	必选	说明
authorization	header	string	否	none
body	body	GroupSaveReqVO	否	none

返回示例

200 Response

{
  "code": 0,
  "msg": "",
  "data": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultLong

PUT 更新网关实例组

PUT /gateway-group/update

更新网关实例组

Body 请求参数

{
  "id": 0,
  "groupName": "string",
  "groupKey": "string"
}

请求参数

名称	位置	类型	必选	说明
authorization	header	string	否	none
body	body	GroupSaveReqVO	否	none

返回示例

200 Response

{
  "code": 0,
  "msg": "",
  "data": false
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultBoolean

DELETE 删除网关实例组

DELETE /gateway-group/delete

删除网关实例组

请求参数

名称	位置	类型	必选	说明
id	query	integer	是	none
authorization	header	string	否	none

返回示例

200 Response

{
  "code": 0,
  "msg": "",
  "data": false
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultBoolean

GET 查询网关实例组

GET /gateway-group/get

查询网关实例组

请求参数

名称	位置	类型	必选	说明
id	query	integer	是	none
authorization	header	string	否	none

返回示例

200 Response

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "groupName": "",
    "groupKey": "",
    "createTime": "",
    "updateTime": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultGatewayGroupDO

GET 分页查询网关实例组

GET /gateway-group/page

分页查询网关实例组

请求参数

名称	位置	类型	必选	说明
pageNo	query	integer	否	none
pageSize	query	integer	否	none
name	query	string	否	网关实例组名称
authorization	header	string	否	none

返回示例

200 Response

{
  "code": 0,
  "msg": "",
  "data": {
    "list": [
      {
        "id": 0,
        "groupName": "",
        "groupKey": ""
      }
    ],
    "total": 0
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultPageResultGroupSaveReqVO

网关实例组详情

POST 创建网关实例组详情

POST /gateway-group-detail/create

创建网关实例组详情

Body 请求参数

{
  "id": 0,
  "groupKey": "string",
  "name": "string",
  "address": "string",
  "status": 0,
  "weight": 0
}

请求参数

名称	位置	类型	必选	说明
authorization	header	string	否	none
body	body	GroupDetailSaveReqVO	否	none

返回示例

200 Response

{
  "code": 0,
  "msg": "",
  "data": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultLong

PUT 更新网关实例组详情

PUT /gateway-group-detail/update

更新网关实例组详情

Body 请求参数

{
  "id": 0,
  "groupKey": "string",
  "name": "string",
  "address": "string",
  "status": 0,
  "weight": 0
}

请求参数

名称	位置	类型	必选	说明
authorization	header	string	否	none
body	body	GroupDetailSaveReqVO	否	none

返回示例

200 Response

{
  "code": 0,
  "msg": "",
  "data": false
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultBoolean

DELETE 删除网关实例组详情

DELETE /gateway-group-detail/delete

删除网关实例组详情

请求参数

名称	位置	类型	必选	说明
id	query	integer	是	none
authorization	header	string	否	none

返回示例

200 Response

{
  "code": 0,
  "msg": "",
  "data": false
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultBoolean

GET 查询网关实例组详情

GET /gateway-group-detail/get

查询网关实例组详情

请求参数

名称	位置	类型	必选	说明
id	query	integer	是	none
authorization	header	string	否	none

返回示例

200 Response

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "groupKey": "",
    "name": "",
    "address": "",
    "status": 0,
    "weight": 0
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultGroupDetailSaveReqVO

GET 分页查询网关实例组详情

GET /gateway-group-detail/page

分页查询网关实例组详情

请求参数

名称	位置	类型	必选	说明
pageNo	query	integer	否	none
pageSize	query	integer	否	none
groupName	query	string	否	网关实例组名称
detailName	query	string	否	网关实例名称
status	query	integer	否	网关实例状态
address	query	string	否	网关实例地址
authorization	header	string	否	none

返回示例

200 Response

{
  "code": 0,
  "msg": "",
  "data": {
    "list": [
      {
        "id": 0,
        "groupKey": "",
        "name": "",
        "address": "",
        "status": 0,
        "weight": 0
      }
    ],
    "total": 0
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultPageResultGroupDetailSaveReqVO

PUT 更新网关实例组详情状态

PUT /gateway-group-detail/update/status

更新网关实例组详情状态

请求参数

名称	位置	类型	必选	说明
id	query	integer	是	none
authorization	header	string	否	none

返回示例

200 Response

{
  "code": 0,
  "msg": "",
  "data": false
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultBoolean

网关服务

POST 创建网关服务

POST /gateway-server/create

Body 请求参数

{
  "id": 0,
  "serverName": "string",
  "status": 0,
  "safeKey": "string",
  "safeSecret": "string",
  "nginxAddr": "string"
}

请求参数

名称	位置	类型	必选	说明
authorization	header	string	否	none
body	body	ServerSaveReqVO	否	none

返回示例

200 Response

{
  "code": 0,
  "msg": "",
  "data": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultLong

PUT 更新网关服务

PUT /gateway-server/update

Body 请求参数

{
  "id": 0,
  "serverName": "string",
  "status": 0,
  "safeKey": "string",
  "safeSecret": "string",
  "nginxAddr": "string"
}

请求参数

名称	位置	类型	必选	说明
authorization	header	string	否	none
body	body	ServerSaveReqVO	否	none

返回示例

200 Response

{
  "code": 0,
  "msg": "",
  "data": false
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultBoolean

DELETE 删除网关服务

DELETE /gateway-server/delete

请求参数

名称	位置	类型	必选	说明
id	query	integer	是	none
authorization	header	string	否	none

返回示例

200 Response

{
  "code": 0,
  "msg": "",
  "data": false
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultBoolean

PUT 更新网关服务状态

PUT /gateway-server/update/status

请求参数

名称	位置	类型	必选	说明
id	query	integer	是	none
authorization	header	string	否	none

返回示例

200 Response

{
  "code": 0,
  "msg": "",
  "data": false
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultBoolean

GET 查询网关服务

GET /gateway-server/get

请求参数

名称	位置	类型	必选	说明
id	query	integer	是	none
authorization	header	string	否	none

返回示例

200 Response

{
  "code": 0,
  "msg": "",
  "data": {
    "id": 0,
    "serverName": "",
    "status": 0,
    "safeKey": "",
    "safeSecret": "",
    "nginxAddr": ""
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultServerSaveReqVO

GET 分页查询网关服务

GET /gateway-server/page

请求参数

名称	位置	类型	必选	说明
pageNo	query	integer	否	none
pageSize	query	integer	否	none
serverName	query	string	否	网关服务名称
status	query	integer	否	网关服务状态
nginxAddr	query	string	否	网关服务地址
authorization	header	string	否	none

返回示例

200 Response

{
  "code": 0,
  "msg": "",
  "data": {
    "list": [
      {
        "id": 0,
        "serverName": "",
        "status": 0,
        "safeKey": "",
        "safeSecret": "",
        "nginxAddr": "",
        "createTime": "",
        "updateTime": ""
      }
    ],
    "total": 0
  }
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultPageResultGatewayServerDO

网关服务详情

POST 服务详情注册

POST /gateway-server-detail/register

服务详情注册

Body 请求参数

{
  "serverId": 0,
  "serverAddress": "string"
}

请求参数

名称	位置	类型	必选	说明
authorization	header	string	否	none
body	body	ServerDetailRegisterReqVO	否	none

返回示例

200 Response

{
  "code": 0,
  "msg": "",
  "data": false
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultBoolean

PUT 服务下线

PUT /gateway-server-detail/offline

服务下线

请求参数

名称	位置	类型	必选	说明
id	query	integer	是	none
authorization	header	string	否	none

返回示例

200 Response

{
  "code": 0,
  "msg": "",
  "data": false
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultBoolean

网关服务实例组关联

POST 网关服务关联创建

POST /gateway-server-group-rel/create

网关服务关联创建

Body 请求参数

{
  "serverId": 0,
  "groupId": 0
}

请求参数

名称	位置	类型	必选	说明
authorization	header	string	否	none
body	body	ServerGroupRelSaveReqVO	否	none

返回示例

200 Response

{
  "code": 0,
  "msg": "",
  "data": 0
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultLong

DELETE 网关服务关联删除

DELETE /gateway-server-group-rel/delete

网关服务关联删除

请求参数

名称	位置	类型	必选	说明
id	query	integer	否	none
authorization	header	string	否	none

返回示例

200 Response

{
  "code": 0,
  "msg": "",
  "data": false
}

返回结果

状态码	状态码含义	说明	数据模型
200	OK	none	ResultBoolean

数据模型

GroupSaveReqVO

{
  "id": 0,
  "groupName": "string",
  "groupKey": "string"
}

属性

名称	类型	必选	约束	说明
id	integer(int64)	false	none	网关实例组id
groupName	string	false	none	网关实例组名称
groupKey	string	false	none	网关实例组唯一key

ServerSaveReqVO

{
  "id": 0,
  "serverName": "string",
  "status": 0,
  "safeKey": "string",
  "safeSecret": "string",
  "nginxAddr": "string"
}

属性

名称	类型	必选	约束	说明
id	integer(int64)	false	none	服务id
serverName	string	false	none	服务名称
status	integer	false	none	状态
safeKey	string	false	none	安全key
safeSecret	string	false	none	安全密钥
nginxAddr	string	false	none	nginx地址

ServerDetailRegisterReqVO

{
  "serverId": 0,
  "serverAddress": "string"
}

属性

名称	类型	必选	约束	中文名	说明
serverId	integer(int64)	false	none		服务id
serverAddress	string	false	none		服务地址

ResultBoolean

{
  "code": 0,
  "msg": "string",
  "data": true
}

属性

名称	类型	必选	约束	说明
code	integer	false	none	编码：1成功，0和其它数字为失败
msg	string	false	none	错误信息
data	boolean	false	none	数据

GatewayGroupDO

{
  "id": 0,
  "groupName": "string",
  "groupKey": "string",
  "createTime": "string",
  "updateTime": "string"
}

属性

名称	类型	必选	约束	说明
id	integer(int64)	false	none	唯一标识id
groupName	string	false	none	分组名称
groupKey	string	false	none	分组唯一标识
createTime	string	false	none	创建时间
updateTime	string	false	none	更新时间

ResultServerSaveReqVO

{
  "code": 0,
  "msg": "string",
  "data": {
    "id": 0,
    "serverName": "string",
    "status": 0,
    "safeKey": "string",
    "safeSecret": "string",
    "nginxAddr": "string"
  }
}

属性

名称	类型	必选	约束	说明
code	integer	false	none	编码：1成功，0和其它数字为失败
msg	string	false	none	错误信息
data	ServerSaveReqVO	false	none	数据

ResultGatewayGroupDO

{
  "code": 0,
  "msg": "string",
  "data": {
    "id": 0,
    "groupName": "string",
    "groupKey": "string",
    "createTime": "string",
    "updateTime": "string"
  }
}

属性

名称	类型	必选	约束	说明
code	integer	false	none	编码：1成功，0和其它数字为失败
msg	string	false	none	错误信息
data	GatewayGroupDO	false	none	数据

ResultLong

{
  "code": 0,
  "msg": "string",
  "data": 0
}

属性

名称	类型	必选	约束	说明
code	integer	false	none	编码：1成功，0和其它数字为失败
msg	string	false	none	错误信息
data	integer(int64)	false	none	数据

GatewayServerDO

{
  "id": 0,
  "serverName": "string",
  "status": 0,
  "safeKey": "string",
  "safeSecret": "string",
  "nginxAddr": "string",
  "createTime": "string",
  "updateTime": "string"
}

属性

名称	类型	必选	约束	说明
id	integer(int64)	false	none	唯一id
serverName	string	false	none	服务名
status	integer	false	none	启用状态
safeKey	string	false	none	安全组唯一标识
safeSecret	string	false	none	安全组秘钥
nginxAddr	string	false	none	NGINX地址
createTime	string	false	none	创建时间
updateTime	string	false	none	更新时间

PageResultGroupSaveReqVO

{
  "list": [
    {
      "id": 0,
      "groupName": "string",
      "groupKey": "string"
    }
  ],
  "total": 0
}

属性

名称	类型	必选	约束	中文名	说明
list	[GroupSaveReqVO]	false	none		none
total	integer(int64)	false	none		none

PageResultGatewayServerDO

{
  "list": [
    {
      "id": 0,
      "serverName": "string",
      "status": 0,
      "safeKey": "string",
      "safeSecret": "string",
      "nginxAddr": "string",
      "createTime": "string",
      "updateTime": "string"
    }
  ],
  "total": 0
}

属性

名称	类型	必选	约束	中文名	说明
list	[GatewayServerDO]	false	none		none
total	integer(int64)	false	none		none

ResultPageResultGroupSaveReqVO

{
  "code": 0,
  "msg": "string",
  "data": {
    "list": [
      {
        "id": 0,
        "groupName": "string",
        "groupKey": "string"
      }
    ],
    "total": 0
  }
}

属性

名称	类型	必选	约束	说明
code	integer	false	none	编码：1成功，0和其它数字为失败
msg	string	false	none	错误信息
data	PageResultGroupSaveReqVO	false	none	数据

ResultPageResultGatewayServerDO

{
  "code": 0,
  "msg": "string",
  "data": {
    "list": [
      {
        "id": 0,
        "serverName": "string",
        "status": 0,
        "safeKey": "string",
        "safeSecret": "string",
        "nginxAddr": "string",
        "createTime": "string",
        "updateTime": "string"
      }
    ],
    "total": 0
  }
}

属性

名称	类型	必选	约束	说明
code	integer	false	none	编码：1成功，0和其它数字为失败
msg	string	false	none	错误信息
data	PageResultGatewayServerDO	false	none	数据

GroupDetailSaveReqVO

{
  "id": 0,
  "groupKey": "string",
  "name": "string",
  "address": "string",
  "status": 0,
  "weight": 0
}

属性

名称	类型	必选	约束	说明
id	integer(int64)	false	none	网关实例组详情id
groupKey	string	false	none	网关实例组key
name	string	false	none	网关实例详情名称
address	string	false	none	网关实例详情地址
status	integer	false	none	网关实例详情状态
weight	integer	false	none	网关实例详情权重

ResultGroupDetailSaveReqVO

{
  "code": 0,
  "msg": "string",
  "data": {
    "id": 0,
    "groupKey": "string",
    "name": "string",
    "address": "string",
    "status": 0,
    "weight": 0
  }
}

属性

名称	类型	必选	约束	说明
code	integer	false	none	编码：1成功，0和其它数字为失败
msg	string	false	none	错误信息
data	GroupDetailSaveReqVO	false	none	数据

PageResultGroupDetailSaveReqVO

{
  "list": [
    {
      "id": 0,
      "groupKey": "string",
      "name": "string",
      "address": "string",
      "status": 0,
      "weight": 0
    }
  ],
  "total": 0
}

属性

名称	类型	必选	约束	中文名	说明
list	[GroupDetailSaveReqVO]	false	none		none
total	integer(int64)	false	none		none

ResultPageResultGroupDetailSaveReqVO

{
  "code": 0,
  "msg": "string",
  "data": {
    "list": [
      {
        "id": 0,
        "groupKey": "string",
        "name": "string",
        "address": "string",
        "status": 0,
        "weight": 0
      }
    ],
    "total": 0
  }
}

属性

名称	类型	必选	约束	说明
code	integer	false	none	编码：1成功，0和其它数字为失败
msg	string	false	none	错误信息
data	PageResultGroupDetailSaveReqVO	false	none	数据

ServerGroupRelSaveReqVO

{
  "serverId": 0,
  "groupId": 0
}

属性

名称	类型	必选	约束	中文名	说明
serverId	integer(int64)	false	none		网关服务id
groupId	integer(int64)	false	none		网关分组id