按时业务购买
**简要描述:**
- 业务购买
**输入参数:**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|spec_id |是 |integer |按时产品ID |
|number |否 |integer | 通道数,IP类型为静态、动态和隧道固定时长时必传;IP类型为隧道每次请求换ip时不需要传 |
|connect |否 |integer | 连接数,IP类型为隧道每次请求换ip时必传;其他类型不需要传 |
|duration |是 |string | 购买时长 单位:
- s: 小时,免费使用时长 例:2s(2小时)
- d: 天 例:1d(1天)
- w: 周 例:1w(1周)
- m: 月 例:1m(1个月)
|
**输入示例:**
- https://qg.net/api/Proxyip/pay?spec_id=888&number=1&duration=1d
**返回示例**
JSON格式
```
{
"RequestId":'423369C7-AD6F-3GT6-NMJ7-E2RG5N6HG7D3',
"Code": 200,
"Message": "购买成功",
"Data": {
"AuthKey": "17710BD8",
"AuthPwd": "8560577FC33A",
"Suid": "hryp84er",
"Tunnel_url" : "tunnel.qg.net:3434"
},
}
```
**返回参数说明**
|参数名|类型|说明|
|:----- |:-----|----- |
|RequestId |string |请求编号 |
|Code |integer |返回状态码 |
|Message |string |返回内容 |
|AuthKey |string |AuthKey |
|AuthPwd |string |AuthPwd |
|Suid |string |业务标识 |
|Tunnel_url |string |隧道地址 |
**备注:**
更多返回错误代码请看首页的错误代码描述。
按时业务购买询价
**简要描述:**
- 业务购买询价
**输入参数:**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|spec_id |是 |integer |按时产品ID |
|duration |是 |string | 购买时长 单位:
- s: 小时,免费试用时长 例:2s(2小时)
- d: 天 例:1d(1天)
- w: 周 例:1w(1周)
- m: 月 例:1m(1个月)
|
|number |否 |integer | 通道数,IP类型为静态、动态和隧道固定时长时必传;IP类型为隧道每次请求换ip时不需要传 |
|connect |否 |integer | 连接数,IP类型为隧道每次请求换ip时必传;其他类型不需要传 |
**输入示例:**
- https://qg.net/api/Proxyip/getPrice?spec_id=888&duration=1m&number=1
**返回示例**
JSON格式
```
{
"RequestId":"ASDF4ASF-ASDFASF",
"Code": 200,
"Data": {
"OriginPrice":134,
"TotalPrice":68
},
"Message":"获取成功"
}
```
**返回参数说明**
|参数名|类型|说明|
|:----- |:-----|----- |
|RequestId |string |请求编号 |
|Code |integer |返回状态码 |
|Message |string |返回内容 |
|OriginPrice |float |原价 |
|TotalPrice |float |应付价格| |
**备注:**
更多返回错误代码请看首页的错误代码描述。
查询白名单IP
## 1 接口描述
接口地址: https://proxy.qg.net/whitelist/query ;
本接口用于查询IP的白名单。
该接口单个Key的请求频率限制为:60次/分钟;
方法:HTTP、GET,需要注意不能混合使用;
编码:参数和返回内容均采用utf-8编码。
## 2 输入参数说明
|参数名|是否必选|类型|描述|
|:---- |:---|:----- |----- |
|Key |是 |String |查询白名单的Key值
|TaskID |是 |Integer |任务编号ID
|detail |是 |Integer |详情0(关闭) 1(开启)
## 3 返回值
接口可返回文本格式、json格式、xml格式,字段说明如下:
|参数名|类型|描述|
|:---- |:----- |----- |
|Code |Integer |结果编码,0:成功;-1:失败
|Num |Integer |数量
|Data |Array |IP白名单列表
## 4 示例
请求接口示例:
```
curl "https://proxy.qg.net/whitelist/query?Key=请改成您的Key"
```
返回示例:
```
{
"Code": 0,
"Num": 2,
"Data": [
"192.168.1.1",
"192.168.1.2"
]
}
```
## 5 接口返回错误码
| 错误码 | 描述 |
| ------------ | ------------ |
| -1 | 未知错误 |
| -10 | 参数不合法 |
| -11 | 请求过于频繁 |
| -100 | 计划不存在或已过期 |
删除白名单IP
## 1 接口描述
本接口用于删除IP的白名单。接口请求地址https://proxy.qg.net/whitelist/del ;
**注:**该接口单个Key的请求频率限制为:20 次/分钟。
## 2 输入参数说明
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
|参数名|是否必选|类型|描述|
|:---- |:---|:----- |----- |
|Key |是 |String |删除白名单的Key值|
|IP |是 |String|白名单IP,多个以逗号", "分隔|
## 3 返回值
|参数名|类型|描述|
|:---- |:----- |----- |
|Code |Integer |结果编码|
|Data |Array|删除成功的白名单数组|
|Num |Integer |删除成功的白名单个数|
## 4 示例
请求参数:
```
curl "https://proxy.qg.net/whitelist/del?Key=请改成您的Key&IP=1.1.1.1,2.2.2.2"
```
返回参数,JSON格式,详情如下:
```
{
"Code": 0,
"Data": [
"1.1.1.1",
"2.2.2.2"
],
"Num": 2
}
```
## 5 接口返回错误码
|错误码|描述|
|:---- |:----- |
| -1 | 未知错误 |
| -10 | 参数不合法 |
| -11 | 请求过于频繁 |
| -100 | 计划不存在或已过期 |
重拨独占资源
## 1 接口描述
接口地址: https://proxy.qg.net/monopolies/ips ;
本接口是用于请求重拨独占资源;
请求频率限制:按时业务是(通道数*5+10)次/分钟;
方法:PUT;
编码:参数和返回内容均采用utf-8编码。
## 2 输入参数说明
| 参数名 | 是否必选 | 类型 | 描述 |
| :----- | :------- | :----- | :----------------------------: |
| Key | 是 | String | 重拨独占资源的Key值; |
| UUIDs | 是 | String | 独占资源编号,多个用","隔开 |
## 3 返回值
接口可返回文本格式、json格式、xml格式,字段说明如下:
| 返回字段 | 类型 | 描述 |
| :------- | :----- | :--------------------------: |
| data | Array | 重拨成功的独占资源编号数组 |
| error | String | 错误信息 |
## 4 示例
请求接口示例:
```
curl -X PUT -d "Key=请改成您的Key&UUIDs=XXX,XXX" "https://proxy.qg.net/monopolies/ips"
```
返回示例:
```
{
"data": ["fj_qzdx1-2:ppp1"] //重拨成功的资源uuids
}
```
## 5 接口返回错误码
| 错误码 | 描述 |
| :----: | :------------------------------: |
| 200 | 重拨成功 |
| 400 | 重拨时间间隔限制或资源还在分配中 |
释放独占资源
##1 接口描述
接口地址: https://proxy.qg.net/monopolies
本接口是用于释放申请到的独占IP,以便于再次进行独占IP申请。
请求限制:独占资源在申请后12小时才可释放,如果资源故障,可提交工单我们会强制释放;
方法:DELETE;
编码:参数和返回内容均采用utf-8编码。
## 2 输入参数说明
| 参数名 | 是否必选 | 类型 | 描述 |
| :----- | :------- | :----- | :----------------------------: |
| Key | 是 | String | 释放独占资源的Key值; |
| UUIDs | 是 | String | 独占资源编号,多个用","隔开。 |
## 3 返回值
接口可返回文本格式、json格式、xml格式,字段说明如下:
| 返回字段 | 类型 | 描述 |
| :------- | :----- | :--------------------------: |
| data | Array | 释放成功的独占资源编号数组; |
| error | String | 错误信息 |
## 4 示例
请求接口示例:
```
curl -X DELETE "https://proxy.qg.net/monopolies?Key=请改成您的Key&UUIDs=XX,XXXX"
```
返回示例:
```
{
"data": ["fj_xmdx2-1:ppp10"] //删除成功的资源
}
```
## 5 接口返回错误码
| 错误码 | 描述 |
| :----: | :------------------------------: |
| 200 | 删除成功 |
| 400 | 释放时间限制,申请后12小时可释放 |
静态独享代理接口相关
## 1说明
通过编码使用静态独享代理主要有以下三步骤:
(1)先在[会员中心](https://www.qg.net/user/ "会员中心")上查看购买的静态独享代理,进行本地调试和验证;[查看测试步骤>>](https://www.qg.net/doc/1574.html "查看测试步骤>>")
(2)参考[代码样例](https://www.qg.net/list/192.html)请求静态独享代理;
(3)在程序中通过调用API接口获取代理,然后请求目标网站。
## 2 API接口
静态独享代理API接口一览
| 接口类型 | API | 描述 |
| ------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| 资源相关 | - [allocate](https://www.qg.net/doc/174.html "资源申请")
- [query](https://www.qg.net/doc/1504.html "获取IP资源池")
- [release](https://www.qg.net/doc/176.html "释放资源")
| - 调用 allocate申请代理IP资源
- 调用query查询IP资源池全部可用的IP信息
- 调用release释放申请到的IP,以便于再次进行IP申请。 |
| 白名单相关 | - [whitelist/query](https://www.qg.net/doc/180.html "whitelist/query")
- [whitelist/add](https://www.qg.net/doc/178.html "whitelist/add")
- [whitelist/del](https://www.qg.net/doc/179.html "删除白名单")
| - 调用 whitelist/query用于查询IP的白名单
- 调用whitelist/add用于添加IP的白名单
- 调用whitelist/del用于删除IP的白名单 |
| 资源信息查询 | - [info/quota](https://www.qg.net/doc/181.html "info/quota")
- [resources](https://www.qg.net/doc/177.html "查询区域资源") | - 调用 info/quota查询IP提取余量
- 调用extract查询平台可用的代理IP资源列表 |
查询空闲独占资源
## 1 接口描述
接口地址: https://proxy.qg.net/monopolies/idle
本接口是用于查询空闲可申请的独占资源。
请求频率限制:60次/分钟;
方法:GET;
编码:参数和返回内容均采用utf-8编码。
## 2 输入参数说明
| 参数名 | 是否必选 | 类型 | 描述 |
| :----- | :------- | :----- | :-------------------: |
| Key | 是 | String | 查询独占资源的Key值 |
## 3 返回值
接口可返回文本格式、json格式、xml格式,字段说明如下:
| 返回字段 | 类型 | 描述 |
| :------- | :----- | :------------: |
| data | Array | 独占资源列表 |
| error | String | 错误信息 |
## 4 示例
请求接口示例:
```
curl "https://proxy.qg.net/monopolize_resources/idle?Key=请改成您的Key"
```
返回示例:
```
{
"data": [{
"area": "福建省泉州市",
"area_code": 350500,
"operator": "电信",
"operator_code": 1,
"idle": 30
},{
...
}]
}
```
## 5 接口返回错误码
| 错误码 | 描述 |
| :----: | :------: |
| 200 | 查询成功 |
| 500 | 未知错误 |
动态独占代理接口相关
## 1 说明
通过编码使用动态独占代理主要有以下三步骤:
(1)先在[会员中心](https://www.qg.net/user/ "会员中心")上查看购买的动态独占代理,在“IP管理”中添加IP城市,获取的独占资源进行本地调试和验证;[查看测试步骤>>](https://www.qg.net/doc/1574.html "查看测试步骤")
(2)参考[代码样例](https://www.qg.net/list/192.html)请求动态独占代理;
(3)在程序中通过调用API接口获取独占代理,然后请求目标网站。
## 2 API接口
动态独占代理API接口一览
| 接口类型 | API | 描述 |
| ------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| 资源相关 | - [monopolize_resources](https://www.qg.net/doc/1559.html )
- [monopolize_resources](https://www.qg.net/doc/1560.html)
- [monopolize_resources](https://www.qg.net/doc/1562.html)
- [monopolize_resources/newest_ips](https://www.qg.net/doc/1561.html )
| - 用POST调用接口申请独占资源
-用GET调用接口查询可用的独占资源
- 用DELETE调用接口释放独占资源
- 用PUT调用接口请求重拨独占资源 |
| 白名单相关 | - [whitelist/query](https://www.qg.net/doc/180.html "whitelist/query")
- [whitelist/add](https://www.qg.net/doc/178.html "whitelist/add")
- [whitelist/del](https://www.qg.net/doc/179.html "whitelist/del") | - 调用接口用于查询IP的白名单
- 调用接口用于添加IP的白名单
- 调用接口用于删除IP的白名单 |
| 资源信息查询 | - [monopolize_resources/idle](https://www.qg.net/doc/1563.html) | - 用GET调用接口查询空闲的独占资源 |
**重点:**动态独占代理相对动态独享代理,除了可以独享宽带和IP,还可以指定城市,重拨的IP保持地区不变。
申请独占资源
## 1 接口描述
接口地址: https://proxy.qg.net/monopolies
本接口是用于请求申请独占代理IP资源。
方法:POST;
编码:参数和返回内容均采用utf-8编码。
## 2 输入参数说明
| 参数名 | 是否必选 | 类型 | 描述 |
| :------- | :------- | :------ | :-------------------: |
| Key | 是 | String | 申请独占资源的Key值 |
| AreaCode | 否 | Integer | 地区编码,默认随机 |
| Operator | 否 | Integer | 运营商,默认随机 |
| Num | 否 | Integer | 数量,默认为1 |
## 3 返回值
接口可返回文本格式、json格式、xml格式,字段说明如下:
| 返回字段 | 类型 | 描述 |
| :------- | :----- | :------------: |
| data | Array | 独占资源列表 |
| error | String | 错误信息 |
## 4 示例
请求接口示例:
```
curl -X POST -d 'Key=请改成您的Key&AreaCode=XX&Operator=XXX&Num=1' 'https://proxy.qg.net/monopolies'
```
返回示例:
```
{
"data": [{
"uuid": "fj_qzdx9-1:ppp10",
"area": “福建省泉州市”,
"operator": "电信",
"state": "排队(123)", //分成在线、离线、重拨中、排队中(等待秒数X)
"monopolize_time": "2022-02-17 14:01:05", //独占时间
},{
...
}]
}
```
## 5 接口返回错误码
| 错误码 | 描述 |
| :----: | :------------: |
| 201 | 创建成功 |
| 400 | 独占资源不足 |
| 400 | 通道数不足 |
| 500 | 下放白名单失败 |