独享代理-查询通道数接口
## 1. 接口描述
接口请求域名： exclusive.proxy.qg.net。
本接口 (/channels) 用于独享代理产品通道数查询的接口。
默认接口请求频率限制：60次/分钟。
推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html)。
## 2. 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| -------- | ---- | ------ | ------------------------ |
| key | 是 | String | 公共参数，产品唯一标识。 |
## 3. 输出参数
| 参数名称 | 类型 | 描述 |
| ---------- | ------- | ------------------------------------------------------------ |
| code | String | 请求状态码。 |
| data.toal | Integer | key的通道总数。 |
| data.idle | Integer | 空闲通道数。 |
| request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |
## 4. 示例
#### 输入示例
```
GET https://exclusive.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 | 请求频率超出限制。 |
短效代理-按量提取-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_255_263_265/1851.html)
- [balance](https://www.qg.net/doc/product/6_255_263_265/1852.html)
- [resources](https://www.qg.net/doc/product/6_255_263_265/1853.html)
| - 提取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 "删除白名单")
| - 查询IP的白名单
- 添加IP的白名单
- 删除IP的白名单 |
**提示：**短效代理根据提取方式的不同，提供了不同的API接口，本文介绍的是按量提取业务相关接口。
请点击文字查看其他产品接口：
[弹性提取 ＞](https://www.qg.net/doc/product/6_255_263_264/2254.html)
[均匀提取 ＞](https://www.qg.net/doc/product/6_255_263_266/2258.html)
[通道提取 ＞](https://www.qg.net/doc/product/6_255_263_267/2139.html)
短效代理-通道提取-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_255_263_267/1846.html)
- [pool](https://www.qg.net/doc/product/6_255_263_267/1848.html)
- [query](https://www.qg.net/doc/product/6_255_263_267/1847.html)
- [channels](https://www.qg.net/doc/product/6_255_263_267/1849.html)
- [resources](https://www.qg.net/doc/product/6_255_263_267/1850.html)
| - 提取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 "删除白名单")
| - 查询IP的白名单
- 添加IP的白名单
- 删除IP的白名单 |
**提示：**短效代理根据提取方式的不同，提供了不同的API接口，本文介绍的是通道提取业务相关接口。
请点击文字查看其他产品接口：
[弹性提取 ＞](https://www.qg.net/doc/product/6_255_263_264/2254.html)
[均匀提取 ＞](https://www.qg.net/doc/product/6_255_263_266/2258.html)
[按量提取 ＞](https://www.qg.net/doc/product/6_255_263_265/2140.html)
短效代理-弹性提取-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_255_263_264/2255.html)
- [balance](https://www.qg.net/doc/product/6_255_263_264/2256.html)
- [resources](https://www.qg.net/doc/product/6_255_263_264/2257.html)
| - 提取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 "删除白名单")
| - 查询IP的白名单
- 添加IP的白名单
- 删除IP的白名单 |
**提示：**短效代理根据提取方式的不同，提供了不同的API接口，本文介绍的是弹性提取业务相关接口。
请点击文字查看其他产品接口：
[均匀提取 ＞](https://www.qg.net/doc/product/6_255_263_266/2258.html)
[通道提取 ＞](https://www.qg.net/doc/product/6_255_263_267/2139.html)
[按量提取 ＞](https://www.qg.net/doc/product/6_255_263_265/2140.html)
短效代理-均匀提取-查询余额接口
## 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": 99
},
"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 | 请求频率超出限制。 |
短效代理-均匀提取-API接口介绍
## 1 说明
通过编码使用短效代理-均匀提取主要有以下4步骤：
1.先在[提取工具](https://www.qg.net/tools/IPget.html?type=2-2 "提取工具")或[调试工具](https://www.qg.net/tools/IPdebug.html?type=2-2 "调试工具")上获取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_255_263_266/2259.html)
- [balance](https://www.qg.net/doc/product/6_255_263_266/2260.html)
- [resources](https://www.qg.net/doc/product/6_255_263_266/2261.html)
| - 提取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 "删除白名单")
| - 查询IP的白名单
- 添加IP的白名单
- 删除IP的白名单 |
**提示：**短效代理根据提取方式的不同，提供了不同的API接口，本文介绍的是均匀提取业务相关接口。
请点击文字查看其他产品接口：
[弹性提取 ＞](https://www.qg.net/doc/product/6_255_263_264/2254.html)
[通道提取 ＞](https://www.qg.net/doc/product/6_255_263_267/2139.html)
[按量提取 ＞](https://www.qg.net/doc/product/6_255_263_265/2140.html)
短效代理-通道提取-查询通道数接口
## 1. 接口描述
接口请求域名： share.proxy.qg.net。
本接口 (/channels) 用于短效代理产品通道提取模式下通道数查询的接口。
默认接口请求频率限制：60次/分钟。
推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html)。
## 2. 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| -------- | ---- | ------ | ------------------------ |
| key | 是 | String | 公共参数，产品唯一标识。 |
## 3. 输出参数
| 参数名称 | 类型 | 描述 |
| ---------- | ------- | ------------------------------------------------------------ |
| code | String | 请求状态码。 |
| data.toal | Integer | key的通道总数。 |
| data.idle | Integer | 空闲通道数。 |
| request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |
## 4. 示例
#### 输入示例
```
GET https://share.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)。 |
| KEY_BLOCK | Key被封禁。 |
| REQUEST_LIMIT_EXCEEDED | 请求频率超出限制。 |
隧道代理（全球HTTP）
## 1 说明
通过编码使用隧道代理（全球HTTP）主要有以下两步骤：
（1）购买成功后，先在[会员中心](https://www.qg.net/user/ "会员中心")查看隧道信息，进行本地调试和验证；[查看测试步骤＞＞](https://www.qg.net/doc/1574.html "查看测试步骤＞＞")
（2）参考[代码样例](https://www.qg.net/doc/1879.html)请求隧道代理访问目标网站。
## 2 API接口
隧道不支持使用API接口进行提取IP等调用，但提供白名单功能的API接口。
| 接口类型 | 接口 |
| ---------- | --------------------- | ------------------ |
| 白名单相关 | [添加白名单IP](https://www.qg.net/doc/178.html "添加白名单IP")
[删除白名单IP](https://www.qg.net/doc/179.html "删除白名单IP")
[查询白名单IP](https://www.qg.net/doc/180.html "[查询白名单IP]")
**重点：**目前隧道代理仅支持IP白名单相关接口，隧道代理的使用主要参考[代码示例](https://www.qg.net/doc/1879.html "代码示例")。
隧道代理
## 1 说明
通过编码使用隧道代理主要有以下两步骤：
（1）购买成功后，先在[会员中心](https://www.qg.net/user/ "会员中心")查看隧道信息，进行本地调试和验证；[查看测试步骤＞＞](https://www.qg.net/doc/1574.html "查看测试步骤＞＞")
（2）参考[代码样例](https://www.qg.net/doc/1879.html)请求隧道代理访问目标网站。
## 2 API接口
隧道不支持使用API接口进行提取IP等调用，但提供白名单功能的API接口。
| 接口类型 | 接口 |
| ---------- | --------------------- | ------------------ |
| 白名单相关 | [添加白名单IP](https://www.qg.net/doc/178.html "添加白名单IP")
[删除白名单IP](https://www.qg.net/doc/179.html "删除白名单IP")
[查询白名单IP](https://www.qg.net/doc/180.html "[查询白名单IP]")
**重点：**目前隧道代理仅支持IP白名单相关接口，隧道代理的使用主要参考[代码示例](https://www.qg.net/doc/1879.html "代码示例")。
获取IP资源池
## 1 接口描述
接口地址：https://proxy.qg.net/extract ；
本接口用于获取IP资源池全部可用的IP信息，该接口仅按时动态共享业务可用；
该接口单个Key的请求频率限制为45次/分钟；
需要注意的是请求方方式只能用GET；
编码：参数和返回内容均采用utf-8编码。
## 2 输入参数说明
| 参数名 | 是否必选 | 类型 | 描述 |
| :------- | :------- | :-------| ------- |
| Key | 是 | String | 申请的Key值 |
| Num | 否 | Integer | 申请的数量；默认为1 |
| AreaId |否 | Integer | 区域ID；默认随机 |
| ISP |否 | Integer | 运营商ID；默认随机 |
| Detail | 否 | Integer | 详情，0：关闭；1：开启；默认为0 |
## 3 返回值
接口可返回文本格式、json格式、xml格式，字段说明如下：
| 参数名 | 类型 | 描述 |
| :----- | :------ | ------------------------------------------ |
| Code | Integer | 结果编码，0：成功；-1：失败 |
| TaskID | Integer | 任务ID |
| Num | Intger | 申请数量 |
| Data | Array | 代理IP数据信息，包含节点IP、端口、失效日期 |
| Msg | String | 公共参数；本接口取值：区域ID |
## 4 示例
请求接口示例：
```
curl "https://proxy.qg.net/extract?Key=请改成您的Key&Pool=1&Detail=1"
```
返回示例：
```json
{
"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"
}
```
**重点：如果用户是企业池用户，且参数Pool=2，则返回的IP资源Data结构中的host和IP是不一样的，其他产品下host和IP是一样的。企业池产品中用户使用host进行代理，这时真实的代理IP为IP字段的IP（运营商为移动的情况下可能不会那么准确，即使代理IP可能不通，也都是同一个地区的IP，影响不会大）**
## 5 接口返回错误码
| 错误码 | 描述 |
| ------ | ----------------------- |
| -1 | 未知错误 |
| -10 | 参数不合法 |
| -11 | 请求过于频繁 |
| -12 | Authkey被封禁 |
| -13 | 当前客户端IP不在授权名单中 |
| -14 | Pwd不合法 |
| -15 | Authkey对应的业务无此功能权限 |
| -100 | 计划不存在或已过期 |
| -101 | 请求数量超过计划通道数 |
| -103 | 资源不足 |
| -104 | 资源申请失败 |
