获取IP资源池-产品介绍-青果网络

## 1 接口描述

接口地址：https://proxy.qg.net/extract ；

本接口用于获取IP资源池全部可用的IP信息，该接口仅按时动态共享业务可用；

该接口单个Key的请求频率限制为45次/分钟；

需要注意的是请求方方式只能用GET；

编码：参数和返回内容均采用utf-8编码。

## 2 输入参数说明

| 参数名   | 是否必选  | 类型     | 描述 |
| :------- | :------- | :-------| ------- |
| Key      | 是       | String  | 申请的Key值  |
| Num      | 否       | Integer | 申请的数量；默认为1 |
| AreaId   |否        | Integer | 区域ID；默认随机 |
| ISP      |否        | Integer | 运营商ID；默认随机  |
| Detail   | 否       | Integer | 详情，0：关闭；1：开启；默认为0 |

## 3 返回值

接口可返回文本格式、json格式、xml格式，字段说明如下：

| 参数名 | 类型    | 描述                                       |
| :----- | :------ | ------------------------------------------ |
| Code   | Integer | 结果编码，0：成功；-1：失败                |
| TaskID | Integer | 任务ID                                     |
| Num    | Intger  | 申请数量                                   |
| Data   | Array   | 代理IP数据信息，包含节点IP、端口、失效日期 |
| Msg    | String  | 公共参数；本接口取值：区域ID             |

## 4 示例
请求接口示例：
```
curl "https://proxy.qg.net/extract?Key=请改成您的Key&Pool=1&Detail=1"
```
返回示例：
```json
 {
  "Code": 0,
  "Data": [
    {
      "IP": "175.43.188.196",
      "port": "64450",
      "deadline": "2021-11-20 11:32:20",
      "host": "175.43.188.196:64450",
      "region": "福建省泉州市晋江市联通"
    },
    {
      "IP": "114.238.148.203",
      "port": "50938",
      "deadline": "2021-11-20 11:32:20",
      "host": "114.238.148.203:50938",
      "region": "江苏省淮安市电信"
    },
    {
      "IP": "117.92.121.222",
      "port": "11136",
      "deadline": "2021-11-20 11:32:20",
      "host": "117.92.121.222:11136",
      "region": "江苏省连云港市电信"
    }
  ],
  "Num": 3,
  "TaskID": "mw13Wq0srzt9uLEt"
}
```
**重点：如果用户是企业池用户，且参数Pool=2，则返回的IP资源Data结构中的host和IP是不一样的，其他产品下host和IP是一样的。企业池产品中用户使用host进行代理，这时真实的代理IP为IP字段的IP（运营商为移动的情况下可能不会那么准确，即使代理IP可能不通，也都是同一个地区的IP，影响不会大）**
## 5 接口返回错误码

| 错误码 | 描述                    |
| ------ | ----------------------- |
| -1      | 未知错误             |
| -10     | 参数不合法           |
| -11     | 请求过于频繁         |
| -12     | Authkey被封禁       |
| -13     | 当前客户端IP不在授权名单中 |
| -14     | Pwd不合法            |
| -15     | Authkey对应的业务无此功能权限 |
| -100    | 计划不存在或已过期    |
| -101    | 请求数量超过计划通道数 |
| -103    | 资源不足              |
| -104    | 资源申请失败          |