API文档>使用相关>白名单相关 > 查询白名单IP

查询白名单IP

发布时间:2022-07-02 02:36

1.接口描述

接口地址: https://proxy.yunkv.com/whitelist/query

本接口用于查询IP的白名单。

该接口单个Key的请求频率限制为:60次/分钟;

方法:HTTP、GET,需要注意不能混合使用;

编码:参数和返回内容均采用utf-8编码。

2.输入参数说明

参数名 是否必选 类型 描述
Key String 查询白名单的Key值
TaskID Integer 任务编号ID
detail Integer 详情0(关闭) 1(开启)

3.返回值

接口可返回文本格式、json格式、xml格式,字段说明如下:

参数名 类型 描述
Code Integer 结果编码:0(成功)-1(失败)
Num Integer 数量
Data Array IP白名单列表

4.示例

请求接口示例:

  1. https://proxy.yunkv.com/whitelist/query ?Key=请改成您的Key

返回示例:

  1. {
  2. "Code ":0,
  3. "Num",1
  4. Data:[
  5. "192.168.1.1",
  6. "192.168.1.2"
  7. ]
  8. }

5.错误码

错误码 描述
1 未知错误
10 参数不合法!
100 计划不存在或已过期!
101 请求数量超过计划通道数!
102 没有剩余的可用通道!
本文导读