## 步骤总览  ## 一、提取IP 1.在青果完成产品购买后，就会自动进入控制后台，用户可以点击对应业务右侧的【更多】-【IP使用】-【提取IP】进入提取工具页面，也可以点击左侧导航栏的【提取工具】进入；  **请注意，**目前国内代理IP和全球HTTP的产品，除了按量提取对应的套餐是按量业务之外，其他产品都属于按时业务。 2.在提取工具页面，选择对应业务的Authkey，以及提取数量、地区、格式等其他选项，便可在页面下方看到链接，点击【打开链接】；  便可在打开的网页中看到此时提取到的IP地址。  ## 二、授权验证 获取IP之后，还需要有授权验证才能使用代理。青果支持白名单和帐密两种验证方式，可自主选择使用。 白名单模式，即把要实现代理的服务器IP添加进代理白名单中，后续使用该IP连接代理就能成功； 账密模式，即先获取该代理业务的账号密码信息，连接代理时填入账密进行验证就可使用代理。  详细步骤可查看[代理验证 ＞](https://www.qg.net/doc/use/8_244/1574.html) ## 三、测试使用 做好以上步骤之后，即可开始连接代理测试。 青果代理IP支持用户使用各种浏览器、代理客户端、电脑系统等等进行代理设置。 以谷歌浏览器chrome为例，设置代理需要1.在右上角菜单中点击【设置】，设置页面中选择【系统】-【打开代理设置】；  2.在新打开的弹窗页面中，把【使用代理服务器】按钮打开，并填写地址与端口信息，点击保存，就算启动代理连接了； 3.若使用的是账密验证，此时在浏览器打开一个新网页，会弹出以下会话，填写业务所对应的AuthKey以及AuthPwd信息，点击确认便能完成代理连接；  若使用的是白名单验证，则跳过该步骤。 4.此时进行正常的网页浏览，若能正常使用，就算代理连接成功了。 **[点击查看更多的浏览器、电脑系统、软件设置代理指南 ＞](https://www.qg.net/doc/2238.html)** ## 四、重新获取IP 青果代理IP产品都有相对应的IP存活周期，其有效时长是从提取到IP时算起，超过这个时长IP会失效。 IP到期失效之后，需要回到第一步重新提取IP，再将新ip信息填入代理服务器中进行使用。

**全球HTTP均不支持在中国大陆地区网络环境下使用。** ## 步骤总览  ## 一、提取IP 1.在青果完成产品购买后，就会自动进入控制后台，用户可以点击对应业务右侧的【更多】-【IP使用】-【提取IP】进入提取工具页面，也可以点击左侧导航栏的【提取工具】进入；  **请注意，**目前国内代理IP和全球HTTP的产品，除了按量提取对应的套餐是按量业务之外，其他产品都属于按时业务。 2.在提取工具页面，选择对应业务的Authkey，以及提取数量、地区、格式等其他选项，便可在页面下方看到链接，点击【打开链接】；  便可在打开的网页中看到此时提取到的IP地址。  ## 二、授权验证 获取IP之后，还需要有授权验证才能使用代理。青果支持白名单和帐密两种验证方式，可自主选择使用。 白名单模式，即把要实现代理的服务器IP添加进代理白名单中，后续使用该IP连接代理就能成功； 账密模式，即先获取该代理业务的账号密码信息，连接代理时填入账密进行验证就可使用代理。  详细步骤可查看[代理验证 ＞](https://www.qg.net/doc/use/8_244/1574.html) ## 三、测试使用 做好以上步骤之后，即可开始连接代理测试。 青果代理IP支持用户使用各种浏览器、代理客户端、电脑系统等等进行代理设置。 以谷歌浏览器chrome为例，设置代理需要1.在右上角菜单中点击【设置】，设置页面中选择【系统】-【打开代理设置】；  2.在新打开的弹窗页面中，把【使用代理服务器】按钮打开，并填写地址与端口信息，点击保存，就算启动代理连接了； 3.若使用的是账密验证，此时在浏览器打开一个新网页，会弹出以下会话，填写业务所对应的AuthKey以及AuthPwd信息，点击确认便能完成代理连接；  若使用的是白名单验证，则跳过该步骤。 4.此时进行正常的网页浏览，若能正常使用，就算代理连接成功了。 **[点击查看更多的浏览器、电脑系统、软件设置代理指南 ＞](https://www.qg.net/doc/2238.html)** ## 四、重新获取IP 青果代理IP产品都有相对应的IP存活周期，其有效时长是从提取到IP时算起，超过这个时长IP会失效。 IP到期失效之后，需要回到第一步重新提取IP，再将新ip信息填入代理服务器中进行使用。

## Response 请求响应详情 被所有接口引用。 | 名称 | 类型 | 描述 | | ---------- | ------ | ------------------------------------------------------------ | | code | String | 响应[状态码](https://www.qg.net/doc/1838.html)。 | | data | Any | 请求响应数据。 | | message | String | 报错信息。 | | request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 | ## IP 代理IP详情 被如下接口引用：[短效代理提取](https://www.qg.net/doc/1846.html), [短效代理查询](https://www.qg.net/doc/1847.html), [短效代理资源池](https://www.qg.net/doc/1850.html), [独享代理提取](https://www.qg.net/doc/1840.html), [独享代理查询](https://www.qg.net/doc/1841.html), [独享代理更换](https://www.qg.net/doc/1843.html), [静态代理提取](https://www.qg.net/doc/1863.html), [静态代理查询](https://www.qg.net/doc/1861.html)。 | 名称 | 类型 | 描述 | | -------- | ------ | ------------------------------------------------------------ | | proxy_ip | String | 代理IP，比如: 120.11.67.89。 | | server | String | 代理服务地址，比如：120.11.67.89:8090。 | | area | String | 代理IP地区信息。 | | isp | String | 代理IP运营商信息。 | | deadline | String | 动态代理表示代理IP的存活截至时间；
静态代理表示代理IP的可释放时间。 | ## Task 单次提取详情 被如下接口引用：[短效代理提取](https://www.qg.net/doc/1846.html), [短效代理查询](https://www.qg.net/doc/1847.html), [短效代理资源池](https://www.qg.net/doc/1850.html), [独享代理提取](https://www.qg.net/doc/1840.html), [独享代理查询](https://www.qg.net/doc/1841.html), [独享代理更换](https://www.qg.net/doc/1843.html), [静态代理提取](https://www.qg.net/doc/1863.html), [静态代理查询](https://www.qg.net/doc/1861.html)。 | 名称 | 类型 | 描述 | | ------- | --------------- | ---------------- | | task_id | String | 本次提取的标识。 | | ips | Array of [IP]() | IP资源信息。 | | num | Integer | IP资源总数。 | ## Balance 余额详情 被如下接口引用：[短效代理余额查询](https://www.qg.net/doc/2256.html)。 | 名称 | 类型 | 描述 | | ------- | ------- | -------------- | | balance | Integer | 剩余资源总数。 | ## Channel 通道数详情 被如下接口引用：[短效代理通道数查询](https://www.qg.net/doc/1849.html), [独享代理通道数查询](https://www.qg.net/doc/1844.html), [静态代理通道数查询](https://www.qg.net/doc/1860.html)。 | 名称 | 类型 | 描述 | | ----- | ------- | ------------ | | total | Integer | 总通道数。 | | idle | Integer | 空闲通道数。 | ## ResourceAreaISP 资源可用地区和运营商详情 被如下接口引用：[短效代理资源地区查询](https://www.qg.net/doc/2257.html), [独享代理资源地区查询](https://www.qg.net/doc/1845.html), [静态代理资源地区查询](https://www.qg.net/doc/1859.html)。 | 名称 | 类型 | 描述 | | --------- | ------- | ---------------- | | area | String | 地区信息。 | | area_code | Integer | 地区码。 | | isp | String | 运营商信息。 | | isp_code | Integer | 运营商编码。 | | available | Bool | 是否有可用资源。 | ## Monopoly 独占资源详情 被如下接口引用：[独享代理提取](https://www.qg.net/doc/1840.html), [独享代理查询](https://www.qg.net/doc/1841.html)。 | 名称 | 类型 | 描述 | | --------------- | ------ | ------------------------------------ | | uuid | String | 资源唯一标识。 | | area | String | 地区信息。 | | isp | String | 运营商信息。 | | state | String | 资源状态。 | | ip | String | 最新IP，仅当state="在线"有值。 | | heartbeat | String | 最后一次心跳，仅当state="在线"有值。 | | monopolize_time | String | 独占的时间。 | | last_dial_time | String | 最后一次切换的时间。 | ## ResourceAreaISPWithIdle 地区和运营商可用独占资源统计 被如下接口引用：[独享代理资源地区查询](https://www.qg.net/doc/1845.html)。 | 名称 | 类型 | 描述 | | --------- | ------- | ------------ | | area | String | 地区信息。 | | area_code | Integer | 地区码。 | | isp | String | 运营商信息。 | | isp_code | Integer | 运营商编码。 | | idle | Integer | 空闲资源数。 |

## 功能说明 如果接口返回结果中存在 error 字段，则表示调用 API 接口失败。例如： ```json {     "code": "NO_RESOURCE_FOUND",     "message": "资源不足",     "request_id": "83158ebe-be6c-40f7-a158-688741083edc" } ``` ## 错误码列表 | 错误码 | 描述 | | ---------------------------- | -------------------------------------------------------- | | 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 | 请求频率超出限制。 | | BALANCE_INSUFFICIENT | Key余额不足。 | | NO_AVAILABLE_CHANNEL | 没有可用的空闲通道。 | | NO_RESOURCE_FOUND | 资源不足。 | | FAILED_OPERATION | 提取失败。 | | EXTRACT_LIMIT_EXCEEDED | 超出提取配额。 | | DELETE_LIMIT_EXCEEDED | 释放频率超出限制。 | | IP_WHITELIST_LIMIT_EXCEEDED | 白名单数量超出限制。 | | STATIC_DELETE_TIME_LIMIT | 静态资源需要24小时后才能释放。 | | MONOPOLY_DELETE_TIME_LIMIT | 独占资源需要12小时后才能释放。 | | MONOPOLY_CHANGEIP_TIME_LIMIT | 独占资源切换IP需要等待10秒。 |

## 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的白名单 |

## 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 | 请求频率超出限制。 |

## 1. 接口描述 接口请求域名： overseas.proxy.qg.net。 本接口 (/query) 用于全球HTTP-短效代理产品通道提取模式下查询在用的IP资源的接口。 默认接口请求频率限制：60/分钟。 推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html?type=5-2)。 ## 2. 输入参数 | 参数名称 | 必选 | 类型 | 描述 | | -------- | ---- | ------ | ------------------------ | | key | 是 | String | 公共参数，产品唯一标识。 | ## 3. 输出参数 | 参数名称 | 类型 | 描述 | | ---------- | ----------------------------------------------- | ------------------------------------------------------------ | | code | String | 请求状态码。 | | data | Array of [IP](https://www.qg.net/doc/1839.html) | IP资源列表。 | | request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 | ## 4. 示例 #### 输入示例 ``` GET https://overseas.proxy.qg.net/query?key=<您的key信息>&<其他输入参数> ``` #### 输出示例 ```json { "code": "SUCCESS", "data": [{ "proxy_ip": "129.150.42.240", "server": "129.150.42.240:18080", "area": "新加坡", "deadline": "2023-02-25 15:38:36" }], "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. 接口描述 接口请求域名： 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 说明 通过编码使用短效代理（全球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的白名单 |

## 1. 接口描述 接口请求域名： overseas.proxy.qg.net。 本接口 (/query) 用于全球HTTP-短效代理产品按量提取模式下查询在用的IP资源的接口。 默认接口请求频率限制：60/分钟。 推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html?type=5-2)。 ## 2. 输入参数 | 参数名称 | 必选 | 类型 | 描述 | | -------- | ---- | ------ | ------------------------ | | key | 是 | String | 公共参数，产品唯一标识。 | ## 3. 输出参数 | 参数名称 | 类型 | 描述 | | ---------- | ----------------------------------------------- | ------------------------------------------------------------ | | code | String | 请求状态码。 | | data | Array of [IP](https://www.qg.net/doc/1839.html) | IP资源列表。 | | request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 | ## 4. 示例 #### 输入示例 ``` GET https://overseas.proxy.qg.net/query?key=<您的key信息>&<其他输入参数> ``` #### 输出示例 ```json { "code": "SUCCESS", "data": [{ "proxy_ip": "129.150.42.240", "server": "129.150.42.240:18080", "area": "新加坡", "deadline": "2023-02-25 15:38:36" }], "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 | 请求频率超出限制。 |