NSocks

app_key 認證金鑰請登錄後在個人中心首頁查看。

請安全保存金鑰，金鑰擁有您的帳戶管理员權限。

認證方式

App Key 認證

POST 參數：

app_key: {your_app_key}

或作為查詢參數：

?app_key={your_app_key}

回應格式

所有介面返回統一的 JSON 格式：

{
"code": 200,
"message": "操作成功",
"data": {}
}
  • code: 狀態碼，200 表示成功，其他值表示失敗
  • message: 回應消息（中文）
  • data: 回應數据

Base URLs:

Authentication

  • HTTP Authentication, scheme: bearer
  • API Key (apiKeyAuth)
    • Parameter Name: app_key, in: query. 支持GET/POST，name 支持

代理帳戶管理

GET 代理帳戶列表

GET /ep/whitelist-account/list

返回範例

200 Response

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "id": 0,
        "username": "string",
        "password": "string",
        "created_at": "string",
        "remark": "string",
        "product_type": 9,
        "usage_flow": 0,
        "limit_flow": 102400,
        "status": 0
      }
    ]
  }
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK請求成功Inline

返回數据結構

狀態碼 200

名称類型必選約束中文名說明
» coderesponseCodefalsenone狀態碼,200 成功、3 app_key 無效
» msgstringfalsenone狀態消息
» dataobjectfalsenonenone
»» list[object]falsenonenone
»»» idintegerfalsenone帳戶編號
»»» usernamestringfalsenone代理帳戶名
»»» passwordstringfalsenone代理帳戶密碼
»»» created_atstringfalsenone新增時間
»»» remarkstringfalsenone备注
»»» product_typeproductTypesfalsenone套餐類型，9 動態住宅流量套餐、11 動態住宅IP、14靜態數據中心IP、25 靜態住宅IP
»»» usage_flowintegerfalsenone已使用流量，单位：KB
»»» limit_flowintegerfalsenone自定义流量上限：单位GB最大102400，0 不限制
»»» statusintegerfalsenone启用狀態：1启用，0停用

枚舉值

屬性值
product_type9
product_type11
product_type14
product_type25

POST 新增代理帳戶。

POST /ep/whitelist-account/add

Body 請求參數

{
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01:pass,user02:pass,user03:pass",
  "remark": "",
  "product_type": 9
}

請求參數

名称位置類型必選說明
bodybodyobject否none
» app_keybodystring否授權金鑰
» accountsbodystring否帳戶密碼，請按格式 username:password 填寫，帳戶和密碼仅支持數字和字母，禁止输入任何特殊符号或空格,冒号隔開帳戶和密碼。支持批量新增，英文逗号（,）分隔代理帳戶。
» remarkbodystring否代理帳戶描述
» product_typebodyproductTypes否套餐類型，9 動態住宅流量套餐、11 動態住宅IP、14靜態數據中心IP、25 靜態住宅IP

枚舉值

屬性值
» product_type9
» product_type11
» product_type14
» product_type25

返回範例

200 Response

{
  "code": 200,
  "msg": "string",
  "data": null
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK請求成功Inline

返回數据結構

狀態碼 200

名称類型必選約束中文名說明
» codeintegerfalsenone狀態碼,200 成功、3 app_key 無效、156 帳戶未实名認證
» msgstringfalsenone狀態消息
» datanullfalsenonenone

POST 刪除代理帳戶

POST /ep/whitelist-account/delete

請注意刪除後無法恢復，已使用流量等無法查詢。刪除约有5分钟等待時間，在此期间仍可能产生费用。

Body 請求參數

{
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01,user02"
}

請求參數

名称位置類型必選說明
bodybodyobject否none
» app_keybodystring否授權金鑰
» accountsbodystring否代理帳戶，仅支持數字和字母。支持批次操作，英文逗号（,）分隔代理帳戶

返回範例

200 Response

{
  "code": 200,
  "msg": "string",
  "data": null
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK請求成Inline

返回數据結構

狀態碼 200

名称類型必選約束中文名說明
» codeintegerfalsenone狀態碼,200 成功、3 app_key 無效、156 帳戶未实名認證
» msgstringfalsenone狀態消息
» datanullfalsenonenone

POST 禁用代理帳戶

POST /ep/whitelist-account/disable

禁用约有5分钟等待時間，在此期间仍可能产生费用。

Body 請求參數

{
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01,user02"
}

請求參數

名称位置類型必選說明
bodybodyobject否none
» app_keybodystring否授權金鑰
» accountsbodystring否代理帳戶，仅支持數字和字母。支持批次操作，英文逗号（,）分隔代理帳戶

返回範例

200 Response

{
  "code": 200,
  "msg": "string",
  "data": null
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK請求成Inline

返回數据結構

狀態碼 200

名称類型必選約束中文名說明
» codeintegerfalsenone狀態碼,200 成功、3 app_key 無效、156 帳戶未实名認證
» msgstringfalsenone狀態消息
» datanullfalsenonenone

POST 启用代理帳戶

POST /ep/whitelist-account/enable

Body 請求參數

{
  "app_key": "stringstringstringstringstringst",
  "accounts": "user01,user02"
}

請求參數

名称位置類型必選說明
bodybodyobject否none
» app_keybodystring否授權金鑰
» accountsbodystring否代理帳戶，仅支持數字和字母。支持批次操作，英文逗号（,）分隔代理帳戶

返回範例

200 Response

{
  "code": 200,
  "msg": "string",
  "data": null
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK請求成Inline

返回數据結構

狀態碼 200

名称類型必選約束中文名說明
» codeintegerfalsenone狀態碼,200 成功、3 app_key 無效、156 帳戶未实名認證
» msgstringfalsenone狀態消息
» datanullfalsenonenone

POST 修改代理帳戶密碼

POST /ep/whitelist-account/change-password

請注意修改後有5分钟等待時間，在此期间舊密碼仍可能正常使用。

Body 請求參數

{
  "app_key": "stringstringstringstringstringst",
  "account": "user",
  "password": "pass"
}

請求參數

名称位置類型必選說明
bodybodyobject否none
» app_keybodystring否授權金鑰
» accountbodystring否代理帳戶，仅支持數字和字母。
» passwordbodystring否代理帳戶新密碼，仅支持數字和字母。

返回範例

200 Response

{
  "code": 200,
  "msg": "string",
  "data": null
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK請求成Inline

返回數据結構

狀態碼 200

名称類型必選約束中文名說明
» codeintegerfalsenone狀態碼,200 成功、3 app_key 無效、156 帳戶未实名認證
» msgstringfalsenone狀態消息
» datanullfalsenonenone

POST 修改代理帳戶备注

POST /ep/whitelist-account/change-remark

Body 請求參數

{
  "app_key": "stringstringstringstringstringst",
  "account": "user",
  "remark": ""
}

請求參數

名称位置類型必選說明
bodybodyobject否none
» app_keybodystring否授權金鑰
» accountbodystring否代理帳戶，仅支持數字和字母。
» remarkbodystring否代理帳戶新备注，32个中文或64个英文以内。

返回範例

200 Response

{
  "code": 200,
  "msg": "string",
  "data": null
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK請求成Inline

返回數据結構

狀態碼 200

名称類型必選約束中文名說明
» codeintegerfalsenone狀態碼,200 成功、3 app_key 無效、156 帳戶未实名認證
» msgstringfalsenone狀態消息
» datanullfalsenonenone

POST 修改代理帳戶流量上限

POST /ep/whitelist-account/change-limit

請注意流量統計可能有5分钟以内延迟，即实际消耗流量可能超過此限制。

Body 請求參數

{
  "app_key": "stringstringstringstringstringst",
  "account": "user",
  "limit": 0
}

請求參數

名称位置類型必選說明
bodybodyobject否none
» app_keybodystring否授權金鑰
» accountbodystring否代理帳戶，仅支持數字和字母。
» limitbodyinteger否流量限制，单位：GB，0為不设上限

返回範例

200 Response

{
  "code": 200,
  "msg": "string",
  "data": null
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK請求成Inline

返回數据結構

狀態碼 200

名称類型必選約束中文名說明
» codeintegerfalsenone狀態碼,200 成功、3 app_key 無效、156 帳戶未实名認證
» msgstringfalsenone狀態消息
» datanullfalsenonenone

POST 修改代理帳戶信息

POST /ep/proxy-account/change

修改代理帳戶密碼、备注、流量限制、每日流量限制、启用狀態或 UDP 開關。

Body 請求參數

{
  "app_key": "string",
  "account": "string",
  "password": "string",
  "remark": "string",
  "limit": 0,
  "daily_limit": 0,
  "status": 0,
  "udp": 0
}

請求參數

名称位置類型必選說明
bodybodyobject否none
» app_keybodystring否授權金鑰
» accountbodystring否代理帳戶名
» passwordbodystring否新密碼，6-16 位數字或字母；不传则不修改
» remarkbodystring否新备注
» limitbodyinteger否流量上限，单位 GB，0 表示不限制
» daily_limitbodyinteger否每日流量上限，单位 GB，0 表示不限制
» statusbodyinteger否启用狀態
» udpbodyinteger否UDP 支持開關，仅對套餐類型 14、16、21、25 生效

枚舉值

屬性值
» status0
» status1
» udp0
» udp1

返回範例

200 Response

{
  "code": 200,
  "msg": "string",
  "data": null
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK請求成功Inline

返回數据結構

狀態碼 200

名称類型必選約束中文名說明
» codeintegerfalsenone狀態碼,200 成功
» msgstringfalsenone狀態消息
» datanullfalsenonenone

IP白名单

GET IP 白名单列表

GET /ep/proxy-ip/list

請求參數

名称位置類型必選說明
product_typequeryinteger否套餐類型編號

返回範例

200 Response

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "ip": "1.1.1.1",
        "remark": "string",
        "product_type": 0,
        "created_at": "string"
      }
    ]
  }
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK請求成功Inline

返回數据結構

狀態碼 200

名称類型必選約束中文名說明
» codeintegerfalsenone狀態碼,200 成功
» msgstringfalsenone狀態消息
» dataobjectfalsenonenone
»» list[object]falsenonenone
»»» ipstringfalsenone白名单 IP
»»» remarkstringfalsenone备注
»»» product_typeintegerfalsenone套餐類型
»»» created_atstringfalsenone建立時間

POST 新增 IP 白名单

POST /ep/proxy-ip/add

Body 請求參數

{
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "remark": "string",
  "product_type": 0,
  "user_product_id": 0
}

請求參數

名称位置類型必選說明
bodybodyobject否none
» app_keybodystring否授權金鑰
» ipsbodystring否需要新增的白名单 IP，多个用英文逗号或换行分隔
» remarkbodystring否备注
» product_typebodyinteger否套餐類型編號
» user_product_idbodyinteger否使用者套餐 ID，套餐類型為 11 时必填

返回範例

200 Response

{
  "code": 200,
  "msg": "string",
  "data": null
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK請求成功Inline

返回數据結構

狀態碼 200

名称類型必選約束中文名說明
» codeintegerfalsenone狀態碼,200 成功
» msgstringfalsenone狀態消息
» datanullfalsenonenone

POST 刪除 IP 白名单

POST /ep/proxy-ip/delete

Body 請求參數

{
  "app_key": "string",
  "ips": "1.1.1.1,2.2.2.2",
  "verify_type": "string",
  "verify_code": "string"
}

請求參數

名称位置類型必選說明
bodybodyobject否none
» app_keybodystring否授權金鑰
» ipsbodystring否需要刪除的白名单 IP，多个用英文逗号分隔
» verify_typebodystring否验证類型：phone、email、wechat、totp
» verify_codebodystring否验证码

返回範例

200 Response

{
  "code": 200,
  "msg": "string",
  "data": null
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK請求成功Inline

返回數据結構

狀態碼 200

名称類型必選約束中文名說明
» codeintegerfalsenone狀態碼,200 成功
» msgstringfalsenone狀態消息
» datanullfalsenonenone

流量日誌查詢

GET 使用流量按天汇總

GET /ep/user-usage-flow/total

請求參數

名称位置類型必選說明
app_keyquerystring(password)是認證金鑰
start_timequerystring(Y-m-d H:i:s)否起始時間，可精确到秒。請注意，日誌記錄有5分钟以内延迟。預設7天以内。
end_timequerystring(Y-m-d H:i:s)否截止時間，可精确到秒。請注意，日誌記錄有5分钟以内延迟。預設當前時間。
usernamequerystring否子帳戶名称,預設查詢所有帳戶，可指定子帳戶。請注意如果您新增了相同名称的子帳戶，此查詢將返回同名代理帳戶的所有使用記录。
product_typequerynumber否套餐類型

返回範例

200 Response

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "day": "2022-08-01",
        "flow": 0
      }
    ]
  }
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK請求成Inline

返回數据結構

狀態碼 200

名称類型必選約束中文名說明
» codeintegerfalsenone狀態碼,200 成功、3 app_key 無效、156 帳戶未实名認證
» msgstringfalsenone狀態消息
» dataobjectfalsenonenone
»» list[object]falsenonenone
»»» daystringfalsenone日期
»»» flowintegerfalsenone消耗流量,单位KB

套餐查詢

GET 已购套餐列表

GET /ep/user-product/list

請求參數

名称位置類型必選說明
app_keyquerystring(password)是認證金鑰
trade_noquerystring否訂單號，請输入完整訂單號。不支持模糊搜索。
pagequerynumber否分頁，預設：1
sizequerynumber否分頁显示數量,預設：20
product_typequerynumber否套餐類型

返回範例

200 Response

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "id": 0,
        "created_at": "2022-05-13 12:14:15",
        "expired_at": "2022-05-13 12:14:15",
        "product_type": 9,
        "trade_no": "2022051312134339861461465434",
        "order": {
          "created_at": "2022-05-13 12:13:43",
          "pay_at": "2022-05-13 12:13:43",
          "title": "入门级"
        }
      }
    ],
    "page": 1,
    "page_size": 20,
    "total_count": 0,
    "total_page": 0
  }
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK請求成Inline

返回數据結構

狀態碼 200

名称類型必選約束中文名說明
» codeintegerfalsenone狀態碼,200 成功、3 app_key 無效、156 帳戶未实名認證
» msgstringfalsenone狀態消息
» dataobjectfalsenonenone
»» list[object]falsenonenone
»»» idintegerfalsenone套餐編號
»»» created_atstringfalsenone套餐生效時間
»»» expired_atstringfalsenone套餐過期時間,過期後流量無法使用。
»»» product_typeproductTypesfalsenone套餐類型，9 動態住宅流量套餐、11 動態住宅IP、14靜態數據中心IP、25 靜態住宅IP
»»» trade_nostringfalsenone訂單交易号
»»» orderobjectfalsenonenone
»»»» created_atstringfalsenone訂單建立時間
»»»» pay_atstringfalsenone訂單支付時間
»»»» titlestringfalsenone訂單描述
»» pageintegerfalsenone當前分頁
»» page_sizeintegerfalsenone分頁大小
»» total_countintegerfalsenone總記录數量
»» total_pageintegerfalsenone總分頁數量

枚舉值

屬性值
product_type9
product_type11
product_type14
product_type25

GET 使用者套餐數据汇總

GET /ep/user-product/summary

获取使用者套餐的統計汇總信息，包括總量、有效量、临期量、過期量等

請求參數

名称位置類型必選說明
app_keyquerystring(password)是認證金鑰
product_typequeryinteger否產品類型，仅支持 9（動態流量套餐）、12（長效IDC流量套餐）

枚舉值

屬性值
product_type9
product_type12

返回範例

200 Response

{
  "code": 200,
  "msg": "成功",
  "data": {
    "total": 1048576,
    "total_count": 5,
    "effective": 524288,
    "effective_count": 3,
    "effective_total": 786432,
    "effective_used": 262144,
    "temporary": 102400,
    "temporary_count": 1,
    "expired": 51200,
    "expired_count": 1,
    "used": 473088
  }
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK請求成功Inline

返回數据結構

狀態碼 200

名称類型必選約束中文名說明
» codeintegerfalsenone狀態碼,200 成功、3 app_key 無效、156 帳戶未实名認證
» msgstringfalsenone狀態消息
» dataobjectfalsenonenone
»» totalintegerfalsenone流量/IP總量（单位：KB）
»» total_countintegerfalsenone套餐總个數
»» effectiveintegerfalsenone有效剩餘量（单位：KB）
»» effective_countintegerfalsenone有效套餐个數
»» effective_totalintegerfalsenone有效總量（单位：KB）
»» effective_usedintegerfalsenone有效已使用量（单位：KB）
»» temporaryintegerfalsenone临期總量（7天内到期，单位：KB）
»» temporary_countintegerfalsenone临期套餐个數（7天内到期）
»» expiredintegerfalsenone過期剩餘量（单位：KB）
»» expired_countintegerfalsenone過期套餐个數
»» usedintegerfalsenone已使用總量（单位：KB）

IP提取

GET 提取IP

GET /ep/ip/v3

請求參數

名称位置類型必選說明
app_keyquerystring(password)是存取金鑰
ccquerystring否國家或地區
statequerystring否省或州
cityquerystring否城市
formatquerystring否获取格式
lbquerystring否间隔符，仅text格式有效
numquerynumber否提取數量
lifequerynumber否保持周期-分钟
epquerystring否代理網路

枚舉值

屬性值
epus
ephk
epde

返回範例

200 Response

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      [
        "150.109.114.72:1140",
        "150.109.114.72:1141",
        "150.109.114.72:1142",
        "150.109.114.72:1143",
        "150.109.114.72:1144",
        "150.109.114.72:1145",
        "150.109.114.72:1146",
        "150.109.114.72:1147",
        "150.109.114.72:1148",
        "150.109.114.72:1149"
      ]
    ]
  }
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK請求成Inline

返回數据結構

狀態碼 200

名称類型必選約束中文名說明
» codeintegerfalsenone狀態碼,200 成功、3 app_key 無效、156 帳戶未实名認證
» msgstringfalsenone狀態消息
» dataobjectfalsenonenone
»» list[any]falsenonenone

GET 動態地區城市列表V4

GET /ep/ip/dcl4

按使用者名获取城市列表，需要登錄認證，且帳戶必須属于當前使用者

請求參數

名称位置類型必選說明
usernamequerystring是代理帳戶使用者名

返回範例

200 Response

{
  "code": 200,
  "msg": "string",
  "data": {
    "cache": true,
    "list": [
      {
        "City": "Los Angeles",
        "Area": "US",
        "State": "California"
      }
    ]
  }
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK請求成功Inline

返回數据結構

狀態碼 200

名称類型必選約束中文名說明
» codeintegerfalsenone狀態碼,200 成功
» msgstringfalsenone狀態消息
» dataobjectfalsenonenone
»» cachebooleanfalsenone是否來自快取
»» list[object]falsenonenone
»»» Citystringfalsenone城市
»»» Areastringfalsenone地區
»»» Statestringfalsenone州/省

GET 動態地區州/省列表V4

GET /ep/ip/dsl4

按使用者名获取州/省列表，需要登錄認證，且帳戶必須属于當前使用者

請求參數

名称位置類型必選說明
usernamequerystring是代理帳戶使用者名

返回範例

200 Response

{
  "code": 200,
  "msg": "string",
  "data": {
    "cache": true,
    "list": [
      {
        "City": "Los Angeles",
        "Area": "US",
        "State": "California"
      }
    ]
  }
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK請求成功Inline

返回數据結構

狀態碼 200

名称類型必選約束中文名說明
» codeintegerfalsenone狀態碼,200 成功
» msgstringfalsenone狀態消息
» dataobjectfalsenonenone
»» cachebooleanfalsenone是否來自快取
»» list[object]falsenonenone
»»» Citystringfalsenone城市
»»» Areastringfalsenone地區
»»» Statestringfalsenone州/省

GET 動態地區州/省城市融合列表V4

GET /ep/ip/dal4

按使用者名获取州/省和城市的融合列表，按地區分組。需要登錄認證，且帳戶必須属于當前使用者

請求參數

名称位置類型必選說明
usernamequerystring是代理帳戶使用者名

返回範例

200 Response

{
  "code": 200,
  "msg": "string",
  "data": {
    "cache": true,
    "list": [
      {
        "Area": "US",
        "states": [
          {
            "State": null,
            "cities": null
          }
        ]
      }
    ]
  }
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK請求成功Inline

返回數据結構

狀態碼 200

名称類型必選約束中文名說明
» codeintegerfalsenone狀態碼,200 成功
» msgstringfalsenone狀態消息
» dataobjectfalsenonenone
»» cachebooleanfalsenone是否來自快取
»» list[object]falsenone地區列表
»»» Areastringfalsenone地區代码
»»» states[object]falsenone州/省列表
»»»» Statestringfalsenone州/省名称
»»»» cities[string]falsenone城市列表

GET 城市列表

GET /ep/ip/dynamic-citys

返回範例

200 Response

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "name_zh_cn": "美国",
        "name_en": "United States",
        "continent_code": "NA",
        "country_code": "US",
        "items": [
          {
            "city": null,
            "state": null,
            "continent_code": null,
            "country_code": null
          }
        ]
      }
    ]
  }
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK請求成Inline

返回數据結構

狀態碼 200

名称類型必選約束中文名說明
» codeintegerfalsenone狀態碼,200 成功、3 app_key 無效、156 帳戶未实名認證
» msgstringfalsenone狀態消息
» dataobjectfalsenonenone
»» list[object]falsenone列表
»»» name_zh_cnstringfalsenone國家或地區名称
»»» name_enstringfalsenone國家或地區名称
»»» continent_codestringfalsenone大洲代碼
»»» country_codestringfalsenone國家或地區代码
»»» items[object]falsenone省或州
»»»» citystringfalsenone城市名称
»»»» statestringfalsenone省或州名称代码
»»»» continent_codestringfalsenone大洲代碼
»»»» country_codestringfalsenone國家或地區代码

GET 城市搜索

GET /ep/ip/dynamic-citys/search

請求參數

名称位置類型必選說明
country_codequerystring是國家或地區代码
statequerystring是州或省代码

返回範例

200 Response

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      "string"
    ]
  }
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK請求成Inline

返回數据結構

狀態碼 200

名称類型必選約束中文名說明
» codeintegerfalsenone狀態碼,200 成功、3 app_key 無效、156 帳戶未实名認證
» msgstringfalsenone狀態消息
» dataobjectfalsenonenone
»» list[string]falsenone列表

GET 州列表

GET /ep/ip/dynamic-states

返回範例

200 Response

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      {
        "name_zh_cn": "美国",
        "name_en": "United States",
        "continent_code": "NA",
        "country_code": "US",
        "items": [
          {
            "state": null,
            "continent_code": null,
            "country_code": null
          }
        ]
      }
    ]
  }
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK請求成Inline

返回數据結構

狀態碼 200

名称類型必選約束中文名說明
» codeintegerfalsenone狀態碼,200 成功、3 app_key 無效、156 帳戶未实名認證
» msgstringfalsenone狀態消息
» dataobjectfalsenonenone
»» list[object]falsenone列表
»»» name_zh_cnstringfalsenone國家或地區名称
»»» name_enstringfalsenone國家或地區名称
»»» continent_codestringfalsenone大洲代碼
»»» country_codestringfalsenone國家或地區代码
»»» items[object]falsenone省或州
»»»» statestringfalsenone省或州名称代码
»»»» continent_codestringfalsenone大洲代碼
»»»» country_codestringfalsenone國家或地區代码

GET 州/省搜索

GET /ep/ip/dynamic-states/search

請求參數

名称位置類型必選說明
country_codequerystring是國家或地區代码

返回範例

200 Response

{
  "code": 200,
  "msg": "string",
  "data": {
    "list": [
      "string"
    ]
  }
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK請求成Inline

返回數据結構

狀態碼 200

名称類型必選約束中文名說明
» codeintegerfalsenone狀態碼,200 成功、3 app_key 無效、156 帳戶未实名認證
» msgstringfalsenone狀態消息
» dataobjectfalsenonenone
»» list[string]falsenone列表

GET 提取已購買靜態IP列表

GET /ep/ip/get-static-ip

請求參數

名称位置類型必選說明
country_codequerystring否國家或地區代码
product_typequerynumber否產品類型, 25:靜態住宅IP, 14: 數據中心IP
trade_noquerystring否通過訂單號篩選IP
pagequerynumber否頁碼
sizequerynumber否每頁數量
statusquerynumber否狀態, 1:有效, 2:無效, 3:即將過期, 4:维护中

枚舉值

屬性值
product_type14
product_type25
status1 - 2 - 3 - 4

返回範例

200 Response

{}

返回結果

狀態碼狀態碼含义說明數據模型
200OKnoneInline

返回數据結構

GET 获取在售地區靜態IP數量

GET /ep/ip/static-ip-region

請求參數

名称位置類型必選說明
ispqueryinteger否ISP 篩選，不传则不篩選（站点 1/4/5 除外預設為 1）
asnqueryinteger否是否返回 ASN 分組數据
exclusivequeryinteger否是否按獨享庫存統計

詳細說明

isp: ISP 篩選，不传则不篩選（站点 1/4/5 除外預設為 1）

值描述
0數據中心靜態IP（IDC）
1家庭住宅靜態IP（ISP）

asn: 是否返回 ASN 分組數据

值描述
0不返回 ASN 分組數据（預設）
1返回 ASN 分組數据

exclusive: 是否按獨享庫存統計

值描述
0按當前使用者/共享组口徑統計（預設）
1排除所有已分配IP，仅統計可用庫存

枚舉值

屬性值
isp0
isp1
asn0
asn1
exclusive0
exclusive1

返回範例

200 Response

{
  "code": 200,
  "msg": "請求成功",
  "data": {
    "list": [
      {
        "code": "US",
        "number": 55
      }
    ]
  }
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK請求成功Inline

返回數据結構

狀態碼 200

名称類型必選約束中文名說明
» codeintegerfalsenone狀態碼,200 成功
» msgstringfalsenone狀態消息
» dataobjectfalsenonenone
»» list[object]falsenonenone
»»» codestringfalsenone國家或地區代码
»»» numberintegerfalsenone數量

GET 获取 host_pool 支持國家/地區

GET /ep/host-pool/regions

查詢 host_pool 服務當前站点支持的國家/地區列表。

該介面面向數據中心 IP 按流量积分的隨機提取场景，仅按當前站点可用數據中心 IP 庫存統計國家/地區。 不支持 ASN、ISP、獨享庫存篩選，也不會按使用者已購買記录排除 IP。

返回範例

200 Response

{
  "code": 200,
  "msg": "請求成功",
  "data": {
    "list": [
      {
        "code": "US",
        "number": 55,
        "name_zh_cn": "美国",
        "name_en": "United States",
        "square_flag": "https://example.com/static/flags/us.png"
      }
    ]
  }
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK請求成功Inline

返回數据結構

狀態碼 200

名称類型必選約束中文名說明
» codeintegerfalsenone狀態碼,200 成功
» msgstringfalsenone狀態消息
» dataobjectfalsenonenone
»» list[object]falsenonenone
»»» codestringfalsenone國家或地區代码，ISO 3166-1 alpha-2
»»» numberintegerfalsenone當前站点可用數據中心 IP 數量
»»» name_zh_cnstringfalsenone國家或地區中文名称
»»» name_enstringfalsenone國家或地區英文名称
»»» square_flagstringfalsenone方形國旗图片 URL

訂單管理

GET 訂單列表

GET /ep/order/list

請求參數

名称位置類型必選說明
page_noqueryinteger否none
page_sizequeryinteger否none
trade_noquerystring否訂單編號
start_timequerystring(date-time)否開始時間（包含），如 2024-01-01 00:00:00
end_timequerystring(date-time)否結束時間（不包含）
statusqueryinteger否訂單狀態
product_typequeryinteger否產品類型
invoicequeryinteger否發票狀態：0不限制 1已開發票 -1未開發票（可补開）
pay_fee_statusqueryinteger否長短款篩選：1超額支付 2短款支付

詳細說明

status: 訂單狀態

狀態描述
0待支付
1已支付
2超時未支付已取消
3已退款

product_type: 產品類型

產品類型描述
3餘額充值
9動態流量套餐
11動態全球包时套餐V2
12長效IDC流量套餐
13住宅靜態IP流量套餐
14數據中心靜態IP套餐
15長效ISP流量套餐
16靜態流量套餐
17動態IP數量套餐
18web-scraper
19靜態IP續費
20靜態IP更換配额
21靜態流量套餐v2
24靜態流量附加包套餐
25住宅靜態IP套餐
26補單 - 部分支付渠道需要使用者手动填寫金額，如：虛擬幣，若发生短款，需要联系客服通過此种产品進行補支付
27Serp
28Video

枚舉值

屬性值
status0
status1
status2
status3
product_type3
product_type9
product_type11
product_type12
product_type14
product_type16
product_type17
product_type18
product_type19
product_type21
product_type24
product_type25
product_type26
product_type27
product_type28
invoice-1
invoice0
invoice1
pay_fee_status1
pay_fee_status2

返回範例

200 Response

{
  "code": 0,
  "message": "操作成功",
  "data": {
    "list": [
      {
        "id": 0,
        "trade_no": "string",
        "out_trade_no": "string",
        "product_id": 0,
        "product_type": 0,
        "amount": 0,
        "unit_price": 0.1,
        "total_fee": 0.1,
        "goods_fee": 0.1,
        "pay_fee": 0.1,
        "discount_fee": 0.1,
        "handling_fee": 0.1,
        "refund_fee": 0.1,
        "pm_id": 0,
        "pm_title": "string",
        "pm_logo": "string",
        "status": 0,
        "title": "string",
        "detail": "string",
        "region_desc": "string",
        "pay_at": "2019-08-24T14:15:22Z",
        "pay_timestamp": 0,
        "created_at": "2019-08-24T14:15:22Z",
        "pay_fee_status": 0,
        "invoice": {}
      }
    ],
    "pagination": {
      "total": 0,
      "page_no": 0,
      "page_size": 0,
      "total_pages": 0
    }
  }
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK成功Inline

返回數据結構

POST 建立訂單

POST /ep/order/create

因套餐种类较多，且每种套餐存在不同的配置，請根據实际情况填寫參數。不正當填寫參數可能导致訂單建立失敗。

examples:

續費靜態IP

{
    "pid": 套餐ID, // 從 /ep/product 介面获取
    "upids": "1,2,3,4,5,6", // 從 /ep/ip/get-static-ip 介面获取對應的 id 字段
    "pm_id": 1 // 從 /ep/payment/list 或 /ep/payment/groups 介面获取
  }

靜態住宅IP購買

{
  "pid": 套餐ID, // 從 /ep/product 介面获取
  "pm_id": 支付方式ID, // 從 /ep/payment/list 或 /ep/payment/groups 介面获取
  "region_list": "JP,15,333|DE,10,444|US,5,555" // 格式：地區,數量,ASN|地區,數量,ASN（ASN編號可選）
}

靜態數據中心IP購買

{
  "pid": 套餐ID, // 從 /ep/product 介面获取
  "pm_id": 支付方式ID, // 從 /ep/payment/list 或 /ep/payment/groups 介面获取
  "region_list": "JP,15,333|DE,10,444|US,5,555" // 格式：地區,數量,ASN|地區,數量,ASN（ASN編號可選）
}

動態住宅流量購買

{
  "pid": 套餐ID, // 從 /ep/product 介面获取
  "pm_id": 支付方式ID // 從 /ep/payment/list 或 /ep/payment/groups 介面获取
}

靜態轮换流量購買

{
  "pid": 套餐ID, // 從 /ep/product 介面获取
  "pm_id": 支付方式ID // 從 /ep/payment/list 或 /ep/payment/groups 介面获取
}

動態無限流量購買

{
  "pid": 套餐ID, // 從 /ep/product 介面获取
  "pm_id": 支付方式ID, // 從 /ep/payment/list 或 /ep/payment/groups 介面获取
  "product_sku_bandwidth_id": 頻寬規格ID,
  "product_sku_concurrency_id": 併發規格ID
}

餘額充值

{
  "pid": 套餐ID, // 從 /ep/product 介面获取
  "pm_id": 支付方式ID, // 從 /ep/payment/list 或 /ep/payment/groups 介面获取
  "recharge_amount": 充值金額
}

Body 請求參數

{
  "pid": 0,
  "upids": "string",
  "amount": 0,
  "pm_id": 0,
  "region_list": "string",
  "coupon_sn": "string",
  "use_invitation_registration_discount": true,
  "renew_duration": 0,
  "product_sku_bandwidth_id": 0,
  "product_sku_concurrency_id": 0,
  "product_sku_duration_id": 0,
  "etd": 1,
  "recharge_amount": 0
}

請求參數

名称位置類型必選說明
bodybodyobject是none
» pidbodyinteger是套餐ID，來自 /ep/product 介面返回的 id 字段
» upidsbodystring否續費套餐ID列表（逗号分隔），來自 /ep/user-product/list 或 /ep/ip/get-static-ip 介面返回的 id 字段
» amountbodynumber否新購套餐數量
» pm_idbodyinteger是支付方式ID，來自 /ep/payment/list 或 /ep/payment/groups 介面返回的 id 字段
» region_listbodystring否購買靜態IP时指定區域+數量+ASN編號，格式：地區,數量,ASN
» coupon_snbodystring否優惠券編號
» use_invitation_registration_discountbodyboolean否是否使用邀請註冊優惠
» renew_durationbodyinteger否續費時長-靜態IP可選
» product_sku_bandwidth_idbodyinteger否套餐11：頻寬套餐ID
» product_sku_concurrency_idbodyinteger否套餐11：併發套餐ID
» product_sku_duration_idbodyinteger否套餐type=11必填：時長規格ID
» etdbodyinteger否時長倍數，從套餐 extension_of_time_days 获取，2代表天數×2，價格上浮
» recharge_amountbodyinteger否套餐3：充值金額

返回範例

200 Response

{
  "code": 0,
  "message": "操作成功",
  "data": {
    "id": 0,
    "trade_no": "string",
    "out_trade_no": "string",
    "product_id": 0,
    "product_type": 0,
    "amount": 0,
    "unit_price": 0.1,
    "total_fee": 0.1,
    "goods_fee": 0.1,
    "pay_fee": 0.1,
    "discount_fee": 0.1,
    "handling_fee": 0.1,
    "refund_fee": 0.1,
    "pm_id": 0,
    "pm_title": "string",
    "pm_logo": "string",
    "status": 0,
    "title": "string",
    "detail": "string",
    "region_desc": "string",
    "pay_at": "2019-08-24T14:15:22Z",
    "pay_timestamp": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "pay_fee_status": 0,
    "invoice": {
      "name": "string",
      "org_name": "string",
      "first_name": "string",
      "last_name": "string",
      "phone": "string",
      "email": "user@example.com",
      "role_type": 0,
      "vat_id": "string",
      "address_country": "string",
      "address_city": "string",
      "address_line1": "string",
      "address_line2": "string",
      "address_postal_code": "string"
    }
  }
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK建立成功Inline

返回數据結構

POST 取消訂單

POST /ep/order/close

Body 請求參數

{
  "trade_no": "string"
}

請求參數

名称位置類型必選說明
bodybodyobject是none
» trade_nobodystring是none

返回結果

狀態碼狀態碼含义說明數據模型
200OK操作成功None

POST 訂單预检

POST /ep/order/check

建立訂單前调用，用于预览價格、折扣、IP續費明细等，不會实际建立訂單。 參數與 /ep/order/create 完全一致。

Body 請求參數

{
  "pid": 0,
  "upids": "string",
  "amount": 1,
  "pm_id": 0,
  "region_list": "string",
  "coupon_sn": "string",
  "renew_duration": "1m",
  "product_sku_bandwidth_id": 0,
  "product_sku_concurrency_id": 0,
  "product_sku_duration_id": 0,
  "etd": 1,
  "recharge_amount": 0
}

請求參數

名称位置類型必選說明
bodybodyobject是none
» pidbodyinteger是套餐ID
» upidsbodystring否IP續費：使用者套餐ID列表，逗号分隔
» amountbodyinteger否購買數量
» pm_idbodyinteger是支付方式ID
» region_listbodystring否靜態IP購買地區+數量，格式：地區ID,數量
» coupon_snbodystring否優惠券編號
» renew_durationbodystring否IP續費時長：1m=1个月，2m=2个月，em=下个月月底
» product_sku_bandwidth_idbodyinteger否套餐type=11必填：頻寬規格ID
» product_sku_concurrency_idbodyinteger否套餐type=11必填：併發規格ID
» product_sku_duration_idbodyinteger否套餐type=11必填：時長規格ID
» etdbodyinteger否時長倍數，從套餐 extension_of_time_days 获取
» recharge_amountbodynumber否套餐type=3必填：充值金額

枚舉值

屬性值
» renew_duration1m
» renew_duration2m
» renew_durationem

返回範例

200 Response

{
  "code": 0,
  "message": "操作成功",
  "data": {
    "product_id": 0,
    "amount": 0,
    "discount_fee": 0.1,
    "total_fee": 0.1,
    "pay_fee": 0.1,
    "product_type": 0,
    "title": "string",
    "detail": "string",
    "ip_result": [
      {
        "ip": "string",
        "price": 0.1,
        "country_code": "string",
        "current_time": "2019-08-24T14:15:22Z",
        "renewal_time": "2019-08-24T14:15:22Z",
        "country": {}
      }
    ]
  }
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK预检成功Inline

返回數据結構

支付管理

GET 获取支付方式列表

GET /ep/payment/list

請求參數

名称位置類型必選說明
trade_noquerystring否訂單號 - 部分訂單需要获取特定支付方式时可传入
currencyquerystring否貨幣单位

返回範例

200 Response

{
  "code": 0,
  "message": "操作成功",
  "data": {
    "list": [
      {
        "id": 0,
        "title": "string",
        "logo": "string",
        "group": "string",
        "handling_rate": 0,
        "handling_fee": 0,
        "disabled": false,
        "min": 0,
        "max": 0
      }
    ]
  }
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK获取成功Inline

返回數据結構

GET 获取支付方式列表

GET /ep/payment/groups

請求參數

名称位置類型必選說明
trade_noquerystring否訂單號 - 部分訂單需要获取特定支付方式时可传入

返回範例

200 Response

{
  "code": 0,
  "message": "操作成功",
  "data": {
    "list": [
      {
        "name": "string",
        "logos": [
          null
        ],
        "items": [
          null
        ]
      }
    ]
  }
}

返回結果

狀態碼狀態碼含义說明數據模型
200OK获取成功Inline

返回數据結構

营销

GET 充值赠金比例

GET /ep/activity/balance-recharge-gift-ratio

充值赠金比例

返回範例

200 Response

{
  "code": 0,
  "message": "操作成功",
  "data": {
    "list": [
      null
    ]
  }
}

返回結果

狀態碼狀態碼含义說明數據模型
200OKOKInline

返回數据結構

产品

GET 產品列表

GET /ep/product

获取當前站点可購買的套餐列表，支持按類型、有效期等条件篩選。

請求參數

名称位置類型必選說明
typequeryinteger否套餐類型，见 Product.type 枚举說明。不传则返回所有類型。
parent_product_typequeryinteger否父套餐類型，仅 type=19（IP續費）时有效，用于篩選产品线：14=數據中心 25=住宅
time_daysqueryany否有效期天數篩選，支持单值或陣列，如 30 / [30,90,365]
show_typequeryany否展示類型篩選，支持单值或陣列

詳細說明

type: 套餐類型，见 Product.type 枚举說明。不传则返回所有類型。

枚舉值

屬性值
parent_product_type14
parent_product_type25

返回範例

200 Response

{
  "code": 0,
  "message": "操作成功",
  "data": [
    {
      "id": 0,
      "title": "string",
      "type": 0,
      "show_type": 0,
      "status": 0,
      "price": 0.1,
      "usd_price": 0.1,
      "price_hkd": 0.1,
      "original_price": 0.1,
      "original_usd_price": 0.1,
      "original_price_hkd": 0.1,
      "local_price": 0.1,
      "local_original_price": 0.1,
      "preferred_currency": "string",
      "support_currencies": "string",
      "flow_value": 0.1,
      "flow_give": 0.1,
      "balance_give": 0.1,
      "balance_value": 0.1,
      "time_validity": 0.1,
      "time_price": 0.1,
      "time_days": 0,
      "tip1": "string",
      "tip2": "string",
      "introduce": [
        "string"
      ],
      "region_list_id": 0,
      "renew_product_list": "string",
      "parent_product_type": 0,
      "total_count": 0,
      "remain_count": 0,
      "extension_of_time_days": [
        0
      ],
      "time_days_price_rate": 0.1,
      "desc": {
        "subtitle": "string",
        "flow_value": 0.1,
        "flow_give": 0.1,
        "balance_give": 0.1,
        "time_validity": 0.1,
        "time_price": 0.1,
        "tip1": "string",
        "tip2": "string",
        "introduce": [
          null
        ]
      },
      "sku": {
        "bandwidth_list": [
          null
        ],
        "duration_list": [
          null
        ],
        "concurrency_list": [
          null
        ]
      }
    }
  ]
}

返回結果

狀態碼狀態碼含义說明數據模型
200OKOKInline

返回數据結構

數據模型

productTypes

9

套餐類型，9 動態住宅流量套餐、11 動態住宅IP、14靜態數據中心IP、25 靜態住宅IP

屬性

名称類型必選約束中文名說明
anonymousintegerfalsenone套餐類型，9 動態住宅流量套餐、11 動態住宅IP、14靜態數據中心IP、25 靜態住宅IP

枚舉值

屬性值
anonymous9
anonymous11
anonymous14
anonymous25

responseCode

200

狀態碼,200 成功、3 app_key 無效

屬性

名称類型必選約束中文名說明
anonymousintegerfalsenone狀態碼,200 成功、3 app_key 無效

SuccessResponse

{
  "code": 0,
  "message": "操作成功",
  "data": {}
}

屬性

名称類型必選約束中文名說明
codeintegerfalsenonenone
messagestringfalsenonenone
dataobjectfalsenonenone

Order

{
  "id": 0,
  "trade_no": "string",
  "out_trade_no": "string",
  "product_id": 0,
  "product_type": 0,
  "amount": 0,
  "unit_price": 0.1,
  "total_fee": 0.1,
  "goods_fee": 0.1,
  "pay_fee": 0.1,
  "discount_fee": 0.1,
  "handling_fee": 0.1,
  "refund_fee": 0.1,
  "pm_id": 0,
  "pm_title": "string",
  "pm_logo": "string",
  "status": 0,
  "title": "string",
  "detail": "string",
  "region_desc": "string",
  "pay_at": "2019-08-24T14:15:22Z",
  "pay_timestamp": 0,
  "created_at": "2019-08-24T14:15:22Z",
  "pay_fee_status": 0,
  "invoice": {
    "name": "string",
    "org_name": "string",
    "first_name": "string",
    "last_name": "string",
    "phone": "string",
    "email": "user@example.com",
    "role_type": 0,
    "vat_id": "string",
    "address_country": "string",
    "address_city": "string",
    "address_line1": "string",
    "address_line2": "string",
    "address_postal_code": "string"
  }
}

屬性

名称類型必選約束中文名說明
idintegerfalsenone訂單ID
trade_nostringfalsenone内部訂單編號
out_trade_nostringfalsenone外部訂單編號
product_idintegerfalsenone套餐ID
product_typeintegerfalsenone套餐類型，见產品類型枚举
amountintegerfalsenone購買數量
unit_pricenumber(float)falsenone單價
total_feenumber(float)falsenone訂單總價（不含折扣，含手續費）
goods_feenumber(float)falsenone商品價格（含折扣，不含手續費）
pay_feenumber(float)falsenone實付金額（含折扣，含手續費）
discount_feenumber(float)falsenone優惠金額
handling_feenumber(float)falsenone手續費
refund_feenumber(float)falsenone退款金額
pm_idintegerfalsenone支付方式ID（來自 /ep/payment/list）
pm_titlestringfalsenone支付方式名称
pm_logostringfalsenone支付方式Logo URL
statusintegerfalsenone訂單狀態
titlestringfalsenone套餐標題
detailstringfalsenone套餐描述
region_descstringfalsenone地區規格描述
pay_atstring(date-time)falsenone支付時間
pay_timestampintegerfalsenone支付時間戳
created_atstring(date-time)falsenone建立時間
pay_fee_statusintegerfalsenone長短款狀態：0正常 1長款（超額支付） 2短款
invoiceobjectfalsenone發票資訊（仅线上支付訂單有值）
» namestringfalsenone全名
» org_namestringfalsenone企業名稱
» first_namestringfalsenonenone
» last_namestringfalsenonenone
» phonestringfalsenonenone
» emailstring(email)falsenonenone
» role_typeintegerfalsenone1個人 2企業
» vat_idstringfalsenone稅號
» address_countrystringfalsenonenone
» address_citystringfalsenonenone
» address_line1stringfalsenonenone
» address_line2stringfalsenonenone
» address_postal_codestringfalsenonenone

OrderCheckResult

{
  "product_id": 0,
  "amount": 0,
  "discount_fee": 0.1,
  "total_fee": 0.1,
  "pay_fee": 0.1,
  "product_type": 0,
  "title": "string",
  "detail": "string",
  "ip_result": [
    {
      "ip": "string",
      "price": 0.1,
      "country_code": "string",
      "current_time": "2019-08-24T14:15:22Z",
      "renewal_time": "2019-08-24T14:15:22Z",
      "country": {
        "name_zh_cn": "string",
        "flag": "string",
        "square_flag": "string"
      }
    }
  ]
}

訂單预检結果

屬性

名称類型必選約束中文名說明
product_idintegerfalsenone套餐ID
amountintegerfalsenone數量
discount_feenumber(float)falsenone優惠金額
total_feenumber(float)falsenone訂單總额
pay_feenumber(float)falsenone實付金額
product_typeintegerfalsenone套餐類型
titlestringfalsenone套餐標題
detailstringfalsenone套餐描述
ip_result[object]falsenoneIP批量續費結果（仅IP續費时返回）
» ipstringfalsenonenone
» pricenumber(float)falsenonenone
» country_codestringfalsenonenone
» current_timestring(date-time)falsenonenone
» renewal_timestring(date-time)falsenonenone
» countryobjectfalsenonenone
»» name_zh_cnstringfalsenonenone
»» flagstringfalsenone圆形旗帜URL
»» square_flagstringfalsenone方形旗幟URL

Product

{
  "id": 0,
  "title": "string",
  "type": 0,
  "show_type": 0,
  "status": 0,
  "price": 0.1,
  "usd_price": 0.1,
  "price_hkd": 0.1,
  "original_price": 0.1,
  "original_usd_price": 0.1,
  "original_price_hkd": 0.1,
  "local_price": 0.1,
  "local_original_price": 0.1,
  "preferred_currency": "string",
  "support_currencies": "string",
  "flow_value": 0.1,
  "flow_give": 0.1,
  "balance_give": 0.1,
  "balance_value": 0.1,
  "time_validity": 0.1,
  "time_price": 0.1,
  "time_days": 0,
  "tip1": "string",
  "tip2": "string",
  "introduce": [
    "string"
  ],
  "region_list_id": 0,
  "renew_product_list": "string",
  "parent_product_type": 0,
  "total_count": 0,
  "remain_count": 0,
  "extension_of_time_days": [
    0
  ],
  "time_days_price_rate": 0.1,
  "desc": {
    "subtitle": "string",
    "flow_value": 0.1,
    "flow_give": 0.1,
    "balance_give": 0.1,
    "time_validity": 0.1,
    "time_price": 0.1,
    "tip1": "string",
    "tip2": "string",
    "introduce": [
      "string"
    ]
  },
  "sku": {
    "bandwidth_list": [
      {
        "id": 0,
        "value": 0,
        "price": 0.1,
        "price_usd": 0.1,
        "price_hkd": 0.1
      }
    ],
    "duration_list": [
      {
        "id": 0,
        "value": 0,
        "price": 0.1,
        "price_usd": 0.1,
        "price_hkd": 0.1
      }
    ],
    "concurrency_list": [
      {
        "id": 0,
        "value": 0,
        "price": 0.1,
        "price_usd": 0.1,
        "price_hkd": 0.1
      }
    ]
  }
}

屬性

名称類型必選約束中文名說明
idintegerfalsenone套餐ID
titlestringfalsenone套餐主標題
typeintegerfalsenone套餐類型
show_typeintegerfalsenone展示類型：1普通 2大额推荐 3不可購買（需定制） 4试用
statusintegerfalsenone狀態：1上架 0下架
pricenumber(float)falsenone人民幣價格
usd_pricenumber(float)falsenone美元價格
price_hkdnumber(float)falsenone港幣價格
original_pricenumber(float)falsenone原價（CNY）
original_usd_pricenumber(float)falsenone原價（USD）
original_price_hkdnumber(float)falsenone原價（HKD）
local_pricenumber(float)falsenone本地化價格（依赖 preferred_currency）
local_original_pricenumber(float)falsenone本地化原價（依赖 preferred_currency）
preferred_currencystringfalsenone推荐显示貨幣，如 usd / cny / hkd
support_currenciesstringfalsenone支持的貨幣列表，逗号分隔，如 usd,cny
flow_valuenumber(float)falsenone流量套餐預設流量（GB）
flow_givenumber(float)falsenone贈送流量（GB）
balance_givenumber(float)falsenone餘額充值贈送金額
balance_valuenumber(float)falsenone充值金額
time_validitynumber(float)falsenone包量套餐預設有效時長
time_pricenumber(float)falsenone包量套餐每IP價格
time_daysintegerfalsenone有效期天數，如 30/90/180/365
tip1stringfalsenone標籤說明1
tip2stringfalsenone標籤說明2
introduce[string]falsenone文本介紹列表
region_list_idintegerfalsenone地區ID
renew_product_liststringfalsenone可续订套餐ID列表（逗号分隔）
parent_product_typeintegerfalsenone父套餐類型（type=19时有效）：14或25
total_countintegerfalsenone總庫存，0表示不限制
remain_countintegerfalsenone剩餘庫存
extension_of_time_days[integer]falsenone時長倍數列表，為空或仅含1表示不支持
time_days_price_ratenumber(float)falsenone時長價格係數，價格 × (1 + (倍數-1) × rate)
descobjectfalsenone套餐描述信息
» subtitlestringfalsenone副標題
» flow_valuenumber(float)falsenonenone
» flow_givenumber(float)falsenonenone
» balance_givenumber(float)falsenonenone
» time_validitynumber(float)falsenonenone
» time_pricenumber(float)falsenonenone
» tip1stringfalsenonenone
» tip2stringfalsenonenone
» introduce[string]falsenonenone
skuobjectfalsenone規格參數（type=11时返回）
» bandwidth_list[object]falsenone頻寬規格列表
»» idintegerfalsenonenone
»» valueintegerfalsenone頻寬值（Mbps）
»» pricenumber(float)falsenonenone
»» price_usdnumber(float)falsenonenone
»» price_hkdnumber(float)falsenonenone
» duration_list[object]falsenone時長規格列表
»» idintegerfalsenonenone
»» valueintegerfalsenone時長（天）
»» pricenumber(float)falsenonenone
»» price_usdnumber(float)falsenonenone
»» price_hkdnumber(float)falsenonenone
» concurrency_list[object]falsenone併發規格列表
»» idintegerfalsenonenone
»» valueintegerfalsenone併發數
»» pricenumber(float)falsenonenone
»» price_usdnumber(float)falsenonenone
»» price_hkdnumber(float)falsenonenone

Pagination

{
  "total": 0,
  "page_no": 0,
  "page_size": 0,
  "total_pages": 0
}

屬性

名称類型必選約束中文名說明
totalintegerfalsenonenone
page_nointegerfalsenonenone
page_sizeintegerfalsenonenone
total_pagesintegerfalsenonenone