GET /api/http_proxies
HTTP 代理服务器列表

示例

GET /api/http_proxies
200
{
  "total": 0,
  "subtotal": 0,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": []
}

参数

参数名字 描述
location_id
选填

根据位置界定的范围

Validations:

  • Must be a Integer

organization_id
选填

根据机构界定的范围

Validations:

  • Must be a Integer

search
选填

过滤结果

Validations:

  • Must be a String

order
选填

排序项和顺序,例如 ‘id DESC’

Validations:

  • Must be a String

page
选填

页号,从 1 开始

Validations:

  • Must be a number.

per_page
选填

每页中显示的返回结果数

Validations:

  • Must be a number.


GET /api/http_proxies/:id
显示 HTTP 代理服务器

示例

GET /api/http_proxies/4
200
{
  "id": 4,
  "name": "http_proxies",
  "url": "http://url_18",
  "username": null
}

参数

参数名字 描述
location_id
选填

根据位置界定的范围

Validations:

  • Must be a Integer

organization_id
选填

根据机构界定的范围

Validations:

  • Must be a Integer

id
必填

数字 ID 或 HTTP 代理服务器名称

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


POST /api/http_proxies
创建 HTTP 代理服务器

示例

POST /api/http_proxies
{
  "http_proxy": {
    "name": "http_proxy_is_smart",
    "url": "http://what????:5000"
  }
}
201
{
  "id": 2,
  "name": "http_proxy_is_smart",
  "url": "http://what????:5000",
  "username": null,
  "password": null
}

参数

参数名字 描述
location_id
选填

根据位置界定的范围

Validations:

  • Must be a Integer

organization_id
选填

根据机构界定的范围

Validations:

  • Must be a Integer

http_proxy
必填

Validations:

  • Must be a Hash

http_proxy[name]
必填

HTTP 代理服务器名称

Validations:

  • Must be a String

http_proxy[url]
必填

HTTP 代理服务器的 URL

Validations:

  • Must be a String

http_proxy[username]
选填 , 允许空值

进行 HTTP 代理服务器验证时使用的用户名

Validations:

  • Must be a String

http_proxy[password]
选填 , 允许空值

进行 HTTP 代理服务器验证时使用的密码

Validations:

  • Must be a String

http_proxy[location_ids]
选填 , 允许空值

使用给定 id 替换位置

Validations:

  • Must be an array of any type

http_proxy[organization_ids]
选填 , 允许空值

使用给定 id 替换机构

Validations:

  • Must be an array of any type


PUT /api/http_proxies/:id
更新 HTTP 代理服务器

示例

PUT /api/http_proxies/1
{
  "http_proxy": {
    "url": "https://some_other_url"
  }
}
200
{
  "id": 1,
  "url": "https://some_other_url",
  "name": "http_proxies",
  "username": null,
  "password": null
}

参数

参数名字 描述
location_id
选填

根据位置界定的范围

Validations:

  • Must be a Integer

organization_id
选填

根据机构界定的范围

Validations:

  • Must be a Integer

id
必填

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.

http_proxy
必填

Validations:

  • Must be a Hash

http_proxy[name]
选填

HTTP 代理服务器名称

Validations:

  • Must be a String

http_proxy[url]
选填

HTTP 代理服务器的 URL

Validations:

  • Must be a String

http_proxy[username]
选填 , 允许空值

进行 HTTP 代理服务器验证时使用的用户名

Validations:

  • Must be a String

http_proxy[password]
选填 , 允许空值

进行 HTTP 代理服务器验证时使用的密码

Validations:

  • Must be a String

http_proxy[location_ids]
选填 , 允许空值

使用给定 id 替换位置

Validations:

  • Must be an array of any type

http_proxy[organization_ids]
选填 , 允许空值

使用给定 id 替换机构

Validations:

  • Must be an array of any type


DELETE /api/http_proxies/:id
删除 HTTP 代理服务器

示例

DELETE /api/http_proxies/3
{
  "http_proxy": {}
}
200
{
  "id": 3,
  "name": "http_proxies",
  "url": "http://url_17",
  "username": null,
  "password": null
}

参数

参数名字 描述
location_id
选填

根据位置界定的范围

Validations:

  • Must be a Integer

organization_id
选填

根据机构界定的范围

Validations:

  • Must be a Integer

id
必填

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.