添加IP白名单
本页目录
https://www.cloudam.cn/ip/whitelist/add/{ORDER_ID}?protocol={PROTOCOL}&needpwd={NEEDPWD}&userip={USERIP}
请求方式：GET
将需要使用代理的主机的公网IP添加至代理服务器的白名单中，否则无法访问
URL Parameters
| Parameter | Type | Description |
|---|---|---|
| ORDER_ID | String | 订单ID，购买IP云套餐后会返回订单ID Example: K09f7AabcfrO3rcjFvlFHroabcglP8 |
| PROTOCOL | String | 协议类型，http和https请填proxy，socks5请填socks Example: proxy |
| NEEDPWD | Boolean | 是否需要设置密码，true为需要，false为不需要 Example: true |
| USERIP | String | 需要使用代理的主机的公网IP，如有多台主机，请用英文逗号隔开 Example: 112.60.25.2,113.245.2.11 |
Request(请求)
Headers(HTTP头)
注: 请首先联系Cloudam获取API Token，token相当于密码，请妥善保护。
{
"Authorization": "Bearer ${token}",
"Content-Type": "application/json"
}
Response(响应) - 200
Headers(响应头)
{
"Content-Type": "application/json"
}
Body(响应体JSON) -- 正确响应
{
"result": "success",
"data": [
{
"username": "wT0fCbvT4WInCW9",
"ip": "54.210.xxx.xxx",
"port": 20072,
"password": "pG26Rv75sLPyUtO",
"protocol": "socks"
} ],
"errorCode": null,
"ipAmount": 500
}
Response Body Attributes(响应Body属性)
| Attribute | Type | Description |
|---|---|---|
| result | String | 执行成功则返回success，失败则返回fail |
| errorCode | String | 错误代码，空字符串表示成功， User.NotAllowed 表示请求异常，User.NotEnoughBalance 表示账户余额不足, Cloud.NotEnoughResource 表示公有云资源不足，如：User.NotAllowed：用户传入不正确的参数。 |
| ipAmount | Integer | 单次返回的ip总个数 500 |
| data | Array | 返回的多个IP消息体 |
| username | String | ip设置的用户名，如果needpwd设置为false则为null |
| ip | String | ip |
| port | String | ip端口 |
| password | String | ip密码，如果needpwd设置为false则为null |
| protocol | String | 协议，分为proxy和socks |