# nginxWebUI

## 5. 额外参数接口

### 5.1. 根据项目获取参数列表

URL: /api/param/getList

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 根据项目获取参数列表

Query-parameters:

Parameter | Type | Description | Required | Since
--- | --- | --- | --- | ---
serverId | string | 所属反向代理id | false | -
locationId | string | 所属代理目标id | false | -
upstreamId | string | 所属负载均衡id | false | -

Request-example:

    curl -X GET -i /api/param/getList?locationId=&serverId=&upstreamId=

Response-fields:

Field | Type | Description | Since
--- | --- | --- | ---
success | boolean | 请求结果 | -
status | string | 请求状态 200:请求成功 401:token无效 500:服务器错误 | -
msg | string | 错误信息 | -
obj | array | 返回内容 | -
└─id | string | 主键 | -
└─serverId | string | 所属反向代理id | -
└─locationId | string | 所属代理目标id | -
└─upstreamId | string | 所属负载均衡id | -
└─name | string | 参数名 | -
└─value | string | 参数值 | -

Response-example:

    {
      "success": true,
      "status": "",
      "msg": "",
      "obj": [
        {
          "id": "",
          "serverId": "",
          "locationId": "",
          "upstreamId": "",
          "name": "",
          "value": ""
        }
      ]
    }

### 5.2. 添加或编辑参数

URL: /api/param/insertOrUpdate

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 添加或编辑参数

Query-parameters:

Parameter | Type | Description | Required | Since
--- | --- | --- | --- | ---
id | string | 主键 | false | -
serverId | string | 所属反向代理id | false | -
locationId | string | 所属代理目标id | false | -
upstreamId | string | 所属负载均衡id | false | -
name | string | 参数名 | false | -
value | string | 参数值 | false | -

Request-example:

    curl -X GET -i /api/param/insertOrUpdate?name=&serverId=&upstreamId=&value=&id=&locationId=

Response-fields:

Field | Type | Description | Since
--- | --- | --- | ---
success | boolean | 请求结果 | -
status | string | 请求状态 200:请求成功 401:token无效 500:服务器错误 | -
msg | string | 错误信息 | -
obj | object | 返回内容 | -

Response-example:

    {
      "success": true,
      "status": "",
      "msg": "",
      "obj": {}
    }

### 5.3. 删除额外参数

URL: /api/param/del

Type: GET

Content-Type: application/x-www-form-urlencoded;charset=UTF-8

Description: 删除额外参数

Query-parameters:

Parameter | Type | Description | Required | Since
--- | --- | --- | --- | ---
id | string | 参数id | false | -

Request-example:

    curl -X GET -i /api/param/del?id=

Response-fields:

Field | Type | Description | Since
--- | --- | --- | ---
success | boolean | 请求结果 | -
status | string | 请求状态 200:请求成功 401:token无效 500:服务器错误 | -
msg | string | 错误信息 | -
obj | object | 返回内容 | -

Response-example:

    {
      "success": true,
      "status": "",
      "msg": "",
      "obj": {}
    }