短效代理（全球HTTP）-通道提取-查询通道数接口
## 1. 接口描述
接口请求域名： overseas.proxy.qg.net。
本接口 (/channels) 用于全球HTTP-短效代理产品通道提取模式下查询通道数的接口。
默认接口请求频率限制：60次/分钟。
推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html?type=2-2)。
## 2. 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| -------- | ---- | ------ | ------------------------ |
| key | 是 | String | 公共参数，产品唯一标识。 |
## 3. 输出参数
| 参数名称 | 类型 | 描述 |
| ---------- | ------- | ------------------------------------------------------------ |
| code | String | 请求状态码。 |
| data.toal | Integer | key的通道总数。 |
| data.idle | Integer | 空闲通道数。 |
| request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |
## 4. 示例
#### 输入示例
```
GET https://overseas.proxy.qg.net/channels?key=<您的key信息>
```
#### 输出示例
```json
{
"code": "SUCCESS",
"data": {
"total": 10,
"idle": 5
},
"request_id": "83158ebe-be6c-40f7-a158-688741083edc"
}
```
## 5. 错误码
| 错误码 | 描述 |
| ---------------------- | ------------------------------------------------------------ |
| INTERNAL_ERROR | 系统内部异常。 |
| INVALID_PARAMETER | 参数错误（包含参数格式、类型等错误）。 |
| INVALID_KEY | Key不存在或已过期。 |
| UNAVAILABLE_KEY | Key不可用，已过期或被封禁 |
| ACCESS_DENY | Key没有此接口的权限。 |
| API_AUTH_DENY | Api授权不通过，请检查[Api鉴权配置](https://www.qg.net/user/proxyIpManage)。 |
| KEY_BLOCK | Key被封禁。 |
| REQUEST_LIMIT_EXCEEDED | 请求频率超出限制。 |
短效代理（全球HTTP）-按量提取-查询国家接口
## 1. 接口描述
接口请求域名： overseas.proxy.qg.net。
本接口 (/resources) 用于全球HTTP-短效代理产品按量提取模式下查询国家资源的接口。
默认接口请求频率限制：60次/分钟。
推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html?type=5-2)。
## 2. 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| -------- | ---- | ------ | ------------------------ |
| key | 是 | String | 公共参数，产品唯一标识。 |
## 3. 输出参数
| 参数名称 | 类型 | 描述 |
| ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| code | String | 请求状态码。 |
| data | Array of [ResourceAreaISP](https://www.qg.net/doc/1839.html) | [国家编码](https://www.qg.net/doc/use/8_234_201/1975.html) |
| request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |
## 4. 示例
#### 输入示例
```
GET https://overseas.proxy.qg.net/resources?key=<您的key信息>
```
#### 输出示例
```json
{
"code": "SUCCESS",
"data": [
{
"area": "美国",
"area_code": 990100,
"country": "US",
"available": true
}
],
"request_id": "51024a8b-a8a5-4e78-9301-cb500a8c083e"
}
```
## 5. 错误码
| 错误码 | 描述 |
| ---------------------- | ------------------------------------------------------------ |
| INTERNAL_ERROR | 系统内部异常。 |
| INVALID_PARAMETER | 参数错误（包含参数格式、类型等错误）。 |
| INVALID_KEY | Key不存在或已过期。 |
| UNAVAILABLE_KEY | Key不可用，已过期或被封禁 |
| ACCESS_DENY | Key没有此接口的权限。 |
| API_AUTH_DENY | Api授权不通过，请检查[Api鉴权配置](https://www.qg.net/user/proxyipResource)。 |
| KEY_BLOCK | Key被封禁。 |
| REQUEST_LIMIT_EXCEEDED | 请求频率超出限制。 |
短效代理-按量提取-查询余额接口
## 1. 接口描述
接口请求域名： share.proxy.qg.net。
本接口 (/balance) 用于短效代理产品按量提取模式下查询余额的接口。
默认接口请求频率限制：60次/分钟。
推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html)。
## 2. 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| -------- | ---- | ------ | ------------------------ |
| key | 是 | String | 公共参数，产品唯一标识。 |
## 3. 输出参数
| 参数名称 | 类型 | 描述 |
| ------------ | ------- | ------------------------------------------------------------ |
| code | String | 请求状态码。 |
| data.balance | Integer | key的IP余额。 |
| request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |
## 4. 示例
#### 输入示例
```
GET https://share.proxy.qg.net/balance?key=<您的key信息>
```
#### 输出示例
```json
{
"code": "SUCCESS",
"data": {
"balance": 9999
},
"request_id": "83158ebe-be6c-40f7-a158-688741083edc"
}
```
## 5. 错误码
| 错误码 | 描述 |
| ---------------------- | -------------------------------------------------------- |
| INTERNAL_ERROR | 系统内部异常。 |
| INVALID_PARAMETER | 参数错误（包含参数格式、类型等错误）。 |
| INVALID_KEY | Key不存在或已过期。 |
| UNAVAILABLE_KEY | Key不可用，已过期或被封禁 |
| ACCESS_DENY | Key没有此接口的权限。 |
| API_AUTH_DENY | Api授权不通过，请检查[Api鉴权配置](https://www.qg.net/user/proxyIpManage)。 |
| KEY_BLOCK | Key被封禁。 |
| REQUEST_LIMIT_EXCEEDED | 请求频率超出限制。 |
短效代理-弹性提取-查询资源地区接口
## 1. 接口描述
接口请求域名： share.proxy.qg.net。
本接口 (/resources) 用于短效代理产品弹性提取模式下查询资源地区的接口。
默认接口请求频率限制：60次/分钟。
推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html)。
## 2. 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| -------- | ---- | ------ | ------------------------ |
| key | 是 | String | 公共参数，产品唯一标识。 |
## 3. 输出参数
| 参数名称 | 类型 | 描述 |
| ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| code | String | 请求状态码。 |
| data | Array of [ResourceAreaISP](https://www.qg.net/doc/1839.html) | 资源地区列表。 |
| request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |
## 4. 示例
#### 输入示例
```
GET https://share.proxy.qg.net/resources?key=<您的key信息>
```
#### 输出示例
```json
{
"code": "SUCCESS",
"data": [
{
"area": "福建省泉州市",
"area_code": 350500,
"isp": "电信",
"isp_code": 1,
"available": false
},
{
"area": "河南省商丘市",
"area_code": 411400,
"isp": "电信",
"isp_code": 1,
"available": true
}
],
"request_id": "51024a8b-a8a5-4e78-9301-cb500a8c083e"
}
```
## 5. 错误码
| 错误码 | 描述 |
| ---------------------- | -------------------------------------------------------- |
| INTERNAL_ERROR | 系统内部异常。 |
| INVALID_PARAMETER | 参数错误（包含参数格式、类型等错误）。 |
| INVALID_KEY | Key不存在或已过期。 |
| UNAVAILABLE_KEY | Key不可用，已过期或被封禁 |
| ACCESS_DENY | Key没有此接口的权限。 |
| API_AUTH_DENY | Api授权不通过，请检查[Api鉴权配置](https://www.qg.net/user/proxyIpManage)。 |
| KEY_BLOCK | Key被封禁。 |
| REQUEST_LIMIT_EXCEEDED | 请求频率超出限制。 |
短效代理-弹性提取-查询余额接口
## 1. 接口描述
接口请求域名： share.proxy.qg.net。
本接口 (/balance) 用于短效代理产品弹性提取模式下查询余额的接口。
默认接口请求频率限制：60次/分钟。
推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html)。
## 2. 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| -------- | ---- | ------ | ------------------------ |
| key | 是 | String | 公共参数，产品唯一标识。 |
## 3. 输出参数
| 参数名称 | 类型 | 描述 |
| ------------ | ------- | ------------------------------------------------------------ |
| code | String | 请求状态码。 |
| data.balance | Integer | key当天的剩余可提取的数量。 |
| request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |
## 4. 示例
#### 输入示例
```
GET https://share.proxy.qg.net/balance?key=<您的key信息>
```
#### 输出示例
```json
{
"code": "SUCCESS",
"data": {
"balance": 9999
},
"request_id": "83158ebe-be6c-40f7-a158-688741083edc"
}
```
## 5. 错误码
| 错误码 | 描述 |
| ---------------------- | -------------------------------------------------------- |
| INTERNAL_ERROR | 系统内部异常。 |
| INVALID_PARAMETER | 参数错误（包含参数格式、类型等错误）。 |
| INVALID_KEY | Key不存在或已过期。 |
| UNAVAILABLE_KEY | Key不可用，已过期或被封禁 |
| ACCESS_DENY | Key没有此接口的权限。 |
| API_AUTH_DENY | Api授权不通过，请检查[Api鉴权配置](https://www.qg.net/user/proxyIpManage)。 |
| KEY_BLOCK | Key被封禁。 |
| REQUEST_LIMIT_EXCEEDED | 请求频率超出限制。 |
查询按量产品列表
**简要描述：**
- 获取按量产品列表信息
**输入示例：**
- https://qg.net/api/Proxyip/resourceSpecList
**返回示例**
JSON格式
```
{
"RequestId":"ASDF4ASF-ASDFASF",
"Code": 200,
"Data": {
"1":{
"Id": 62,
"Spec_name": "短效代理1-5分钟",
"Spec_no": "dtgx001",
"Ip_nums": 10000,
"Price": "30.00",
"Months": 24,
"Show_status": 1,
"Buy_status": 1,
"Group_type_id": 2,
"Desc": "IP数量 : 同时可使用的IP数等于购买的通道数 \r\nIP存活时长 : IP长久有效\r\nIP可用率 : 99.9%\r\nIP重复率 : <1%\r\nIP分布地区 : 全国主要省份\r\n终端数限制 : 不限制\r\n带宽峰值限制 : 2Mbps\r\n地区筛选 : 支持指定获取某个城市IP或全国随机\r\n代理类型 : HTTP、HTTPS、SOCKS5\r\n",
"Brand_name": "青果云",
"Create_time": 1615887813,
"Update_time": null,
"Connect" : "33"
}
}，
"Message":"获取成功"
}
```
**返回参数说明**
|参数名|类型|说明|
|:----- |:-----|----- |
|RequestId |string |请求编号 |
|Code |integer |返回状态码 |
|Message |string |返回内容 |
|Id |integer |ID |
|Spec_name |string |产品名称 |
|Ip_nums |integer |IP数量 单位万个|
|Price |float |价格 |
|Months |integer |有效期 |
|Show_status |integer |状态 1:显示 0：不显示 |
|Buy_status |integer |状态 1:禁用 0：禁用 |
|Desc |string |基本介绍|
|Group_type_id |integer |规格ID|
|Brand_name |string |品牌名称|
|Connect |string |连接数|
|Connect_limit |string |连接数限制|
**备注**
- 更多返回错误代码请看首页的错误代码描述
查询按时产品列表
**简要描述：**
- 获取按时产品列表信息。
**输入示例：**
- https://qg.net/api/Proxyip/channelSpecList
**返回示例**
JSON格式
```
{
"RequestId":"ASDF4ASF-ASDFASF",
"Code": 200,
"Data": {
"1":{
"Id": 1,
"Spec_name": "独享动态",
"Spec_no": "14995",
"Trial_time": 8,
"Day_rate": "0.08",
"Week_rate": "0.40",
"Month_rate": "1,3,6,10,20,30",
"Computing_time": "1,3,6,12,24,36",
"Show_status": 1,
"Buy_status": 1,
"Renew_status": 1,
"Upgrade_status": 1,
"Content": "IP数量 : 同时可使用的IP数等于购买的通道数
IP存活时长 : 自由控制，最长24小时，IP存活时长大于30秒后，可以随时更换IP
IP可用率 : ＞99.9%，IP检测可用后才会进入IP池
IP重复率 : <1%?优先分配未使用IP给客户
IP分布地区 : 全国主要省份?更多城市还在不断增加中
终端数限制 : 不限制?支持多机器或多进程同时使用代理IP
带宽峰值限制 : 10Mbps
地区筛选 : 支持指定获取某个城市IP或全国随机
代理类型 : HTTP、HTTPS、SOCKS5",
"Basic_price": "59.00",
"Group_type_id": 1,
"Brand_name": "青果云",
"Create_time": 1598204266,
"Update_time": 1598204266,
"Connect_limit": 132,
"Connect_price": "10.00",
"Connect_gift": 1,
"Connect_list": "1-10",
}
}，
"Message":"获取成功"
}
```
**返回参数说明**
|参数名|类型|说明|
|:----- |:-----|----- |
|RequestId |string |请求编号 |
|Code |integer |返回状态码 |
|Message |string |返回内容 |
|Id |integer |ID |
|Spec_name |string |产品名称 |
|Trial_time |integer |试用时间 单位小时|
|Day_rate |float |日付费率 |
|Week_rate |float |周付费率 |
|Month_rate |float |月付费率 |
|Computing_time |string |可选时长 |
|Show_status |integer |显示状态 1:显示 0：不显示 |
|Buy_status |integer |购买状态 1:启用 0：禁用 |
|Renew_status |integer |续费状态 1:启用 0：禁用 |
|Upgrade_status |integer |升级状态 1:启用 0：禁用|
|Content |string |基本介绍|
|Basic_price |float |基础价格 |
|Group_type_id |integer |规格ID|
|Brand_name |string |品牌名称|
|Connect_limit |string |IP类型为动态或者静态：连接数限制；IP类型为隧道固定时长：请求数限制|
|Connect_price |string |连接数单价|
|Connect_gift |string |连接数赠送值|
|Connect_list |string |连接数可选值|
**备注**
- 更多返回错误代码请看首页的错误代码描述
短效代理-均匀提取-查询资源地区接口
## 1. 接口描述
接口请求域名： share.proxy.qg.net。
本接口 (/resources) 用于短效代理产品均匀提取模式下查询资源地区的接口。
默认接口请求频率限制：60次/分钟。
推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html)。
## 2. 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| -------- | ---- | ------ | ------------------------ |
| key | 是 | String | 公共参数，产品唯一标识。 |
## 3. 输出参数
| 参数名称 | 类型 | 描述 |
| ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| code | String | 请求状态码。 |
| data | Array of [ResourceAreaISP](https://www.qg.net/doc/1839.html) | 资源地区列表。 |
| request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |
## 4. 示例
#### 输入示例
```
GET https://share.proxy.qg.net/resources?key=<您的key信息>
```
#### 输出示例
```json
{
"code": "SUCCESS",
"data": [
{
"area": "福建省泉州市",
"area_code": 350500,
"isp": "电信",
"isp_code": 1,
"available": false
},
{
"area": "河南省商丘市",
"area_code": 411400,
"isp": "电信",
"isp_code": 1,
"available": true
}
],
"request_id": "51024a8b-a8a5-4e78-9301-cb500a8c083e"
}
```
## 5. 错误码
| 错误码 | 描述 |
| ---------------------- | -------------------------------------------------------- |
| INTERNAL_ERROR | 系统内部异常。 |
| INVALID_PARAMETER | 参数错误（包含参数格式、类型等错误）。 |
| INVALID_KEY | Key不存在或已过期。 |
| UNAVAILABLE_KEY | Key不可用，已过期或被封禁 |
| ACCESS_DENY | Key没有此接口的权限。 |
| API_AUTH_DENY | Api授权不通过，请检查[Api鉴权配置](https://www.qg.net)。 |
| KEY_BLOCK | Key被封禁。 |
| REQUEST_LIMIT_EXCEEDED | 请求频率超出限制。 |
独享代理（地区锁）-API接口介绍
## 1 说明
通过编码使用独享代理（地区锁）主要有以下4步骤：
1.先在[提取工具](https://www.qg.net/tools/IPget.html)或[调试工具](https://www.qg.net/tools/IPdebug.html)上获取api接口；
2.使用白名单或账密进行授权验证；
3.进行代理测试；[查看测试步骤＞＞](https://www.qg.net/doc/1574.html "查看测试步骤")
4.参考[代码样例](https://www.qg.net/list/192.html)编写采集程序，使用代理IP。
## 2 API接口
独享代理（地区锁）API接口一览
| 接口类型 | API | 描述 |
| ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| 资源相关 | - [get](https://www.qg.net/doc/product/6_257_271_273/1858.html)
- [query](https://www.qg.net/doc/product/6_257_271_273/1857.html)
- [delete](https://www.qg.net/doc/product/6_257_271_273/1856.html)
- [changeip](https://www.qg.net/doc/product/6_257_271_273/1855.html)
- [resources](https://www.qg.net/doc/product/6_257_271_273/1854.html)
| - 提取IP资源
- 查询在用IP资源
- 释放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/del") | - 查询IP的白名单
- 添加IP的白名单
- 删除IP的白名单 |
独享代理-API接口介绍
## 1 说明
通过编码使用独享代理主要有以下4步骤：
1.先在[提取工具](https://www.qg.net/tools/IPget.html)或[调试工具](https://www.qg.net/tools/IPdebug.html)上获取api接口；
2.使用白名单或账密进行授权验证；
3.进行代理测试；[查看测试步骤＞＞](https://www.qg.net/doc/1574.html "查看测试步骤")
4.参考[代码样例](https://www.qg.net/list/192.html)编写采集程序，使用代理IP。
## 2 API接口
独享代理API接口一览
| 接口类型 | API | 描述 |
| ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| 资源相关 | - [get](https://www.qg.net/doc/product/6_257_271_272/1840.html)
- [query](https://www.qg.net/doc/product/6_257_271_272/1841.html)
- [delete](https://www.qg.net/doc/product/6_257_271_272/1842.html)
- [replace](https://www.qg.net/doc/product/6_257_271_272/1843.html)
- [channels](https://www.qg.net/doc/product/6_257_271_272/1844.html)
- [resources](https://www.qg.net/doc/product/6_257_271_272/1845.html)
| - 提取IP资源
- 查询在用IP资源
- 释放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/del") | - 查询IP的白名单
- 添加IP的白名单
- 删除IP的白名单 |
**重点：**独享代理只提供给单个客户使用，独享带宽和IP资源，IP可自主释放申请，因此新增接口更换IP资源/replace、释放IP资源/delete。
独享代理还有一种地区锁的模式，需要IP资源在固定地区的用户可以选择使用，相关API接口文档请[点击此处](https://www.qg.net/doc/product/6_257_271_273/2142.html)查看
