# nginxWebUI

## 1. 基础参数接口

### 1.1. 获取Http参数

URL: /api/basic/getHttp

Type: GET

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

Description: 获取Http参数

Request-example:

    curl -X GET -i /api/basic/getHttp

Response-fields:

Field | Type | Description | Since
--- | --- | --- | ---
success | boolean | 请求结果 | -
status | string | 请求状态 200:请求成功 401:token无效 500:服务器错误 | -
msg | string | 错误信息 | -
obj | array | 返回内容 | -
└─id | string | 主键 | -
└─name | string | 参数名 | -
└─value | string | 参数值 | -
└─unit | string | 参数单位 | -
└─enable | boolean | 是否启用 true:启用(默认) false:禁用 | -

Response-example:

    {
      "success": true,
      "status": "",
      "msg": "",
      "obj": [
        {
          "id": "",
          "name": "",
          "value": "",
          "unit": "",
          "enable": true
        }
      ]
    }

### 1.2. 添加或编辑Http参数

URL: /api/basic/insertOrUpdateHttp

Type: GET

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

Description: 添加或编辑Http参数

Query-parameters:

Parameter | Type | Description | Required | Since
--- | --- | --- | --- | ---
id | string | 主键 | false | -
name | string | 参数名 | false | -
value | string | 参数值 | false | -
unit | string | 参数单位 | false | -
enable | boolean | 是否启用 true:启用(默认) false:禁用 | false | -

Request-example:

    curl -X GET -i /api/basic/insertOrUpdateHttp?enable=true&id=&unit=&name=&value=

Response-fields:

Field | Type | Description | Since
--- | --- | --- | ---
success | boolean | 请求结果 | -
status | string | 请求状态 200:请求成功 401:token无效 500:服务器错误 | -
msg | string | 错误信息 | -
obj | object | 返回内容 | -
└─id | string | 主键 | -
└─name | string | 参数名 | -
└─value | string | 参数值 | -
└─unit | string | 参数单位 | -
└─enable | boolean | 是否启用 true:启用(默认) false:禁用 | -

Response-example:

    {
      "success": true,
      "status": "",
      "msg": "",
      "obj": {
        "id": "",
        "name": "",
        "value": "",
        "unit": "",
        "enable": true
      }
    }

### 1.3. 删除Http参数

URL: /api/basic/delHttp

Type: GET

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

Description: 删除Http参数

Query-parameters:

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

Request-example:

    curl -X GET -i /api/basic/delHttp?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": {}
    }

### 1.4. 获取基础参数

URL: /api/basic/getBasic

Type: GET

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

Description: 获取基础参数

Request-example:

    curl -X GET -i /api/basic/getBasic

Response-fields:

Field | Type | Description | Since
--- | --- | --- | ---
success | boolean | 请求结果 | -
status | string | 请求状态 200:请求成功 401:token无效 500:服务器错误 | -
msg | string | 错误信息 | -
obj | array | 返回内容 | -
└─id | string | 主键 | -
└─name | string | 参数名 | -
└─value | string | 参数值 | -

Response-example:

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

### 1.5. 添加或编辑基础参数

URL: /api/basic/insertOrUpdateBasic

Type: GET

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

Description: 添加或编辑基础参数

Query-parameters:

Parameter | Type | Description | Required | Since
--- | --- | --- | --- | ---
id | string | 主键 | false | -
name | string | 参数名 | false | -
value | string | 参数值 | false | -

Request-example:

    curl -X GET -i /api/basic/insertOrUpdateBasic?id=&name=&value=

Response-fields:

Field | Type | Description | Since
--- | --- | --- | ---
success | boolean | 请求结果 | -
status | string | 请求状态 200:请求成功 401:token无效 500:服务器错误 | -
msg | string | 错误信息 | -
obj | object | 返回内容 | -
└─id | string | 主键 | -
└─name | string | 参数名 | -
└─value | string | 参数值 | -

Response-example:

    {
      "success": true,
      "status": "",
      "msg": "",
      "obj": {
        "id": "",
        "name": "",
        "value": ""
      }
    }

### 1.6. 删除基础参数

URL: /api/basic/delBasic

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/basic/delBasic?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": {}
    }

### 1.7. 获取Stream参数

URL: /api/basic/getStream

Type: GET

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

Description: 获取Stream参数

Request-example:

    curl -X GET -i /api/basic/getStream

Response-fields:

Field | Type | Description | Since
--- | --- | --- | ---
success | boolean | 请求结果 | -
status | string | 请求状态 200:请求成功 401:token无效 500:服务器错误 | -
msg | string | 错误信息 | -
obj | array | 返回内容 | -
└─id | string | 主键 | -
└─name | string | 参数名 | -
└─value | string | 参数值 | -

Response-example:

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

### 1.8. 添加或编辑Stream参数

URL: /api/basic/insertOrUpdateStream

Type: GET

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

Description: 添加或编辑Stream参数

Query-parameters:

Parameter | Type | Description | Required | Since
--- | --- | --- | --- | ---
id | string | 主键 | false | -
name | string | 参数名 | false | -
value | string | 参数值 | false | -

Request-example:

    curl -X GET -i /api/basic/insertOrUpdateStream?value=&name=&id=

Response-fields:

Field | Type | Description | Since
--- | --- | --- | ---
success | boolean | 请求结果 | -
status | string | 请求状态 200:请求成功 401:token无效 500:服务器错误 | -
msg | string | 错误信息 | -
obj | object | 返回内容 | -
└─id | string | 主键 | -
└─name | string | 参数名 | -
└─value | string | 参数值 | -

Response-example:

    {
      "success": true,
      "status": "",
      "msg": "",
      "obj": {
        "id": "",
        "name": "",
        "value": ""
      }
    }

### 1.9. 删除Stream参数

URL: /api/basic/delStream

Type: GET

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

Description: 删除Stream参数

Query-parameters:

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

Request-example:

    curl -X GET -i /api/basic/delStream?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": {}
    }