独享代理-地区锁功能介绍
青果独享代理产品中，提供一种特殊的可指定所用IP是某个地区范围的功能，即为地区锁。
使用地区锁的用户可以锁定地区IP进行切换，不会因为资源紧张而出现提取不到指定地区IP的情况。适合于需要使用固定地区家庭IP的场景。
## 地区锁使用方法
注意：启用地区锁后，提取速度会降低，使用方式也会改变。
#### 1. 查看地区锁启用状态：
在控制台中筛选“独享代理”产品，可通过地区锁字段查看当前业务是否启用地区锁功能
#### 2. 启用或者停用地区锁：
在业务列表中找到需要操作的业务，查看详情在详情页中，找到"地区锁"字段，进行启用或停用。切换地区锁功能，将强制释放已提取IP，并且12小时后才能切换地区锁。
#### 3. 在控制台中使用地区锁模式：
在业务列表找到已启用地区锁的业务，点击“地区锁”，进入管理页面。在管理页面中，先根据购买的通道数资源，添加需要锁定的城市资源，然后在IP管理中进行切换或者移除即可。
#### 4. 地区锁对应的API接口
当启用地区锁之后，所调用的API接口也会发生变化，[查看详情 ＞](https://www.qg.net/doc/2142.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_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)查看
代理IP调试工具
## 概述
购买完代理产品后，用户在使用代理IP的过程中，很多代理资源查询或代理使用，如替换、释放、通道配额等都需要在编程环境中才能调试运行获得，操作上存在局限性，调试工具则可以方便用户可以直接线上简单对接调试，便捷用户操作成本和缩减时间成本。
## 工具说明
### 2.1 请求方式
请求方式包括POST和GET，默认POST请求，根据自己的需求选择；右侧网址则是接口网址完整信息，包括选择的key、接口方法等参数信息。
### 2.2 key
key为必选项，是对接接口的必要信息。key的选择根据登录状态不同，可操作性不同。未登录时，需手动输入key值，已登录时，可下拉选择已购买的代理业务key，key信息附带业务资源配置和业务备注信息，方便辨别业务。
未登录状态：
已登录状态：
### 2.3 接口方法
接口方法主要是选择要调试的接口类型，包括资源相关、IP白名单、信息查询三大模块，各个接口说明详情如下图：
| 接口类型 | API | 描述 |
| ------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
| 通用资源管理相关 | - [allocate](https://www.qg.net/doc/174.html "资源申请")
- [extract](https://www.qg.net/doc/1504.html "获取IP资源池")
- [replace](https://www.qg.net/doc/297.html "更换IP资源")
- [release](https://www.qg.net/doc/176.html "释放资源")
- [query](https://www.qg.net/doc/175.html "资源查询") | - 调用 allocate申请代理IP资源
- 调用extract获取IP资源池全部可用的IP信息
- 调用replace用于释放并申请新的代理IP，更换IP资源
- 调用release释放申请到的IP，以便于再次进行IP申请
- 调用query查询用户可用的代理IP资源列表 |
| 独占代理专用相关 | - [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 )
-[monopolize_resources/idle](https://www.qg.net/doc/1563.html) | - 用POST调用接口申请独占资源
-用GET调用接口查询可用的独占资源
- 用DELETE调用接口释放独占资源
-用PUT调用接口请求重拨独占资源
-用GET调用接口查询空闲的独占资源 |
| 白名单管理相关 | - [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提取余量
- 调用resources查询平台可用的代理IP资源列表 |
### 2.4 参数类型
调试工具中各个参数根据不同的接口类型对应显示，各个参数有不同的含义，详情如下：
| 参数名 | 是否必选 | 描述 |
| :------------ | :------- | ------------------------------------------------------------ |
| Key | 是 | 要申请IP的业务的Key值，下拉选择即可； |
| IP | 是 | 代理IP;多个以逗号分割;*代表全部； |
| Num | 否 | 申请的IP个数，默认1个，最大不超过套餐内IP数量最大值； |
| KeepAlive | 否 | IP生存周期，其中独享默认24小时,短效默认购买的套餐存活周期时长； |
| AreaId | 否 | 区域ID;默认随机； |
| ISP | 否 | 运营商ID;默认随机；1:电信，2:移动，3:联通，4:BGP |
| Detail | 否 | 是否获取代理IP的详情，默认为 0关闭，1为开启； |
| Distinct | 否 | 申请的IP是否去重，默认为0不去重,1为开启去重；短效代理、独享代理适用。 |
| DataFormat | 否 | 数据格式，本接口取值：json、html、txt ，默认为 json格式 |
| DataSeparator | 否 | 分隔符，自定义 |
### 2.5 结果参数说明
点击“测试”，右侧文本框区域显示接口请求结果，返回结果参数说明：
| 参数名 | 描述 |
| :-------- | -------------------------------------------------- |
| Code | 申请IP结果编码:0(成功）-1(失败)。 |
| TaskID | 接口请求任务ID，可通过该IP释放该任务所申请到的IP； |
| Total | 获取到的代理IP总数量 |
| Available | 获取到的代理IP可用数量 |
| Used | 获取到代理IP已使用数量 |
| Num | 申请的代理IP数量 |
| TotalNum | 总IP数，主要是资源查询 |
| Data | 代理IP数据信息，包含节点IP、端口、失效日期 |
| Msg | 公共参数，本接口取值：区域ID. |
短效代理-通道提取-查询资源地区接口
## 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。
本接口 (/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/proxyipResource)。 |
| KEY_BLOCK | Key被封禁。 |
| REQUEST_LIMIT_EXCEEDED | 请求频率超出限制。 |
短效代理（全球HTTP）-通道提取-API接口介绍
## 1 说明
通过编码使用短效代理（全球HTTP）-通道提取主要有以下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接口
短效代理（全球HTTP）-通道提取API接口一览
| 接口类型 | API | 描述 |
| ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| 资源相关 | - [get](https://www.qg.net/doc/product/6_259_275_277/2176.html)
- [query](https://www.qg.net/doc/product/6_259_275_277/2177.html)
- [channels](https://www.qg.net/doc/product/6_259_275_277/2179.html)
- [resources](https://www.qg.net/doc/product/6_259_275_277/2178.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的白名单 |
短效代理（全球HTTP）-按量提取-API接口介绍
## 1 说明
通过编码使用短效代理（全球HTTP）-按量提取主要有以下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接口
短效代理（全球HTTP）-按量提取API接口一览
| 接口类型 | API | 描述 |
| ---------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
| 资源相关 | - [get](https://www.qg.net/doc/product/6_259_275_276/1865.html)
- [query](https://www.qg.net/doc/product/6_259_275_276/1864.html)
- [balance](https://www.qg.net/doc/product/6_259_275_276/1866.html)
- [resources](https://www.qg.net/doc/product/6_259_275_276/1867.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的白名单 |
短效代理（全球HTTP）-按量提取-查询余额接口
## 1. 接口描述
接口请求域名： overseas.proxy.qg.net。
本接口 (/balance) 用于全球HTTP-短效代理产品按量提取模式下查询余额的接口。
默认接口请求频率限制：60次/分钟。
推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html?type=5-2)。
## 2. 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| -------- | ---- | ------ | ------------------------ |
| key | 是 | String | 公共参数，产品唯一标识。 |
## 3. 输出参数
| 参数名称 | 类型 | 描述 |
| ------------ | ------- | ------------------------------------------------------------ |
| code | String | 请求状态码。 |
| data.balance | Integer | key的IP余额。 |
| request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |
## 4. 示例
#### 输入示例
```
GET https://overseas.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/proxyipResource)。 |
| 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 | 请求频率超出限制。 |
独享代理（地区锁）-替换IP资源接口
## 1. 接口描述
接口请求域名： monopoly.proxy.qg.net。
本接口 (/changeip) 用于独享代理产品启用地区锁功能后更换资源IP的接口。
默认接口请求频率限制：60次/分钟。
推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html)。
## 2. 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| -------- | ---- | ------ | ------------------------------------------------------------ |
| key | 是 | String | 公共参数，产品唯一标识。 |
| uuid | 是 | String | 更换指定的独占资源的IP。支持多资源同事更换，按逗号隔开。比如：hn_sqdx2-1:ppp1,hn_sqdx2-1:ppp14。 |
## 3. 输出参数
| 参数名称 | 类型 | 描述 |
| ---------- | --------------- | ------------------------------------------------------------ |
| code | String | 请求状态码。 |
| data | Array of String | 更换成功的独占资源UUID列表。 |
| request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |
## 4. 示例
#### 输入示例
```
GET https://monopoly.proxy.qg.net/changeip?key=<您的key信息>&<其他输入参数>
```
#### 输出示例
```json
{
"code": "SUCCESS",
"data": ["hn_sqdx2-1:ppp14", "hn_sqdx2-1:ppp1"],
"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 | 请求频率超出限制。 |
| MONOPOLY_CHANGEIP_TIME_LIMIT | 独占资源切换IP需要等待10秒。 |
