文档中心

## 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均不支持在中国大陆地区网络环境下使用**。 #### 一、介绍 青果住宅池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)

选择通道提取方式，意味着业务有效期内可同时在线使用的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数有限。 假设选择的套餐是每分钟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 |连接数可选值| **备注** - 更多返回错误代码请看首页的错误代码描述

|编号|区域| |:---- |:---|:----- |----- | |110000|北京市 |110100|市辖区 |120000|天津市 |120100|市辖区 |130000|河北省 |130100|石家庄市 |130200|唐山市 |130300|秦皇岛市 |130400|邯郸市 |130500|邢台市 |130600|保定市 |130700|张家口市 |130800|承德市 |130900|沧州市 |131000|廊坊市 |131100|衡水市 |140000|山西省 |140100|太原市 |140200|大同市 |140300|阳泉市 |140400|长治市 |140500|晋城市 |140600|朔州市 |140700|晋中市 |140800|运城市 |140900|忻州市 |141000|临汾市 |141100|吕梁市 |150000|内蒙古自治区 |150100|呼和浩特市 |150200|包头市 |150300|乌海市 |150400|赤峰市 |150500|通辽市 |150600|鄂尔多斯市 |150700|呼伦贝尔市 |150800|巴彦淖尔市 |150900|乌兰察布市 |152200|兴安盟 |152500|锡林郭勒盟 |152900|阿拉善盟 |210000|辽宁省 |210100|沈阳市 |210200|大连市 |210300|鞍山市 |210400|抚顺市 |210500|本溪市 |210600|丹东市 |210700|锦州市 |210800|营口市 |210900|阜新市 |211000|辽阳市 |211100|盘锦市 |211200|铁岭市 |211300|朝阳市 |211400|葫芦岛市 |220000|吉林省 |220100|长春市 |220200|吉林市 |220300|四平市 |220400|辽源市 |220500|通化市 |220600|白山市 |220700|松原市 |220800|白城市 |222400|延边朝鲜族自治州 |230000|黑龙江省 |230100|哈尔滨市 |230200|齐齐哈尔市 |230300|鸡西市 |230400|鹤岗市 |230500|双鸭山市 |230600|大庆市 |230700|伊春市 |230800|佳木斯市 |230900|七台河市 |231000|牡丹江市 |231100|黑河市 |231200|绥化市 |232700|大兴安岭地区 |310000|上海市 |310100|市辖区 |320000|江苏省 |320100|南京市 |320200|无锡市 |320300|徐州市 |320400|常州市 |320500|苏州市 |320600|南通市 |320700|连云港市 |320800|淮安市 |320900|盐城市 |321000|扬州市 |321100|镇江市 |321200|泰州市 |321300|宿迁市 |330000|浙江省 |330100|杭州市 |330200|宁波市 |330300|温州市 |330400|嘉兴市 |330500|湖州市 |330600|绍兴市 |330700|金华市 |330800|衢州市 |330900|舟山市 |331000|台州市 |331100|丽水市 |340000|安徽省 |340100|合肥市 |340200|芜湖市 |340300|蚌埠市 |340400|淮南市 |340500|马鞍山市 |340600|淮北市 |340700|铜陵市 |340800|安庆市 |341000|黄山市 |341100|滁州市 |341200|阜阳市 |341300|宿州市 |341500|六安市 |341600|亳州市 |341700|池州市 |341800|宣城市 |350000|福建省 |350100|福州市 |350200|厦门市 |350300|莆田市 |350400|三明市 |350500|泉州市 |350600|漳州市 |350700|南平市 |350800|龙岩市 |350900|宁德市 |360000|江西省 |360100|南昌市 |360200|景德镇市 |360300|萍乡市 |360400|九江市 |360500|新余市 |360600|鹰潭市 |360700|赣州市 |360800|吉安市 |360900|宜春市 |361000|抚州市 |361100|上饶市 |370000|山东省 |370100|济南市 |370200|青岛市 |370300|淄博市 |370400|枣庄市 |370500|东营市 |370600|烟台市 |370700|潍坊市 |370800|济宁市 |370900|泰安市 |371000|威海市 |371100|日照市 |371300|临沂市 |371400|德州市 |371500|聊城市 |371600|滨州市 |371700|菏泽市 |410000|河南省 |410100|郑州市 |410200|开封市 |410300|洛阳市 |410400|平顶山市 |410500|安阳市 |410600|鹤壁市 |410700|新乡市 |410800|焦作市 |410900|濮阳市 |411000|许昌市 |411100|漯河市 |411200|三门峡市 |411300|南阳市 |411400|商丘市 |411500|信阳市 |411600|周口市 |411700|驻马店市 |419000|省直辖县级行政区划 |420000|湖北省 |420100|武汉市 |420200|黄石市 |420300|十堰市 |420500|宜昌市 |420600|襄阳市 |420700|鄂州市 |420800|荆门市 |420900|孝感市 |421000|荆州市 |421100|黄冈市 |421200|咸宁市 |421300|随州市 |422800|恩施土家族苗族自治州 |429000|省直辖县级行政区划 |430000|湖南省 |430100|长沙市 |430200|株洲市 |430300|湘潭市 |430400|衡阳市 |430500|邵阳市 |430600|岳阳市 |430700|常德市 |430800|张家界市 |430900|益阳市 |431000|郴州市 |431100|永州市 |431200|怀化市 |431300|娄底市 |433100|湘西土家族苗族自治州 |440000|广东省 |440100|广州市 |440200|韶关市 |440300|深圳市 |440400|珠海市 |440500|汕头市 |440600|佛山市 |440700|江门市 |440800|湛江市 |440900|茂名市 |441200|肇庆市 |441300|惠州市 |441400|梅州市 |441500|汕尾市 |441600|河源市 |441700|阳江市 |441800|清远市 |441900|东莞市 |442000|中山市 |445100|潮州市 |445200|揭阳市 |445300|云浮市 |450000|广西壮族自治区 |450100|南宁市 |450200|柳州市 |450300|桂林市 |450400|梧州市 |450500|北海市 |450600|防城港市 |450700|钦州市 |450800|贵港市 |450900|玉林市 |451000|百色市 |451100|贺州市 |451200|河池市 |451300|来宾市 |451400|崇左市 |460000|海南省 |460100|海口市 |460200|三亚市 |460300|三沙市 |460400|儋州市 |469000|省直辖县级行政区划 |500000|重庆市 |500100|市辖区 |500200|县 |510000|四川省 |510100|成都市 |510300|自贡市 |510400|攀枝花市 |510500|泸州市 |510600|德阳市 |510700|绵阳市 |510800|广元市 |510900|遂宁市 |511000|内江市 |511100|乐山市 |511300|南充市 |511400|眉山市 |511500|宜宾市 |511600|广安市 |511700|达州市 |511800|雅安市 |511900|巴中市 |512000|资阳市 |513200|阿坝藏族羌族自治州 |513300|甘孜藏族自治州 |513400|凉山彝族自治州 |520000|贵州省 |520100|贵阳市 |520200|六盘水市 |520300|遵义市 |520400|安顺市 |520500|毕节市 |520600|铜仁市 |522300|黔西南布依族苗族自治州 |522600|黔东南苗族侗族自治州 |522700|黔南布依族苗族自治州 |530000|云南省 |530100|昆明市 |530300|曲靖市 |530400|玉溪市 |530500|保山市 |530600|昭通市 |530700|丽江市 |530800|普洱市 |530900|临沧市 |532300|楚雄彝族自治州 |532500|红河哈尼族彝族自治州 |532600|文山壮族苗族自治州 |532800|西双版纳傣族自治州 |532900|大理白族自治州 |533100|德宏傣族景颇族自治州 |533300|怒江傈僳族自治州 |533400|迪庆藏族自治州 |540000|西藏自治区 |540100|拉萨市 |540200|日喀则市 |540300|昌都市 |540400|林芝市 |540500|山南市 |540600|那曲市 |542500|阿里地区 |610000|陕西省 |610100|西安市 |610200|铜川市 |610300|宝鸡市 |610400|咸阳市 |610500|渭南市 |610600|延安市 |610700|汉中市 |610800|榆林市 |610900|安康市 |611000|商洛市 |620000|甘肃省 |620100|兰州市 |620200|嘉峪关市 |620300|金昌市 |620400|白银市 |620500|天水市 |620600|武威市 |620700|张掖市 |620800|平凉市 |620900|酒泉市 |621000|庆阳市 |621100|定西市 |621200|陇南市 |622900|临夏回族自治州 |623000|甘南藏族自治州 |630000|青海省 |630100|西宁市 |630200|海东市 |632200|海北藏族自治州 |632300|黄南藏族自治州 |632500|海南藏族自治州 |632600|果洛藏族自治州 |632700|玉树藏族自治州 |632800|海西蒙古族藏族自治州 |640000|宁夏回族自治区 |640100|银川市 |640200|石嘴山市 |640300|吴忠市 |640400|固原市 |640500|中卫市 |650000|新疆维吾尔自治区 |650100|乌鲁木齐市 |650200|克拉玛依市 |650400|吐鲁番市 |650500|哈密市 |652300|昌吉回族自治州 |652700|博尔塔拉蒙古自治州 |652800|巴音郭楞蒙古自治州 |652900|阿克苏地区 |653000|克孜勒苏柯尔克孜自治州 |653100|喀什地区 |653200|和田地区 |654000|伊犁哈萨克自治州 |654200|塔城地区 |654300|阿勒泰地区 |659000|自治区直辖县级行政区划

## 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)。 | | KEY_BLOCK | Key被封禁。 | | REQUEST_LIMIT_EXCEEDED | 请求频率超出限制。 |

## 计费模式 代理IP产品主要计费方式为按时购买和按量购买，针对不同的代理IP产品，具有不同的计费方式，代理IP计费说明具体如下：  ### 1.1 按时计费 按时付费是一种先付费后使用的计费方式。通过包年包月，您可以提前预留资源，同时购买的时长越长，享受更大的价格优惠； 1年以上时长的按时产品都有8.33折，帮您更大程度节省支出，如购买12个月，实际支付10个月的费用，购买36个月，实际支付30个月的费用。 所有的按时计费产品都支持免费试用6小时，通道数最大支持5，即同时可免费使用IP最大为5，方便业务测试，保证您能购买到满意的产品。 按时购买方式适用于每天持续运行的客户，更多业务场景需求可联系我们的客户经理咨询~ ### 1.2 按量计费 按量付费是一种先使用后付费的计费方式。通过按量付费，您可以按需购买IP数，IP提取未使用不计费，使用更灵活； 按量IP数的有效期统一为2年，有效期内IP数使用完，可通过【复购】生成同样资源配置的按量IP业务，便捷操作； 按量付费适合短时间需要大量优质IP的客户，也适合希望每天低成本使用少量IP的客户，使用灵活。 ## 续费与升级 ### 2.1 续费 ** 2.1.1 到期后业务状态变化** (1) 到期后，业务进入已过期状态，此时您可以续费业务，续费成功后保留所有代理资源和业务数据； (2) 包周到期后4小时之内，包年包月到期后5天之内，业务会从已过期状态进入业务保留回收中状态，此时您可以续费业务，如果续费失败，请稍后重试或联系客户经理解决；同时业务保留期间如果续费过期后未使用的天数也计算时间。 (3) 删除保留期到期后，未进行续费，所有代理资源和业务数据删除。 **2.1.2 续费** 续费功能仅适用于按时付费代理产品，按量付费代理产品不需要续费。 按时业务到期后会影响业务的正常运行。如果您想继续使用该代理业务，需要在指定时间内为业务续费，否则业务到期且数据保留到期后，业务会自动删除，将无法进行续费； 按时业务即将到期我们会进行提醒，需要续费的用户可及时续费，确保不影响业务的使用； 按量业务到期后或IP量使用完无法进行续费，需要买相同产品配置的代理按量产品直接【复购】即可，详情如下图：  ### 2.2 升级 目前仅按时业务支持业务升级，主要是针对购买的通道数/请求数进行升级，升级价格计算公式：(升级配置价格[月] - 原始配置价格[月]) * 12 / 365 * 到期剩余天数，使用的过程中需要升级通道数/请求数，可至会员中心--代理IP--按时业务操作“升级”，具体位置如下图：