查询按量业务详情
**简要描述：**
获取按量业务详细信息。API请求参数需要包含在URL中。为了获得更高的安全性，推荐您使用HTTPS协议发送请求。
**参数：**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|domain |是 |string |域名 `www.qg.net` |
|productId |是 |string |[品牌编号](https://www.qg.net/doc/2662.html "品牌编号")|
|appid |是 |string |[appid](https://www.qg.net/user/Agent/index "appid") 平台账号对应的appid|
|time |是 |integer |当前时间戳 |
|sign |是 |string |签名算法使用 MD5 算法，并生成 32 位小写的哈希值 - md5（appid + domain + time + appkey），[appid、appkey获取链接](https://www.qg.net/user/Agent/index "appid、appkey获取链接") |
|resource_no |是 |string |按量业务标识 |
**输入示例：**
- `POST、GET https://www.qg.net/api/proxyip/resourceView?productId=117&appid=xxx&time=1585280982&domain=www.qg.net&sign=xxx&resource_no=xxx`
**返回示例**
JSON格式
```
{
"RequestId":"ASDF4ASF-ASDFASF",
"Code": 200,
"Data": {
"Authkey": "3BZEOGS0",
"Number": 10000,
"Buy_time": "2021-03-25 16:15:21",
"End_time": "2023-03-25 16:15:21",
"Order_status": 1,
"Type": 2,
"Ip_type": 2,
"Resource_available": 10000,
"Tunnel_url": "tunnel.qg.net:3434"
}，
"Message":"获取成功"
}
```
**返回参数说明**
|参数名|类型|说明|
|:----- |:-----|----- |
|RequestId |string |请求编号 |
|Code |integer |返回状态码 |
|Message |string |返回内容 |
|Authkey |string |Authkey |
|Number |integer |按量业务总量|
|Connect |integer |连接数|
|Buy_time |string |生效时间|
|End_time |string |失效时间|
|Order_status |string |状态 1：正常, 3：过期,-1：已失效,-4：开通失败;-5：续费失败, -6：升级失败, -7：锁定|
|Type |integer |资源类型 1：独享，2：共享；3：独占|
|Ip_type |integer |IP类型 1：静态，2：动态，3：隧道|
|Resource_available |integer |按量业务余量|
|Tunnel_url |string |隧道地址|
**备注：**
更多返回错误代码请看首页的[错误代码](https://www.qg.net/doc/251.html "错误代码")描述。
品牌参数
**简要描述：**
- 本文档用于公共品牌参数数据的说明：
**参数说明**
|参数名|类型|说明|
|:----- |:-----|----- |
|代理IP |integer |117 |
|云电脑 |integer |113 |
|青果云 |integer |101 |
|服务器 |integer |115 |
添加白名单IP
## 1 接口描述
接口地址：https://proxy.qg.net/whitelist/add
本接口用于添加IP的白名单。
该接口单个Key的请求频率限制为：20次/分钟；
方法：HTTP、GET，需要注意不能混合使用；
编码：参数和返回内容均采用utf-8编码。
## 2 输入参数说明
|参数名|是否必选|类型|描述|
|:---- |:---|:----- |----- |
|Key |是 |String |添加白名单的Key值|
|IP |是 |Integer|白名单IP,多个以逗号","分隔|
## 3 返回值
接口可返回文本格式、json格式、xml格式，字段说明如下：
|参数名|类型|描述|
|:---- |:----- |----- |
|Code |Integer | 结果编码 |
|Data |Array | 添加成功的白名单IP |
|Num |Integer |添加成功的数量 |
## 4 示例
请求接口示例：
```
curl "https://proxy.qg.net/whitelist/add?Key=请改成您的Key&IP=1.1.1.1,2.2.2.2"
```
返回示例：
```
{
"Code": 0,
"Data": [
"1.1.1.1",
"2.2.2.2"
],
"Num": 2
}
```
## 5 接口返回错误码
| 错误码 | 描述 |
| ------------ | ------------ |
| -1 | 未知错误 |
| -10 | 参数不合法 |
| -11 | 请求过于频繁 |
| -100 | 计划不存在或已过期 |
| -202 | 白名单数量超过限制 |
添加白名单IP
## 1 接口描述
接口地址：https://proxy.qg.net/whitelist/add
本接口用于添加IP的白名单。
该接口单个Key的请求频率限制为：20次/分钟；
方法：HTTP、GET，需要注意不能混合使用；
编码：参数和返回内容均采用utf-8编码。
## 2 输入参数说明
|参数名|是否必选|类型|描述|
|:---- |:---|:----- |----- |
|Key |是 |String |添加白名单的Key值|
|IP |是 |Integer|白名单IP,多个以逗号","分隔|
## 3 返回值
接口可返回文本格式、json格式、xml格式，字段说明如下：
|参数名|类型|描述|
|:---- |:----- |----- |
|Code |Integer | 结果编码 |
|Data |Array | 添加成功的白名单IP |
|Num |Integer |添加成功的数量 |
## 4 示例
请求接口示例：
```
curl "https://proxy.qg.net/whitelist/add?Key=请改成您的Key&IP=1.1.1.1,2.2.2.2"
```
返回示例：
```
{
"Code": 0,
"Data": [
"1.1.1.1",
"2.2.2.2"
],
"Num": 2
}
```
## 5 接口返回错误码
| 错误码 | 描述 |
| ------------ | ------------ |
| -1 | 未知错误 |
| -10 | 参数不合法 |
| -11 | 请求过于频繁 |
| -100 | 计划不存在或已过期 |
| -202 | 白名单数量超过限制 |
短效代理（全球HTTP）-通道提取-查询在用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资源列表。
**注：IP结构中的server才是代理地址，proxy_ip是代理的真实出口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 | 请求频率超出限制。 |
短效代理（全球HTTP）-按量提取-查询在用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资源列表。
**注：IP结构中的server才是代理地址，proxy_ip是代理的真实出口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 | 请求频率超出限制。 |
独享代理-替换IP资源接口
## 1. 接口描述
接口请求域名： exclusive.proxy.qg.net。
本接口 (/replace) 用于独享代理产品释放并重新提取IP资源的接口。
默认接口请求频率限制：60/分钟。
推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html)。
备注：调用此接口后，之前提取的资源都会被释放掉！
## 2. 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| ---------- | ---- | ------- | ------------------------------------------------------------ |
| key | 是 | String | 公共参数，产品唯一标识。 |
| area | 否 | String | 按地区提取。支持多地区筛选，逗号隔开。比如："350500,330700"。 |
| isp | 否 | Integer | 按运营商提取。
0: 不筛选
1: 电信
2: 移动
3: 联通 |
| keep_avlie | 否 | Integer | 资源存活时间，单位分钟。 |
| num | 否 | Integer | 提取个数，默认为1。 |
| distinct | 否 | Bool | 去重提取，默认为false。如果为true则不会提取到已经在使用的IP资源。 |
## 3. 输出参数
| 参数名称 | 类型 | 描述 |
| ------------ | ----------------------------------------------- | ------------------------------------------------------------ |
| code | String | 请求状态码。 |
| data.task_id | String | 提取批次的ID。 |
| data.ips | Array of [IP](https://www.qg.net/doc/1839.html) | IP资源列表。
**注：IP结构中的server才是代理地址，proxy_ip是代理的真实出口IP。** |
| data.num | Integer | 提取到的IP资源数量。 |
| request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |
## 4. 示例
#### 输入示例
```
GET https://exclusive.proxy.qg.net/replace?key=<您的key信息>&<其他输入参数>
```
#### 输出示例
```json
{
"code": "SUCCESS",
"data": {
"task_id": "0LIKQ3S1_task",
"ips": [
{
"proxy_ip": "123.54.55.24",
"server": "123.54.55.24:59419",
"area": "河南省商丘市",
"isp": "电信",
"deadline": "2023-02-25 15:38:36"
}
],
"num": 1
},
"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)。 |
| KEY_BLOCK | Key被封禁。 |
| REQUEST_LIMIT_EXCEEDED | 请求频率超出限制。 |
| DELETE_LIMIT_EXCEEDED | 释放频率超出限制。 |
| NO_RESOURCE_FOUND | 资源不足。 |
| FAILED_OPERATION | 提取失败。 |
独享代理-查询在用IP资源接口
## 1. 接口描述
接口请求域名： exclusive.proxy.qg.net。
本接口 (/query) 用于独享代理产品查询在用的IP资源的接口。
默认接口请求频率限制：60次/分钟。
推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html)。
## 2. 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| -------- | ---- | ------ | ------------------------------------------------------------ |
| key | 是 | String | 公共参数，产品唯一标识。 |
| task | 否 | String | 提取批次筛选。支持多批次筛选，用逗号隔开。比如："Z5p2DKKCSyhocKEa,kAEaWHucf8iPXm0O"。 |
## 3. 输出参数
| 参数名称 | 类型 | 描述 |
| ---------- | ------------------------------------------------- | ------------------------------------------------------------ |
| code | String | 请求状态码。 |
| data.tasks | Array of [Task](https://www.qg.net/doc/1839.html) | 提取批次列表。
**注：Task结构中的IP结构中的server才是代理地址，proxy_ip是代理的真实出口IP。** |
| data.num | Integer | 提取批次数量。 |
| request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |
## 4. 示例
#### 输入示例
```
GET https://exclusive.proxy.qg.net/query?key=<您的key信息>&<其他输入参数>
```
#### 输出示例
```json
{
"code": "SUCCESS",
"data": {
"tasks": {
"task_id": "Z5p2DKKCSyhocKEa",
"ips": [
{
"proxy_ip": "123.54.55.24",
"server": "123.54.55.24:59419",
"area": "河南省商丘市",
"isp": "电信",
"deadline": "2023-02-25 15:38:36"
}
],
"num": 1
},
"num": 1
},
"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. 接口描述
接口请求域名： share.proxy.qg.net。
本接口 (/pool) 用于短效代理产品通道提取模式下提取并查询资源的接口。
默认接口请求频率限制：60次/分钟。
推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html)。
## 2. 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| -------- | ---- | ------- | ------------------------------------------------------------ |
| key | 是 | String | 公共参数，产品唯一标识。 |
| area | 否 | String | 按地区提取。支持多地区筛选，逗号隔开。比如："350500,330700"。 |
| area_ex | 否 | String | 排除某些地区提取。支持多地区排除，用逗号隔开。比如："440100,450000"。 |
| isp | 否 | Integer | 按运营商提取。
0: 不筛选
1: 电信
2: 移动
3: 联通 |
| num | 否 | Integer | 提取个数，默认为1。 |
| distinct | 否 | Bool | 去重提取，默认为false。如果为true则不会提取到已经在使用的IP资源。 |
## 3. 输出参数
| 参数名称 | 类型 | 描述 |
| ---------- | ----------------------------------------------- | ------------------------------------------------------------ |
| code | String | 请求状态码。 |
| data | Array of [IP](https://www.qg.net/doc/1839.html) | IP资源列表。
**注：IP结构中的server才是代理地址，proxy_ip是代理的真实出口IP。** |
| request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |
## 4. 示例
#### 输入示例
```
GET https://share.proxy.qg.net/pool?key=<您的key信息>&<其他输入参数>
```
#### 输出示例
```json
{
"code": "SUCCESS",
"data": [
{
"proxy_ip": "123.54.55.24",
"server": "123.54.55.24:59419",
"area": "河南省商丘市",
"isp": "电信",
"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 | 请求频率超出限制。 |
| BALANCE_INSUFFICIENT | Key余额不足。 |
| NO_RESOURCE_FOUND | 资源不足。 |
| FAILED_OPERATION | 提取失败。 |
| EXTRACT_LIMIT_EXCEEDED | 超出提取配额。 |
短效代理-通道提取-查询在用IP资源接口
## 1. 接口描述
接口请求域名： share.proxy.qg.net。
本接口 (/query) 用于短效代理产品通道提取模式下查询IP的接口。
默认接口请求频率限制：60次/分钟。
推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html)。
## 2. 输入参数
| 参数名称 | 必选 | 类型 | 描述 |
| -------- | ---- | ------ | ------------------------ |
| key | 是 | String | 公共参数，产品唯一标识。 |
## 3. 输出参数
| 参数名称 | 类型 | 描述 |
| ---------- | ----------------------------------------------- | ------------------------------------------------------------ |
| code | String | 请求状态码。 |
| data | Array of [IP](https://www.qg.net/doc/1839.html) | 在用的IP列表。
**注：IP结构中的server才是代理地址，proxy_ip是代理的真实出口IP。** |
| request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |
## 4. 示例
#### 输入示例
```
GET https://share.proxy.qg.net/query?key=<您的key信息>&<其他输入参数>
```
#### 输出示例
```json
{
"code": "SUCCESS",
"data": [
{
"proxy_ip": "123.54.55.24",
"server": "123.54.55.24:59419",
"area": "河南省商丘市",
"isp": "电信",
"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 | 请求频率超出限制。 |
