## 1. 接口描述 接口请求域名： overseas.proxy.qg.net。 本接口 (/get) 用于全球HTTP-短效代理产品通道提取模式下提取IP的接口。 默认接口请求频率限制：（通道数*5+10）次/分钟。 推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html?type=5-2)。 需注意，如使用白名单IP，请在提取前添加白名单。 ## 2. 输入参数 | 参数名称 | 必选 | 类型 | 描述 | | -------- | ---- | ------- | ------------------------------------------------------------ | | key | 是 | String | 公共参数，产品唯一标识。 | | area | 否 | String | 国家筛选。支持国家编码和自定义编码，比如：US,EU，或者990100,990200。[国家编码](https://www.qg.net/doc/use/8_234_201/1975.html) | | area_ex | 否 | String | 排除某些地区提取。使用方式同上 | | num | 否 | Integer | 提取个数，默认为1 | ## 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/get?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 | 请求频率超出限制。 | | BALANCE_INSUFFICIENT | Key余额不足。 | | NO_RESOURCE_FOUND | 资源不足。 | | FAILED_OPERATION | 提取失败。 | | EXTRACT_LIMIT_EXCEEDED | 超出提取配额。 |
```c# string targetUrl = "https://api.ipify.org"; string proxyIp = "您的代理IP"; string proxyPort = "端口号"; string authKey = "请改成您的Key"; string password = "请改成您的AuthPwd"; WebProxy proxy = new WebProxy(string.Format("{0}:{1}", proxyIp, proxyPort), true); proxy.Credentials = new NetworkCredential(authKey, password); ServicePointManager.Expect100Continue = false; var request = WebRequest.Create(targetUrl) as HttpWebRequest; request.AllowAutoRedirect = true; request.KeepAlive = true; request.Method = "GET"; request.Proxy = proxy; request.Timeout = 10000; request.ServicePoint.ConnectionLimit = 16; using (var resp = request.GetResponse() as HttpWebResponse) using (var reader = new StreamReader(resp.GetResponseStream(), Encoding.UTF8)){ string htmlStr = reader.ReadToEnd(); } ```
## 概述
购买完代理产品后，用户在使用代理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. |
**简要描述：** - 获取规格信息 **输入示例：** - https://qg.net/api/Proxyip/PackageList **返回示例** JSON格式 ``` { "RequestId":"ASDF4ASF-ASDFASF", "Code": 200, "Data": { "1":{ "Id": 2, "Type_name": "共享动态1-5分钟", "Type": 2, "Ip_type": 2, "Bandwidthlimit_down": 2, "Bandwidthlimit_up": 2, "Brand_name": "青果云", "Alivetime": "5分钟" } }， "Message":"获取成功" } ``` **返回参数说明** |参数名|类型|说明| |:----- |:-----|----- | |RequestId |string |请求编号 | |Code |integer |返回状态码 | |Message |string |返回内容 | |Id |integer |ID | |Type_name |string |规格名称 | |Type |integer |资源类型 1：独享；2：共享 | |Ip_type |integer |IP类型 1：静态；2：动态; 3: 隧道 | |Alivetime |integer |存活周期，单位为分钟，格式为1-5，表示最小存活周期为1分钟，最大存活周期为5分钟；IP类型为隧道时，该参数类型分别为1：每次请求换IP，2：固定时长 | |Bandwidthlimit_down |integer |下行带宽限制 | |Bandwidthlimit_up |integer |上行带宽限制 | |Brand_name |integer |品牌名称 | **备注** - 更多返回错误代码请看首页的错误代码描述
**简要描述：**
- 业务购买询价
**输入参数：**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|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 |应付价格| |
**备注：**
更多返回错误代码请看首页的错误代码描述。
<p>所有可以购买的产品范围和产品本身没有区别；</p> <p>通过我司购买的产品依然可在官网查询，但在享受官网服务同时还可额外享受我司提供的服务，例如活动优惠提醒，上云指导等。</p>
青果为有经验的开发者提供多种API接口及代码示例，以协助开发者更便利地使用代理。 本篇仅以【提取IP】这一操作为例，介绍如何使用API接口-代码方式来使用代理。 ## 步骤总览  ## 一、获取api接口 青果给开发者提供两种方式来获得api接口 ① 使用调试工具/提取工具 调试工具是青果为开发者推出的快速获取接口&调试的简便工具，传送门[＞＞调试工具](https://www.qg.net/tools/IPdebug.html) 使用调试工具，用户需要先在左侧栏目中选好产品及接口类型，并在右侧表格的参数值列中填写所需信息，便可在页面上方看到完整的【请求地址】，这便是提取IP的API接口。 点击【发送】还能快速调试，查看响应结果，确认该代理接口是否可用。  调试工具除了有提取IP接口，还提供查询在用IP、资源池、资源地区等接口。 若只需要提取IP，也可以使用提取工具，进行简单的选择便可以获取一样的接口链接。传送门[＞＞提取工具 ](https://www.qg.net/tools/IPget.html)  ② 查看api接口文档 除了简便工具，开发者也可以通过更原始的接口文档，自主编写所需的接口链接。 **[点击查看API接口文档 ＞](https://www.qg.net/doc/product/6_258_274/2143.html)** ## 二、授权验证 正式使用代理之前，还需要通过授权验证。青果代理IP支持白名单和帐密两种验证方式，可自主选择使用。 白名单模式，即把要实现代理的服务器IP添加进代理白名单中，后续使用该IP连接代理就能成功； 账密模式，即先获取该代理业务的账号密码信息，连接代理时填入账密进行验证就可使用代理。  详细步骤可查看＞[代理验证](https://www.qg.net/doc/use/8_244/1574.html) ## 三、代理测试 在代理服务器中打开命令行，输入相应的代理信息进行运行，若响应成功，则代理可用。 以下图为例，通过curl命令测试账密模式的代理结果，查询IP并成功响应。 `curl -x http://{authkey}:{authpwd}@{118.92.69.112}:{32105} {targetUrl}`  若响应不成功，可对应[错误码表](https://www.qg.net/doc/1838.html)，排查问题。 ## 四、编写采集程序 测试代理可用后，便可开始编写代理采集程序了。 青果提供了多种编程语言的代码示例以及SDK下载包供开发者参考， 详情查看 - [SDK下载](https://www.qg.net/doc/sdk/9_230/1745.html) - [C语言代码示例](https://www.qg.net/doc/sdk/9_230/1694.html) - [Go语言代码示例](https://www.qg.net/doc/sdk/9_230/1695.html) - [PHP语言代码示例](https://www.qg.net/doc/sdk/9_230/1696.html) - [Python语言代码示例](https://www.qg.net/doc/sdk/9_230/1697.html) - [Java语言代码示例](https://www.qg.net/doc/sdk/9_230/1698.html) - [Shell语言代码示例](https://www.qg.net/doc/sdk/9_230/1699.html) - [C#语言代码示例](https://www.qg.net/doc/sdk/9_230/1700.html) - [Node语言代码示例](https://www.qg.net/doc/sdk/9_230/1701.html) **注：**青果代理IP产品都有相对应的IP存活周期，其有效时长是从提取到IP时算起，超过这个时长IP会失效。
## 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)
## 1 接口描述 接口地址： https://proxy.qg.net/monopolies 本接口是根据key查询用户已占用到且可用的独占资源列表。 请求频率限制：60次/分钟； 方法：GET； 编码：参数和返回内容均采用utf-8编码。 ## 2 输入参数说明 | 参数名 | 是否必选 | 类型 | 描述 | | :----- | :------- | :----- | :----------------------------: | | Key | 是 | String | 查询独占资源的Key值； | | UUIDs | 否 | String | 独占资源编号，多个用逗号隔开。 | ## 3 返回值 接口可返回文本格式、json格式、xml格式，字段说明如下： | 返回字段 | 类型 | 描述 | | :------- | :----- | :----------: | | data | Array | 独占资源列表 | | error | String | 错误信息 | ## 4 示例 请求接口示例： ``` curl "https://proxy.qg.net/monopolies?Key=请改成您的Key&UUIDs=XXX,XXX" ``` 返回示例： ``` { "data": [{ "uuid": "fj_qzdx9-1:ppp10", "area": "福建省泉州市", "isp": "电信", "state": "在线", //分成在线、离线、重拨中、排队中(等待秒数X) "monopolize_time": "2022-02-17 14:01:05", //独占时间 "last_dial_time": "2022-02-17 14:01:05", //最近一次拨号时间 "ip": "127.0.0.1:10800", //当前IP，状态为在线时才有此数据 "heartbeat": "2022-02-17 14:01:05", //最后一次心跳，状态为在线时才有此数据 },{ ... }] } ``` ## 5 接口返回错误码 | 错误码 | 描述 | | :----: | :------: | | 200 | 查询成功 | | 500 | 未知错误 |
本文将针对傲游浏览器如何使用代理IP进行详细说明，具体步骤如下： ## 1 查看IP密钥 在【代理ip】-【按时业务/按量业务】里查看自己购买的代理ip，然后点击【查看详情】查看自己的代理IP业务信息（AuthKey和AuthPwd），具体如下图;   ## 2 提取代理IP 使用自己购买的AuthKey去【调试工具】里面选择【提取IP资源】获取ip，如下图：   ## 3 浏览器设置代理 ### 3.1 遨游浏览器设置代理 步骤如下： 打开傲游浏览器，点击右上角的菜单，再点击【设置】并在搜索栏里面输入【代理】进行搜索，如下图：   打开的设置页面中选择【使用自定义代理设置】然后点击【添加】；  在弹出的窗口输入【名称】，然后需要选择代理的类型，类型包括（http、https、socks模式），然后输入代理的【地址】跟【端口】，然后输入【用户名】和【密码】（用户名就是AuthKey，密码就是AuthPwd），输入完成后点击【确定】即可。  添加完成后选择刚刚添加的代理，点击【启用】即完成遨游浏览器的代理设置；  ### 3.2 设置成功验证 使用傲游浏览器打开浏览器打开https://www.baidu.com/s?word=ip ，查看ip是否和设置的代理ip相同，相同则为设置成功；  ### 3.3 取消代理设置 取消代理的话，直接在设置里面点击【不使用代理】即可取消掉。 
