DICloak API-代理接口 - DICloak Help Center

一、代理接口

GET 获取代理列表

GET /v1/proxys

请求参数

名称	位置	类型	必选	说明
page_no	query	integer	否	页码，默认1
page_size	query	integer	否	分页大小，默认10
all	query	boolean	否	是否获取全量数据，当为true时，忽略pageNo和pageSize
detail	query	boolean	否	是否需要详情
serial_num	query	integer	否	序号
id	query	string	否	id
type	query	string	否	代理类型 (NON_USE:不使用 HTTP HTTPS SSH SOCKS5 IPFLY)
host	query	string	否	代理主机
env	query	string	否	使用环境
remark	query	string	否	备注

响应参数

名称	类型	说明
list	OpenApiProxyVO
total	integer

OpenApiProxyVO

名称	类型	说明
id	string	id
create_time	string	创建时间
update_time	string	修改时间
serial_num	integer	序号
type	string	代理类型 (NON_USE:不使用 HTTP HTTPS SSH SOCKS5 IPFLY)
host	string	代理主机
port	integer	代理端口
user_name	string	代理账号
passwd	string	代理密码
ip_type	string	IP查询渠道 (IP2LOCATION)
status	string	状态（WAIT待检测 SUCCESS成功 FAIL失败）
remark	string	备注
proxy_ip_info	CheckProxyIpResultVO	代理信息

CheckProxyIpResultVO

名称	类型	说明
ip	string	ip
connect	boolean	是否能够连接
country	string	国家
country_code	string	国家代码
region	string	地区（省份）
city	string	城市
timezone	string	时区
latitude	string	纬度
longitude	string	经度
zip_code	string	邮政编码
err_msg	string	错误信息
check_time	string	监测时间
ip_type	string	IP渠道类型

{
  "code": 0,
  "msg": "string",
  "data": {
    "list": [
      {
        "id": "string",
        "create_time": "string",
        "update_time": "string",
        "serial_num": 0,
        "type": "NON_USE",
        "host": "string",
        "port": 0,
        "user_name": "string",
        "passwd": "string",
        "ip_type": "IP2LOCATION",
        "status": "WAIT",
        "remark": "string",
        "proxy_ip_info": {
          "ip": "string",
          "connect": true,
          "country": "string",
          "country_code": "string",
          "region": "string",
          "city": "string",
          "timezone": "string",
          "latitude": "string",
          "longitude": "string",
          "zip_code": "string",
          "err_msg": "string",
          "check_time": "2019-08-24T14:15:22Z",
          "ip_type": "["
        }
      }
    ],
    "total": 0,
    "page_token": "string"
  }
}

GET 获取代理详情

GET /v1/proxy/{id}

请求参数

名称	位置	类型	必选	说明
id	path	string	是
X-API-KEY	header	string	是

返回结果

状态码	状态码含义	说明	数据模型
200	OK	OK	参考列表字段

{
  "code": 0,
  "msg": "string",
  "data": {
    "id": "string",
    "create_time": "string",
    "update_time": "string",
    "serial_num": 0,
    "type": "NON_USE",
    "host": "string",
    "port": 0,
    "user_name": "string",
    "passwd": "string",
    "ip_type": "IP2LOCATION",
    "status": "WAIT",
    "remark": "string",
    "proxy_ip_info": {
      "ip": "string",
      "connect": true,
      "country": "string",
      "country_code": "string",
      "region": "string",
      "city": "string",
      "timezone": "string",
      "latitude": "string",
      "longitude": "string",
      "zip_code": "string",
      "err_msg": "string",
      "check_time": "2019-08-24T14:15:22Z",
      "ip_type": "IP2LOCATION"
    }
  },
  "next": "string"
}

PUT 修改代理

PUT /v1/proxy/{id}

请求参数

名称	位置	类型	必选	说明
id	path	string	是
X-API-KEY	header	string	是
body	body	OpenProxyEditReq	否

{
  "type": "NON_USE",
  "host": "string",
  "port": 0,
  "user_name": "string",
  "passwd": "string",
  "ip_type": "IP2LOCATION",
  "status": "WAIT",
  "remark": "string",
  "out_ip": "string"
}

OpenProxyEditReq

名称	位置	类型	必选	说明
type	body	string	否	代理类型 (NON_USE:不使用 HTTP HTTPS SSH SOCKS5 IPFLY)
host	body	string	否	代理主机
port	body	integer	否	代理端口
user_name	body	string	否	代理账号
passwd	body	string	否	代理密码
ip_type	body	string	否	IP查询渠道 (IP2LOCATION)
status	body	string	否	状态（WAIT待检测 SUCCESS成功 FAIL失败）
remark	body	string	否	备注
out_ip	body	string	否	出口ip

返回结果

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

DELETE 删除代理

DELETE /v1/proxy/{id}

请求参数

名称	位置	类型	必选	说明
id	path	string	是	代理id,列表返回的id
X-API-KEY	header	string	是

返回结果

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

DICloak帮助中心