购买完代理产品后,用户在使用代理IP的过程中,很多代理资源查询或代理使用,如替换、释放、通道配额等都需要在编程环境中才能调试运行获得,操作上存在局限性,调试工具则可以方便用户可以直接线上简单对接调试,便捷用户操作成本和缩减时间成本。
请求方式包括POST和GET,默认POST请求,根据自己的需求选择;右侧网址则是接口网址完整信息,包括选择的key、接口方法等参数信息。
key为必选项,是对接接口的必要信息。key的选择根据登录状态不同,可操作性不同。未登录时,需手动输入key值,已登录时,可下拉选择已购买的代理业务key,key信息附带业务资源配置和业务备注信息,方便辨别业务。
未登录状态:
已登录状态:
接口方法主要是选择要调试的接口类型,包括资源相关、IP白名单、信息查询三大模块,各个接口说明详情如下图:
接口类型 | API | 描述 |
---|---|---|
通用资源管理相关 | - allocate - extract - replace - release - query |
- 调用 allocate申请代理IP资源 - 调用extract获取IP资源池全部可用的IP信息 - 调用replace用于释放并申请新的代理IP,更换IP资源 - 调用release释放申请到的IP,以便于再次进行IP申请 - 调用query查询用户可用的代理IP资源列表 |
独占代理专用相关 | - monopolize_resources - monopolize_resources - monopolize_resources - monopolize_resources/newest_ips -monopolize_resources/idle |
- 用POST调用接口申请独占资源 -用GET调用接口查询可用的独占资源 - 用DELETE调用接口释放独占资源 -用PUT调用接口请求重拨独占资源 -用GET调用接口查询空闲的独占资源 |
白名单管理相关 | - whitelist/query - whitelist/add - whitelist/del |
- 调用 whitelist/query用于查询IP的白名单 - 调用whitelist/add用于添加IP的白名单 - 调用whitelist/del用于删除IP的白名单 |
资源信息查询 | - info/quota - resources |
- 调用 info/quota查询IP提取余量 - 调用resources查询平台可用的代理IP资源列表 |
调试工具中各个参数根据不同的接口类型对应显示,各个参数有不同的含义,详情如下:
参数名 | 是否必选 | 描述 |
---|---|---|
Key | 是 | 要申请IP的业务的Key值,下拉选择即可; |
IP | 是 | 代理IP;多个以逗号分割;*代表全部; |
Num | 否 | 申请的IP个数,默认1个,最大不超过套餐内IP数量最大值; |
KeepAlive | 否 | IP生存周期,其中独享默认24小时,短效默认购买的套餐存活周期时长; |
AreaId | 否 | 区域ID;默认随机; |
ISP | 否 | 运营商ID;默认随机;1:电信,2:移动,3:联通,4:BGP |
Detail | 否 | 是否获取代理IP的详情,默认为 0关闭,1为开启; |
Distinct | 否 | 申请的IP是否去重,默认为0不去重,1为开启去重;短效代理、独享代理适用。 |
DataFormat | 否 | 数据格式,本接口取值:json、html、txt ,默认为 json格式 |
DataSeparator | 否 | 分隔符,自定义 |
点击“测试”,右侧文本框区域显示接口请求结果,返回结果参数说明:
参数名 | 描述 |
---|---|
Code | 申请IP结果编码:0(成功)-1(失败)。 |
TaskID | 接口请求任务ID,可通过该IP释放该任务所申请到的IP; |
Total | 获取到的代理IP总数量 |
Available | 获取到的代理IP可用数量 |
Used | 获取到代理IP已使用数量 |
Num | 申请的代理IP数量 |
TotalNum | 总IP数,主要是资源查询 |
Data | 代理IP数据信息,包含节点IP、端口、失效日期 |
Msg | 公共参数,本接口取值:区域ID. |