接口地址:https://www.fwvps.com/query
本接口用于查询用户可用的代理IP资源列表。
该接口单个Key的请求频率限制为:(通道数*5+10)次/分钟;
方法:HTTP、GET,需要注意不能混合使用;
编码:参数和返回内容均采用utf-8编码。
参数名 | 是否必选 | 类型 | 描述 |
---|---|---|---|
Key | 是 | String | 查询的Key值 |
TaskID | 否 | String | 任务ID;多个以逗号分割;默认全部 |
Detail | 否 | Integer | 详情0(关闭) 1(开启),默认为0 |
接口可返回json格式,字段说明如下:
参数名 | 类型 | 描述 |
---|---|---|
Code | Integer | 结果编码:0(成功)-1(失败) |
TotalNum | Integer | 总IP数 |
TaskNum | Integer | 任务数 |
TaskList | Array | 任务列表 |
请求接口示例:
返回示例:
{
"Code ":0,
"TotalNum":5,
"TaskNum":5,
"TaskList ": [
{
"IP ": "127.0.0.1",
"port ": "49168",
"deadline ": "2018-05-11 02:56:02",
"host ": "127.0.0.1:49168",
}
]
}
错误码 | 描述 |
---|---|
-1 | 未知错误 |
-10 | 参数不合法 |
-11 | 请求过于频繁 |
-100 | 计划不存在或已过期 |
-101 | 请求数量超过计划通道数 |
-102 | 没有剩余的可用通道 |
1.请求结构:
服务地址:目前支持的域名列表为:
接口域名 | 域名 |
---|---|
请求域名 | www.fwvps.com |
2.公共参数
公共参数是用于标识用户和接口的参数,如非必要,在每个接口单独的接口文档中不再对这些参数进行说明,但每次请求均需要携带这些参数,才能正常发起请求。
参数名 | 是否必选 | 类型 | 描述 |
---|---|---|---|
Method | 是 | String | 具体操作的指令接口名称,例如想要调用查询代理IP列表接口,则Method参数即为query。 |
Key | 是 | String | 在 https://www.fwvps.com 上购买代理IP后得到的标识身份的密钥Key。 |
Num | 否 | Integer | 数量 |
KeepAlive | 否 | Integer | 生存周期(单位分钟) |
AreaId | 否 | Integer | 区域编号(参考区域编号数据表) |
detail | 否 | Integer | 是否查看详情(可查看到具体的省市县信息) |
IP | 否 | String | 节点IP,多个以逗号“,”分割,全部以”* “表示 |
Isp | 否 | String | 运营商,多个以逗号“,”分割,默认随机 1:电信,2:移动,3:联通,4:BGP |
TaskID | 否 | String | 任务ID,多个以逗号“,”分割,全部以”* “表示 |
假设用户想要查询已申请的代理IP列表(其中Method为query),则其请求链接的形式可能如下:
https://www.fwvps.comquery?Key=密钥
3.接口请求频率
接口频率限制时间均为一分钟内,从触发某个接口的时间开始计时的一分钟。具体详情如下:
接口类型 | 频率限制 |
---|---|
/allocate 申请 | 通道数*5+10 |
/release 释放 | 通道数*5 |
/query 查询 | 通道数*5+10 |
/whitelist/add 添加白名单 | 20 |
/whitelist/del 删除白名单 | 20 |
/whitelist/query 查询白名单 | 60 |
/info/quota 通道配额查询 | 60 |
/resources 资源查询 | 60 |
4.释放次数限制
套餐类型 | 释放次数限制说明 |
---|---|
动态独享 | 每分钟的释放限制次数为通道数*2 |
动态共享 | 不能自主释放,套餐时长到期后自动释放 |
静态独享 | 超过一天后能释放,一周不超过2次 |
动态独占 | 添加的资源要12小时后才能更换 |
5.通信协议
青果云代理IP-API的所有接口均支持HTTP、HTTPS进行通信,提供高安全性的通信通道。
6.请求方法
同时支持 POST 和 GET 请求,需要注意不能混合使用。即如果使用 GET 方式,则参数均从 Querystring 取得;如果使用 POST 方式,则参数均从 Request Body 中取得,Querystring 中的参数将忽略。两种方式参数格式规则相同,一般使用GET,当参数字符串过长时使用POST,请见各接口详细描述。
7.字符编码
均使用UTF-8编码。
接口地址: https://www.fwvps.com/allocate
本接口是用于请求申请代理IP资源的。
请求频率限制:按时业务是(通道数*5+10)次/分钟;按量业务则是60次/分钟;
方法:HTTP、GET,需要注意不能混合使用;
编码:参数和返回内容均采用utf-8编码。
参数名 | 是否必选 | 类型 | 描述 |
---|---|---|---|
Key | 是 | String | 申请的Key值 |
Num | 否 | Integer | 申请的数量;默认1个 |
KeepAlive | 否 | Integer | 生存周期;默认动态独享24小时,动态共享默认购买的套餐存活周期时长 |
AreaId | 否 | Integer | 区域ID;默认随机 |
ISP | 否 | Integer | 运营商ID;默认随机 |
Detail | 否 | Integer | 详情0(关闭) 1(开启) ,默认为 0 |
Distinct | 否 | Integer | 去重0(关闭) 1(开启) ,默认为 0 |
业务为按量动态共享时,参数“KeepAlive“、”Distinct”无须输入;
业务为按时动态共享、按时静态独享时,参数“KeepAlive“无须输入。
接口可返回文本格式、json格式、xml格式,字段说明如下:
参数名 | 类型 | 描述 |
---|---|---|
Code | Integer | 结果编码:0(成功)-1(失败) |
TaskID | Integer | 任务ID |
Num | Intger | 申请数量 |
Data | Array | 代理IP数据信息,包含节点IP、端口、失效日期 |
Msg | String | 区域ID,多个以逗号分割;*代表全部 |
请求接口示例:
返回示例:
{
"Code ":0,
"TaskID ":"91107E16D28AC5A",
"Num " : "1"
"Data": [
"IP ": "127.0.0.1",
"port ": "49168",
"deadline ": "2018-05-11 02:56:02",
"host ": "127.0.0.1:49168",
]
}
错误码 | 描述 |
---|---|
0 | 申请数量一次最多只能100个 |
-1 | 未知错误 |
-10 | 参数不合法 |
-11 | 请求过于频繁 |
-100 | 计划不存在或已过期 |
-101 | 请求数量超过计划通道数 |
-102 | 没有剩余的可用通道 |
-103 | 资源不足 |
-104 | 资源申请失败 |
-105 | 申请的IP数超过允许申请的IP数 |
接口地址:https://www.fwvps.com/extract
本接口用于获取IP资源池全部可用的IP信息,该接口仅按时动态共享业务可用。
该接口单个Key的请求频率限制为60次/分钟;
需要注意的是请求方方式只能用GET;
编码:参数和返回内容均采用utf-8编码。
参数名 | 是否必选 | 类型 | 描述 |
---|---|---|---|
Key | 是 | String | 申请的Key值 |
Num | 否 | Interger | 申请的数量;默认为1 |
AreaId | 否 | Integer | 区域ID;默认随机 |
ISP | 否 | Integer | 运营商ID;默认随机 |
Detail | 否 | Interger | 详情0(关闭) 1(开启) ,默认为 1 |
接口可返回文本格式、json格式、xml格式,字段说明如下:
类型 | 描述 |
---|---|
Integer | 结果编码:0(成功)-1(失败) |
Integer | 任务ID |
Intger | 申请数量 |
Array | 代理IP数据信息,包含节点IP、端口、失效日期 |
String | 区域ID |
请求接口示例:
返回示例:
{
"Code": 0,
"Data": [
{
"IP": "175.43.188.196",
"port": "64450",
"deadline": "2021-11-20 11:32:20",
"host": "175.43.188.196:64450",
"region": "福建省泉州市晋江市联通"
},
{
"IP": "114.238.148.203",
"port": "50938",
"deadline": "2021-11-20 11:32:20",
"host": "114.238.148.203:50938",
"region": "江苏省淮安市电信"
},
{
"IP": "117.92.121.222",
"port": "11136",
"deadline": "2021-11-20 11:32:20",
"host": "117.92.121.222:11136",
"region": "江苏省连云港市电信"
}
],
"Num": 3,
"TaskID": "mw13Wq0srzt9uLEt"
}
错误码 | 描述 |
---|---|
-1 | 未知错误 |
-10 | 参数不合法 |
-11 | 请求过于频繁 |
-100 | 计划不存在或已过期 |
-101 | 请求数量超过计划通道数 |
-102 | 没有剩余的可用通道 |
-103 | 资源不足 |
简要描述:
注:
参数:
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
productId | 是 | integer | 品牌编号 |
line_no | 否 | string | 线路编号 |
area_no | 否 | string | 可用区编号 |
load_rate | 否 | integer | 是否加载费率(星外格式) 1:是;0:否,默认值:0 |
输入示例
https://www.fwvps.com/api/cloud-product/packageList?productId=104
返回示例
JSON格式
{
"RequestId":'423369C7-AD6F-3GT6-NMJ7-E2RG5N6HG7D3',
"Code": 0,
"Message" : "返回内容"
"Data": {
"1":{
"Line_no":"ap-beijing",
"Area_id": 342,
"Area_no":"ap-beijing-1",
"Group_name":"标准型S1",
"Group_id":"S1",
"Area_name":"xxx",
"Line_name":"xxx",
"Spec_name":"标准型S1",
"Spec_no":"S1.SMALL2",
"Cpu" : "1",
"Memory": "2",
"Systemdisk":"40",
"Datadisk":"20",
"Bandwidth":"1",
"Ip":"1",
"Defense":"0",
"Trial_time":"",
"Buy_status":1,
"Status":1,
"Upgrade_status":"",
"Package_no": "1111",
"Basic_price": "2079.65",
"User_price": "2079.65",
"Day_rate": "0.01",
"Week_rate": "0.02",
"Month_rate": "0.1",
"Quarter_rate": "0.301",
"Halfyear_rate": "0.53",
"Year_rate": "1"
},
"2":{
"Line_no":"ap-beijing",
"Area_id": 343,
"Area_no":"ap-beijing-1",
"Group_name":"标准型S1",
"Group_id":"S1",
"Area_name":"xxx",
"Line_name":"xxx",
"Spec_name":"标准型S1",
"Spec_no":"S1.MEDIUM2",
"Cpu" : "2",
"Memory": "2",
"Systemdisk":"40",
"Datadisk":"20",
"Bandwidth":"1",
"Ip":"1",
"Defense":"0",
"Trial_time":"",
"Buy_status":1,
"Status":1,
"Upgrade_status":"",
"Package_no": "2222",
"Basic_price": "2079.65",
"User_price": "2079.65",
"Day_rate": "0.01",
"Week_rate": "0.02",
"Month_rate": "0.1",
"Quarter_rate": "0.301",
"Halfyear_rate": "0.53",
"Year_rate": "1"
}
}
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
RequestId | string | 请求编号 |
Code | integer | 状态码 |
Message | string | 返回内容 |
Line_no | string | 线路编号 |
Area_id | string | 可用区ID |
Area_no | string | 可用区编号 |
Group_name | string | 规格组名称 |
Group_id | string | 规格组编号 |
Spec_name | string | 规格名称 |
Area_name | string | 可用区名称 |
Line_name | string | 线路名称 |
Spec_no | string | 规格编号 |
Cpu | integer | cpu |
Memory | decimal | 内存 |
Systemdisk | integer | 系统盘,单位:G |
Datadisk | integer | 数据盘,单位:G |
Bandwidth | integer | 带宽,单位:M |
Ip | integer | ip数,单位:个 |
Defense | integer | 防御值,单位:G |
Trial_time | string | 试用时间 |
Buy_status | integer | 购买状态 1:开启 0:关闭 |
Upgrade_status | integer | 升级状态 1:开启 0:关闭 |
Status | integer | 规格状态 1:开启 0:关闭 |
package_no | string | 套餐编号 |
Basic_price | string | 基础价格 |
User_price | string | 会员价格 |
Day_rate | string | 日费率 |
Week_rate | string | 周费率 |
Month_rate | string | 月费率 |
Quarter_rate | string | 季度费率 |
Halfyear_rate | string | 半年费率 |
备注
欢迎使用ShowDoc!欢迎使用ShowDoc!
简要描述:
返回示例:
{
"RequestId": "wwwdaxxas",
"Code": 0,
"Message" : "返回内容"
}
返回参数说明
参数名 | 类型 | 说明 |
---|---|---|
200 | integer | 正确返回 |
1 | integer | 请求参数错误 |
2 | integer | 用户没有开通API权限 |
1000 | integer | 用户未经授权 |
1001 | integer | 服务器繁忙,通常是后台出错 |
1002 | integer | 用户没有登录状态 |
1003 | integer | 用户被锁定 |
1004 | integer | 用户余额不足 |
-4 | integer | 访问频率受限 |
-9 | integer | Api不存在 (错误的API名称) |
-5 | integer | 请求的内容不存在 |
公共请求参数:
公共参数:
名称 | 必选 | 类型 | 说明 |
---|---|---|---|
domain | 是 | string | 域名 |
appid | 是 | string | appid |
time | 是 | string | 时间戳 |
sign | 是 | string | 加密字段 |
公共返回参数
参数名 | 类型 | 说明 |
---|---|---|
RequestId | string | 请求编号 |
简要描述:
API支持基于URL发起HTTP/HTTPS GET请求。请求参数需要包含在URL中。本文列举了GET请求中的结构解释,并提供了服务器的服务接入地址
通信方式:
以下为Start一条未编码的URL请求示例:
http://www.fwvps.com/api/
&productId=117
&appid=*
&time=1585280982
&domain=www.fwvps.com
&sign=
https指定了请求通信协议。
qg.net指定了ECS的服务接入地址。
api类型根据API类型的不同,分为三大类,分别是operate(业务操作类,如开机,关机),product(产品操作类,如下单,续费,升级等等),business(产品信息类,如产品同步)
action指定了要调用的API
productId指的是产品ID
appid指的是用户在后台API信息申请的appid
time指的是用户请求API时的时间戳
domain指的是用户请求API的服务器域名
sign指的是根据appid,domain,time,以及appkey通过md5加密生成的一串秘钥
md5(appid + domain + time + appkey)
通信协议:
支持HTTP或HTTPS协议请求通信。为了获得更高的安全性,推荐您使用HTTPS协议发送请求
请求参数:
您需要通过Action参数指定目标操作,例如Action=Start。还需要指定接口的其他参数以及公共请求参数,详情请参见公共请求参数。
字符编码:
请求及返回结果都使用UTF-8字符集编码