## 1. 接口描述 接口请求域名： monopoly.proxy.qg.net。 本接口 (/changeip) 用于独享代理产品启用地区锁功能后更换资源IP的接口。 默认接口请求频率限制：60次/分钟。 推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html)。 ## 2. 输入参数 | 参数名称 | 必选 | 类型 | 描述 | | -------- | ---- | ------ | ------------------------------------------------------------ | | key | 是 | String | 公共参数，产品唯一标识。 | | uuid | 是 | String | 更换指定的独占资源的IP。支持多资源同事更换，按逗号隔开。比如：hn_sqdx2-1:ppp1,hn_sqdx2-1:ppp14。 | ## 3. 输出参数 | 参数名称 | 类型 | 描述 | | ---------- | --------------- | ------------------------------------------------------------ | | code | String | 请求状态码。 | | data | Array of String | 更换成功的独占资源UUID列表。 | | request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 | ## 4. 示例 #### 输入示例 ``` GET https://monopoly.proxy.qg.net/changeip?key=<您的key信息>&<其他输入参数> ``` #### 输出示例 ```json { "code": "SUCCESS", "data": ["hn_sqdx2-1:ppp14", "hn_sqdx2-1:ppp1"], "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/proxyIpManage)。 | | KEY_BLOCK | Key被封禁。 | | REQUEST_LIMIT_EXCEEDED | 请求频率超出限制。 | | MONOPOLY_CHANGEIP_TIME_LIMIT | 独占资源切换IP需要等待10秒。 |
## 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/user/proxyIpManage)。 | | KEY_BLOCK | Key被封禁。 | | REQUEST_LIMIT_EXCEEDED | 请求频率超出限制。 |
## 1. 接口描述 接口请求域名： exclusive.proxy.qg.net。 本接口 (/channels) 用于独享代理产品通道数查询的接口。 默认接口请求频率限制：60次/分钟。 推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html)。 ## 2. 输入参数 | 参数名称 | 必选 | 类型 | 描述 | | -------- | ---- | ------ | ------------------------ | | key | 是 | String | 公共参数，产品唯一标识。 | ## 3. 输出参数 | 参数名称 | 类型 | 描述 | | ---------- | ------- | ------------------------------------------------------------ | | code | String | 请求状态码。 | | data.toal | Integer | key的通道总数。 | | data.idle | Integer | 空闲通道数。 | | request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 | ## 4. 示例 #### 输入示例 ``` GET https://exclusive.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. 接口描述 接口请求域名： 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/user/proxyipResource)。 | | 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资源列表。
**注：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 | 请求频率超出限制。 |
## 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/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. 接口描述
接口请求域名： static.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://static.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. 接口描述 接口请求域名： static.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://static.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/user/proxyIpManage)。 | | KEY_BLOCK | Key被封禁。 | | REQUEST_LIMIT_EXCEEDED | 请求频率超出限制。 |
## 1. 接口描述 接口请求域名： monopoly.proxy.qg.net。 本接口 (/query) 用于独享代理产品启用地区锁功能后查询在用IP资源的接口。 默认接口请求频率限制：60次/分钟。 推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html)。 ## 2. 输入参数 | 参数名称 | 必选 | 类型 | 描述 | | -------- | ---- | ------ | ------------------------------------------------------------ | | key | 是 | String | 公共参数，产品唯一标识。 | | uuid | 否 | String | 查询指定的独占资源。支持多资源查询，按逗号隔开。比如：hn_sqdx2-1:ppp1,hn_sqdx2-1:ppp14。 | ## 3. 输出参数 | 参数名称 | 类型 | 描述 | | ---------- | ----------------------------------------------------- | ------------------------------------------------------------ | | code | String | 请求状态码。 | | data | Array of [Monopoly](https://www.qg.net/doc/1839.html) | 独占资源列表。 | | request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 | ## 4. 示例 #### 输入示例 ``` GET https://monopoly.proxy.qg.net/query?key=<您的key信息>&<其他输入参数> ``` #### 输出示例 ```json { "code": "SUCCESS", "data": [ { "uuid": "hn_sqdx2-1:ppp14", "area": "河南省商丘市", "isp": "电信", "state": "在线", "ip": "122.57.90.234", "heartbeat": "2023-02-25 09:48:23", "monopolize_time": "2023-02-25 09:45:10", }, { "uuid": "hn_sqdx2-1:ppp1", "area": "河南省商丘市", "isp": "电信", "state": "等待中(30)", "monopolize_time": "2023-02-25 09:45:10", } ], "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/proxyIpManage)。 | | KEY_BLOCK | Key被封禁。 | | REQUEST_LIMIT_EXCEEDED | 请求频率超出限制。 |
