短效代理-弹性提取-查询余额接口
## 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 | 请求频率超出限制。 |
隧道代理(全球HTTP)-住宅池
**全球HTTP均不支持在中国大陆地区网络环境下使用**。
#### 一、介绍
青果住宅池IP资源,是由来自全球200+国家地区的大量分散的真实住宅网络汇聚而成,日去重数达2000W+。
住宅IP,是由当地互联网服务提供商(ISP)分配给家庭/企业用户的IP,在IP的所属ASN信息上type类型表现为isp。
住宅池IP的特性表现为具有很高的匿名性,能够模拟真实用户行为场景,满足更高的安全代理要求,业务成功率高。

#### 二、资源池特点
相比于数据中心池,住宅池
- 青果提供的资源数量更多,适合企业级采集项目
- 匿名性相对较高,业务成功率高
- 稳定性相对较弱
#### 三、使用客户群
- 有大量IP使用需求的客户
- 对采集成功率要求高的客户
[开始选用【住宅池】套餐>](https://www.qg.net/business/proxyip.html?region=overseas&product_type=3&pool_type=12)
短效代理(全球HTTP)-通道提取
选择通道提取方式,意味着业务有效期内可同时在线使用的IP数是固定的,但不限制流量使用。
每个通道在某个时刻可以使用一个IP。当这个IP的存活时长结束之后,通道可以提取一个新的IP来替代。如果你购买了多个通道,你可以在任何一个IP到期后重新提取新的IP,直到你正在使用的IP数量与你购买的通道数量相匹配为止。
通道提取提供多种的IP存活周期可选,可以选择短时间的5分钟/15分钟/30分钟/1小时,也可以选择长时的24小时/720小时,最长可以保持30天。
**注:**IP的存活周期是从提取到IP的那一刻开始算起的,超过这个时长IP会自动失效释放。

#### 二、计费方式:
按同时在线的IP数(即通道数)计费,通道数的可选区间是1-1000个。
具体的产品套餐价格,还与购买时长、IP存活时长相关,请以购买页为准。
#### 三、适用场景:
1. 流量使用较大的场景
2. 每天业务不间断的场景
[开始选用【通道提取】套餐>](https://www.qg.net/business/proxyip.html?region=overseas&product_type=1&extract_mode=1)
短效代理-通道提取
## 一、提取方式介绍:
选择通道提取方式,意味着业务有效期内可同时在线使用的IP数是固定的。
每个通道在某个时刻可以使用一个IP。当这个IP的存活时长结束之后,通道可以提取一个新的IP来替代。如果你购买了多个通道,你可以在任何一个IP到期后重新提取新的IP,直到你正在使用的IP数量与你购买的通道数量相匹配为止。
通道提取提供较多的IP存活周期可选,包含1分钟/2分钟/3分钟/5分钟/1-5分钟/5-15分钟/15-30分钟,7种时长规格可选。
**注:**IP的存活周期是从提取到IP的那一刻开始算起的,超过这个时长IP会自动失效释放。

## 二、计费方式:
按同时在线的IP数(即通道数)计费,通道数的可选区间是1-1000个。
具体的产品套餐价格,还与选择的资源池、购买时长、IP存活时长相关,请以购买页为准。
## 三、适用场景:
1. IP使用量固定的业务场景
2. 每天业务不间断的场景
[开始选用【通道提取】套餐>](https://www.qg.net/business/proxyip.html?region=domestic&product_type=1&extract_mode=1)
短效代理-均匀提取
## 一、提取方式介绍:
选择均匀提取方式,则用户每分钟能提取到的IP数是固定的。每分钟都能提取到IP,但可提取到的IP数有限。
假设选择的套餐是每分钟10个IP,IP存活时长为2分钟,每分钟都把10个IP提取出来的话,那么第一分钟有10个IP可用,第二分钟也有10+10个IP可用,第三分钟时第一分钟提取的IP失效,仍有20个IP可用,以此类推。
均匀提取的单次提取的上限是100个IP。
**注:**均匀提取所指的“每分钟提取”指的是自然分钟。
IP的存活周期是从提取到IP的那一刻开始算起的,超过这个时长IP会自动失效释放。

## 二、计费方式:
按每分钟提取的IP数计费,每分钟IP数量的可选区间是2-2000个。
具体的产品套餐价格,还与选择的资源池、购买时长、IP存活时长相关,请以购买页为准。
## 三、适用场景:
1. 每小时都需要使用IP的客户
2. 每天24小时不间断运行的程序
[开始选用【均匀提取】套餐>](https://www.qg.net/business/proxyip.html?region=domestic&product_type=1&extract_mode=3)
短效代理-弹性提取
## 一、提取方式介绍:
选择弹性提取方式,意味着用户在业务有效期内,每天可以提取的IP总数是固定的,但时间段不固定。
用户可以自主安排在哪个时段提取使用IP,是集中短时间内提取完,或者分多次提取都可以(单次提取的上限是100个IP)。直到当天的量提取完后,就不能继续提取。等到第二天0点,就会恢复新一天的可提取IP额度。
**注:**IP的存活周期是从提取到IP的那一刻开始算起的,超过这个时长IP会自动失效释放。

## 二、计费方式:
按每天提取的IP数计费,每天IP量可选区间为100-2000000个。
具体的产品套餐价格,还与选择的资源池、购买时长、IP存活时长相关,请以购买页为准。
## 三、适用场景:
1. 在每天某个时间段集中使用IP的场景
2. 每天不定期、不规律使用IP的场景
[开始选用【弹性提取】套餐>](https://www.qg.net/business/proxyip.html?region=domestic&product_type=1&extract_mode=4)
查询按量产品列表
**简要描述:**
- 获取按量产品列表信息
**输入示例:**
- 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 |连接数可选值|
**备注**
- 更多返回错误代码请看首页的错误代码描述
短效代理-中转池
## 一、介绍
中转池,由大量的边缘节点汇聚而成,其基于的青果自营高性能代理服务器,通过中转+多线快速转发技术,代理更加高速稳定。
选择中转池的业务,用户提取到的IP将经过一层转发,以另外一个出口IP进行公网访问。出口IP是真实IP,且因为资源来自于大量边缘节点,中转池IP资源丰富且分散,业务成功率高。
中转池拥有400W+纯净IP,日去重IP达220W+,可选城市更多。
#### 示例
以下是中转池产品,提取IP接口的响应情况,可以看到
真实访问地址“proxy_ip“与代理服务地址”server“的地址不一样的两个IP。

## 二、资源池特点
相比与直连池,中转池
- 流水更丰富
- IP段更分散
- 业务成功率更高
## 三、适合客户群
- 有大量IP使用需求的客户
- 对采集成功率要求高的客户
海外区域编码
|国家编码|国家中文|国家英文|青果编码|
|:---- |:---|:----- |:----- |
|AD|安道尔|Andorra|993000|
|AE|阿拉伯联合酋长国|United Arab Emirates|993400|
|AF|阿富汗|Afghanistan|994000|
|AG|安提瓜和巴布达|Antigua and Barbuda|994100|
|AI|安圭拉|Anguilla|994200|
|AL|阿尔巴尼亚|Albania|994300|
|AM|亚美尼亚|Armenia|994400|
|AO|安哥拉|Angola|994500|
|AR|阿根廷|Argentina|994600|
|AS|美属萨摩亚|American Samoa|994700|
|AT|奥地利|Austria|994800|
|AU|澳大利亚|Australia|991000|
|AW|阿鲁巴|Aruba|994900|
|AZ|阿塞拜疆|Azerbaijan|995000|
|BA|波斯尼亚和黑塞哥维那|Bosnia and Herzegovina|995100|
|BB|巴巴多斯|Barbados|995200|
|BD|孟加拉国|Bangladesh|995300|
|BE|比利时|Belgium|992000|
|BF|布基纳法索|Burkina Faso|995400|
|BG|保加利亚|Bulgaria|995500|
|BH|巴林|Bahrain|992900|
|BI|布隆迪|Burundi|995600|
|BJ|贝宁|Benin|995700|
|BL|巴勒斯坦|Palestine|995800|
|BM|百慕大群岛|Bermuda|995900|
|BN|文莱|Brunei|996000|
|BO|玻利维亚|Bolivia|996100|
|BR|巴西|Brazil|992400|
|BS|巴哈马|Bahamas|996200|
|BT|不丹|Bhutan|996300|
|BW|博茨瓦纳|Botswana|996400|
|BY|白俄罗斯|Belarus|996500|
|BZ|伯利兹|Belize|996600|
|CA|加拿大|Canada|992300|
|CD|刚果民主共和国|Democratic Republic of the Congo|996700|
|CF|中非共和国|Central African Republic|996800|
|CG|刚果共和国|Republic Of The Congo|996900|
|CH|瑞士|Switzerland|991200|
|CI|象牙海岸|Ivory Coast|997000|
|CK|库克群岛|Cook Islands|997100|
|CL|智利|Chile|993700|
|CM|喀麦隆|Cameroon|997200|
|CO|哥伦比亚|Colombia|997300|
|CR|哥斯达黎加|Costa Rica|997400|
|CU|古巴|Cuba|997500|
|CV|开普|Cape Verde|997600|
|CW|库拉索|Curacao|997700|
|CY|塞浦路斯|Cyprus|997800|
|CZ|捷克|Czech|997900|
|DE|德国|Germany|991900|
|DJ|吉布提|Djibouti|998000|
|DK|丹麦|Denmark|998100|
|DM|多米尼加|Dominica|998200|
|DO|多米尼加共和国|Dominican Republic|998300|
|DZ|阿尔及利亚|Algeria|998400|
|EC|厄瓜多尔|Ecuador|998500|
|EE|爱沙尼亚|Estonia|998600|
|EG|埃及|Egypt|998700|
|ER|厄立特里亚|Eritrea|998800|
|ES|西班牙|Spain|993500|
|ET|埃塞俄比亚|Ethiopia|998900|
|FI|芬兰|Finland|991700|
|FJ|斐济|Fiji|999000|
|FO|法罗群岛|Faroe Islands|999100|
|FR|法国|France|991800|
|GA|加蓬|Gabon|999200|
|GB|英国|United Kingdom|991100|
|GD|格林纳达|Grenada|999300|
|GE|格鲁吉亚|Georgia|999400|
|GF|法属圭亚那|French Guiana|999500|
|GH|加纳|Ghana|999600|
|GI|直布罗陀|Gibraltar|999700|
|GL|格陵兰岛|Greenland|999800|
|GM|冈比亚|Gambia|999900|
|GN|几内亚|Guinea|980100|
|GP|瓜德罗普岛|Guadeloupe|980200|
|GQ|赤道几内亚|Equatorial Guinea|980300|
|GR|希腊|Greece|980400|
|GT|瓜地马拉|Guatemala|980500|
|GU|关岛|Guam|980600|
|GW|几内亚比绍共和国|Guinea-Bissau|980700|
|GY|圭亚那|Guyana|980800|
|HK|中国香港|Hong Kong|990201|
|HN|洪都拉斯|Honduras|980900|
|HR|克罗地亚|Croatia|981000|
|HT|海地|Haiti|981100|
|HU|匈牙利|Hungary|981200|
|ID|印度尼西亚|Indonesia|990600|
|IE|爱尔兰|Ireland|992100|
|IL|以色列|Israel|993600|
|IN|印度|India|992200|
|IQ|伊拉克|Iraq|981300|
|IR|伊朗|Iran|981400|
|IS|冰岛|Iceland|981500|
|IT|意大利|Italy|991500|
|JM|牙买加|Jamaica|981600|
|JO|约旦|Jordan|981700|
|JP|日本|Japan|990400|
|KE|肯尼亚|Kenya|981800|
|KG|吉尔吉斯斯坦|Kyrgyzstan|981900|
|KH|柬埔寨|Cambodia|982000|
|KI|基里巴斯|Kiribati|982100|
|KM|科摩罗|Comoros|982200|
|KN|圣基茨和尼维斯|Saint Kitts and Nevis|982300|
|KR|韩国|South Korea|990800|
|KW|科威特|Kuwait|982400|
|KY|开曼群岛|Cayman Islands|982500|
|KZ|哈萨克斯坦|Kazakhstan|982600|
|LA|老挝|Laos|982700|
|LB|黎巴嫩|Lebanon|982800|
|LC|圣露西亚|Saint Lucia|982900|
|LI|列支敦士登|Liechtenstein|983000|
|LK|斯里兰卡|Sri Lanka|983100|
|LR|利比里亚|Liberia|983200|
|LS|莱索托|Lesotho|983300|
|LT|立陶宛|Lithuania|983400|
|LU|卢森堡|Luxembourg|983500|
|LV|拉脱维亚|Latvia|983600|
|LY|利比亚|Libya|983700|
|MA|摩洛哥|Morocco|983800|
|MC|摩纳哥|Monaco|983900|
|MD|摩尔多瓦|Moldova|984000|
|ME|黑山|Montenegro|984100|
|MG|马达加斯加|Madagascar|984200|
|MK|马其顿|Macedonia|984300|
|ML|马里|Mali|984400|
|MM|缅甸|Myanmar|984500|
|MN|蒙古|Mongolia|984600|
|MO|中国澳门|Macau|990202|
|MQ|马提尼克|Martinique|984700|
|MR|毛里塔尼亚|Mauritania|984800|
|MS|蒙特塞拉特岛|Montserrat|984900|
|MT|马耳他|Malta|985000|
|MU|毛里求斯|Mauritius|985100|
|MV|马尔代夫|Maldives|985200|
|MW|马拉维|Malawi|985300|
|MX|墨西哥|Mexico|992700|
|MY|马来西亚|Malaysia|990700|
|MZ|莫桑比克|Mozambique|985400|
|NA|纳米比亚|Namibia|985500|
|NC|新喀里多尼亚|New Caledonia|985600|
|NE|尼日尔|Niger|985700|
|NG|尼日利亚|Nigeria|992800|
|NI|尼加拉瓜|Nicaragua|985800|
|NL|荷兰|Netherlands|991600|
|NO|挪威|Norway|991400|
|NP|尼泊尔|Nepal|985900|
|NZ|新西兰|New Zealand|986000|
|OM|阿曼|Oman|986100|
|PA|巴拿马|Panama|986200|
|PE|秘鲁|Peru|986300|
|PF|法属波利尼西亚|French Polynesia|986400|
|PG|巴布亚新几内亚|Papua New Guinea|986500|
|PH|菲律宾|Philippines|990900|
|PK|巴基斯坦|Pakistan|986600|
|PL|波兰|Poland|993300|
|PM|圣彼埃尔和密克隆岛|Saint Pierre and Miquelon|986700|
|PR|波多黎各|Puerto Rico|986800|
|PT|葡萄牙|Portugal|986900|
|PW|帕劳|Palau|987000|
|PY|巴拉圭|Paraguay|987100|
|QA|卡塔尔|Qatar|993900|
|RE|留尼汪|Réunion Island|987200|
|RO|罗马尼亚|Romania|987300|
|RS|塞尔维亚|Serbia|987400|
|RU|俄罗斯|Russia|992600|
|RW|卢旺达|Rwanda|987500|
|SA|沙特阿拉伯|Saudi Arabia|993100|
|SB|所罗门群岛|Solomon Islands|987600|
|SC|塞舌尔|Seychelles|987700|
|SD|苏丹|Sudan|987800|
|SE|瑞典|Sweden|991300|
|SG|新加坡|Singapore|990300|
|SI|斯洛文尼亚|Slovenia|987900|
|SK|斯洛伐克|Slovakia|988000|
|SL|塞拉利昂|Sierra Leone|988100|
|SM|圣马力诺|San Marino|988200|
|SN|塞内加尔|Senegal|988300|
|SO|索马里|Somalia|988400|
|SR|苏里南|Suriname|988500|
|ST|圣多美和普林西比|Sao Tome and Principe|988600|
|SV|萨尔瓦多|El Salvador|988700|
|SX|圣马丁岛(荷兰部分)|Saint Maarten (Dutch Part)|988800|
|SY|叙利亚|Syria|988900|
|SZ|斯威士兰|Swaziland|989000|
|TC|特克斯和凯科斯群岛|Turks and Caicos Islands|989100|
|TD|乍得|Chad|989200|
|TG|多哥|Togo|989300|
|TH|泰国|Thailand|990500|
|TJ|塔吉克斯坦|Tajikistan|989400|
|TL|东帝汶|Timor-Leste|989500|
|TM|土库曼斯坦|Turkmenistan|989600|
|TN|突尼斯|Tunisia|989700|
|TO|汤加|Tonga|989800|
|TR|土耳其|Turkey|993800|
|TT|特立尼达和多巴哥|Trinidad and Tobago|989900|
|TW|中国台湾|Taiwan|990203|
|TZ|坦桑尼亚|Tanzania|970100|
|UA|乌克兰|Ukraine|970200|
|UG|乌干达|Uganda|970300|
|US|美国|United States|990100|
|UY|乌拉圭|Uruguay|970400|
|UZ|乌兹别克斯坦|Uzbekistan|970500|
|VC|圣文森特和格林纳丁斯|Saint Vincent and The Grenadines|970600|
|VE|委内瑞拉|Venezuela|970700|
|VG|英属处女群岛|Virgin Islands, British|970800|
|VI|美属维尔京群岛|Virgin Islands, US|970900|
|VN|越南|Vietnam|993200|
|VU|瓦努阿图|Vanuatu|971000|
|WS|萨摩亚|Samoa|971100|
|YE|也门|Yemen|971200|
|YT|马约特|Mayotte|971300|
|ZA|南非|South Africa|992500|
|ZM|赞比亚|Zambia|971400|
|ZW|津巴布韦|Zimbabwe|971500|