极安代理 - 短效代理-提取IP接口

## 1. 接口描述

接口请求域名： api.ja.cn。

本接口 (/getip) 用于短效代理产品提取IP的接口。

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

## 2. 输入参数

| 参数名称 | 必选 | 类型 | 描述 |
| -------- | ---- | ------- | ------------------------------------------------------------ |
| key | 是 | String | 公共参数，产品唯一标识。 |
| area_code | 否 | String | 按地区提取。支持多地区筛选，逗号隔开。比如："350500,330700"。 |
| area_code_ex | 否 | String | 排除某些地区提取。支持多地区排除，用逗号隔开。比如："440100,450000"。 |
| isp | 否 | Integer | 按运营商提取。 0: 不筛选 1: 电信 2: 移动 3: 联通 |
| num | 否 | Integer | 提取个数，默认为1 |
| distinct | 否 | Bool | 去重提取，默认为false。如果为true则不会提取到已经在使用的IP资源。 |

## 3. 输出参数

| 参数名称 | 类型 | 描述 |
| ---------- | --------------------------------- | ------------------------------------------------------------ |
| status_code | int | 请求状态码。 |
| data | Array of IP | IP资源列表。 **注：IP结构中的server才是代理地址，proxy_ip是代理的真实出口IP。** |
| request_id | String | 唯一请求ID，每次请求都会返回。定位问题时需要提供该次请求的 request_id。 |
| status_msg | string | 状态码说明 |

## 4. 示例

#### 输入示例

```
GET https://api.ja.cn/getip?key=<您的key信息>&<其他输入参数>
```

#### 输出示例

```json
{
    "status_code": 0,
    "data": [
        {
            "out_ip": "123.54.55.24",
            "proxy_address": "123.54.55.24:59419",
            "area_name": "河南省商丘市",
            "isp": "电信",
            "expire_time": "2023-02-25 15:38:36"
        }
    ],
    "request_id": "83158ebe-be6c-40f7-a158-688741083edc"，
	"status_msg":"成功"
}
```

## 5. 错误码

| 状态码                 | 描述                                                     |
| ---------------------- | -------------------------------------------------------- |
| 10000         | 访问的地址不存在，请检查链接是否正确                                         |
| 10001      | 系统出了点小问题，请稍后再试                   |
| 10002            | 请求参数不正确，请核对格式和内容                                      |
| 10003        | 密钥无效或已过期，请续费或者联系客服                                |
| 10004            | 当前密钥没有权限访问该接口                                    |
| 10005          | 接口授权未通过，请检查鉴权配置                |
| 10006              | 该密钥已被封禁，请联系客服或者客服                                              |
| 10007 |请求过于频繁，请稍后再试                                      |
| 10008      | 账户余额不足，请充值后再试                                               |
| 10009       |暂时没有可用的服务通道，请稍后重试                                              |
| 10010 | 资源不足，请稍后再试或联系客服    |
| 10011            | 操作失败，请重试                                   |
| 10012          | 提取次数已达上限                  |
| 10013              | 释放操作过于频繁，请稍后再试                           |
| 10014 | 白名单数量已达上限，请调整配置                                 |
| 10015      |提取操作过于频繁，请一分钟后再试                                          |
| 10016       | 资源不存在或已被删除                                               |
| 10017 | 账户已被禁用，请联系客服    |
| 10018 | 账户不存在，请检查后重试    |

扫码联系

扫码关注公众号