短效代理-合并业务-提取IP接口-API接口-青果网络

## 1. 接口描述

接口请求域名： share.proxy.qg.net。

本接口 (/aggregate/get) 用于短效代理产品弹性提取模式下提取IP的接口。

默认接口请求频率限制：60次/分钟。

## 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/aggregate/get?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 | 请求频率超出限制。                                       |
| NO_RESOURCE_FOUND      | 资源不足。                                               |
| FAILED_OPERATION       | 提取失败。                                               |
| EXTRACT_LIMIT_EXCEEDED | 超出提取配额。今天提取的IP数超出了购买的IP数，请明天再提取使用或者升级IP数。    |

API文档

短效代理-合并业务-提取IP接口