全球-长效代理-提取IP资源-API接口-青果网络

## 1. 接口描述

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

本接口 (/get) 用于全球-长效代理产品提取IP的接口。

默认接口请求频率限制：（通道数*5+10）次/分钟。

推荐使用调试工具进行调试，[调试工具](https://www.qg.net/tools/IPdebug.html?type=5-2)。

需注意，如使用白名单IP，请在提取前添加白名单。

## 2. 输入参数

| 参数名称 | 必选 | 类型    | 描述                                                         |
| -------- | ---- | ------- | ------------------------------------------------------------ |
| key      | 是   | String  | 公共参数，产品唯一标识。                                     |
| area     | 否   | String  | 国家筛选。支持国家编码和自定义编码，比如：US,EU，或者990100,990200。[国家编码](https://www.qg.net/doc/use/8_234_201/1975.html) |
| area_ex  | 否   | String  | 排除某些地区提取。使用方式同上                               |
| num      | 否   | Integer | 提取个数，默认为1                                            |

## 3. 输出参数

| 参数名称   | 类型                                            | 描述                                                         |
| ---------- | ----------------------------------------------- | ------------------------------------------------------------ |
| code       | String                                          | 请求状态码。                                                 |
| data       | Array of [IP](https://www.qg.net/doc/1839.html) | IP资源列表。  <br> **注：IP结构中的server才是代理地址，proxy_ip是代理的真实出口IP。**    |
| request_id | String                                          | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |

## 4. 示例

#### 输入示例

```
GET https://overseas.proxy.qg.net/get?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 | 请求频率超出限制。                                           |
| BALANCE_INSUFFICIENT   | Key余额不足。                                                |
| NO_RESOURCE_FOUND      | 资源不足。                                                   |
| FAILED_OPERATION       | 提取失败。                                                   |
| EXTRACT_LIMIT_EXCEEDED | 超出提取配额。                                               |