绑定白名单-帮助中心 - 小象代理 - 优质高速HTTP代理IP-爬虫-代理服务器

绑定白名单

更新时间： 2023-09-13 14:44:46

[TOC]

### 1. 接口描述

- 将调用本接口的设备IP自动添加到白名单。
- 本接口适用于所有具备白名单认证功能的产品，包括代理IP（短效版）、代理IP（长效版）、代理IP（静态版），隧道代理等。
- 请不要频繁调用，建议调用间隔2分钟以上。

### 2. 调用频率

- 1次/秒

### 3. 请求URL

- `https://api.xiaoxiangdaili.com/app/bindIp`

### 4. 请求方式

- GET

### 5. 请求参数说明

|参数名|必选|参数说明|取值说明|
|:-----|:-----|:-----|-----|
| appKey |  <font style="color:#dd0000;">是</font> |  应用账号 | 产品管理页面查看 |
| appSecret |  <font style="color:#dd0000;">是</font> |  应用密钥 | 产品管理页面查看 |
| proxy |  否 |  代理IP地址 | 格式为ip:port，静态代理必须输入参数，其他类型产品该参数无效 |
| i | 否 | 白名单列表中的序列号 | 不可超过当前可绑定的白名单数量上限。默认：1 |

说明：仅静态代理产品的白名单与代理服务器绑定，因此需要传proxy参数；其他产品的白名单都是与应用账号绑定，与服务器无关。

### 6. 调用示例

```rust
GET https://api.xiaoxiangdaili.com/app/bindIp?
		appKey=950649340031422464
		&appSecret=q4adDKPC
```

### 7. 返回示例
```json
{
    "code": 200,
    "success": true,
    "data": null,
    "msg": "操作成功"
}
```

### 8. 返回参数说明

#### 8.1 公共参数说明
|参数名|类型|说明|
|:-----  |:-----|-----  |
| code | int   | 状态码  |
| success | bool | 是否成功 |
| data | object | 返回业务参数 |
| msg | string | 信息 |

### 9. 状态码code说明
| code值 | 描述 |
|:-----  |:-----|
| 200 | 成功 |
| 1001 | 应用不存在 |
| 1002 | 应用已被冻结或禁用 |
| 1003 | 应用已过期 |
| 1101 | IP已被绑定 |
| 1103 | IP绑定中 |
| 2000 | 未知异常 |

上一篇：查询剩余量

下一篇：获取白名单列表