查询独享代理城市信息

1. 接口描述

https://dev.kdlapi.com/api/querykpscity 英文代号：query kps city

本接口用于查询独享代理有哪些城市可供开通。对于IP共享型还可查询到每个城市可开通的IP数量。不支持IP共享型的动态型订单调用。

支持订单或账户API密钥调用本接口
接口最快调用频率：1秒1次

2. 参数说明

参数	是否必填	参数说明	取值说明
secret_id	是	订单或账户SecretId	查看API密钥信息
sign_type	否	签名验证方式。目前支持token和hmacsha1。	默认值：token
signature	是	请求签名，用来验证此次请求的合法性。	支持2种签名验证方式，签名计算方法参见API 授权与验证
timestamp	否	当前 UNIX 时间戳（秒级），可记录发起 API 请求的时间。 sign_type=hmacsha1时此参数有效且为必填项。	例如1557546010，如果与当前时间相差过大，会引起签名过期错误。
nonce	否	随机正整数，与 timestamp 联合起来，用于防止重放攻击。建议携带此参数进一步提升API安全性。 sign_type=hmacsha1时此参数有效。	客户自行生成随机正整数，如random.randint(1, 100000000)
serie	是	独享类型	1: IP共享型 2: IP独享型
kps.max_bandwidth	否	带宽选择 serie=1时此参数生效并且为必填项	有效取值： • 1：1Mb/s • 2：2Mb/s • 4：4Mb/s • 6：6Mb/s • 10：10Mb/s
model	否	型号选择 serie=1时此参数生效并且为必填项	STA: 静态型
city	否	城市编码指定查询某个城市是否可以购买	取值为2~4位城市编码(参见中国地区编码表) 默认取值：空串取值为空串或不带此参数代表查询所有可购买的城市

3. 调用示例

在会员中心API密钥管理页得到订单的SecretId和SecretKey：

SecretId：o1fjh1re9o28876h7c08
SecretKey：jd1gzm6ant2u7pojhbtl0bam0xpzsm1c

以密钥令牌验证为例，调用获取密钥令牌接口得到密钥令牌：

SecretToken：oxf0n0g59h7wcdyvz2uo68ph2s

IP共享型

调用示例

如下示例查询IP共享型下的带宽为1Mb/s的静态型所有可开通的城市：

GET https://dev.kdlapi.com/api/querykpscity?secret_id=o1fjh1re9o28876h7c08
&serie=1
&kps.max_bandwidth=1
&model=STA
&signature=oxf0n0g59h7wcdyvz2uo68ph2s

调用示例

如下示例查询IP共享型下的带宽为1Mb/s的静态型能不能开通杭州市(城市编码：3301)的IP：

GET https://dev.kdlapi.com/api/querykpscity?secret_id=o1fjh1re9o28876h7c08
&serie=1
&kps.max_bandwidth=1
&model=STA
&city=3301
&signature=oxf0n0g59h7wcdyvz2uo68ph2s

IP独享型

调用示例

如下示例查询IP独享型所有可开通的城市：

GET https://dev.kdlapi.com/api/querykpscity?secret_id=o1fjh1re9o28876h7c08
&serie=2
&signature=oxf0n0g59h7wcdyvz2uo68ph2s

使用说明

点击查看关于API授权与验证的介绍

4. 返回结果

接口返回json格式，样例：

{
  "msg": "",
  "code": 0,
  "data": [
    {
      "count": 9,  #IP独享型不返回count字段
      "code": "410300",
      "name": "洛阳市"
    },
    {
      "count": 8,  #IP独享型不返回count字段
      "code": "320400",
      "name": "常州市"
    },
    {
      "count": 5,  #IP独享型不返回count字段
      "code": "410100",
      "name": "郑州市"
    }
  ]
}

没有查询到可供开通的城市返回：

{"code": 0, "msg": "no available kps found", "data": []}

异常返回格式样例：

{"code": -1, "msg": "缺少参数", "data": ""}

5. 错误码一览

错误码	说明
-1	缺少参数
-2	参数值错误
-3	订单类型错误

查看公共错误码 →

6. SDK

快代理提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

SDK下载