查詢獨享代理城市信息

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下載