文档首页/ 全球SIM联接 GSL/ API参考/ API列表/ 三网卡策略管理/ 新增网络切换策略
更新时间：2024-10-14 GMT+08:00
查看PDF
分享

新增网络切换策略

功能介绍

新增网络切换策略

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v1/network-switch-policies

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

policy_name

否

String

策略名称

最大长度：32

preferred_carrier

否

Integer

仅对SDK版本生效。最优选运营商,1:移动、2:电信、3:联通、4:上次使用的运营商

最小值：1

最大值：4

缺省值：3

least_preferred_carrier

否

Integer

仅对SDK版本生效。最不优选运营商,1:移动、2:电信、3:联通

最小值：1

最大值：3

缺省值：2

optimal_signal

否

Boolean

仅对SDK版本生效。最优信号选取策略是否开启,true:开启,false:不开启

缺省值：false

auto_switch

否

Boolean

仅对SDK版本生效。自动切卡是否开启,true:开启,false:不开启

缺省值：false

weak_signal_switch

否

Boolean

仅对SDK版本生效。弱信号切换策略是否开启,true:开启,false:不开启

connect_ip

否

String

仅对SDK版本生效。连接延时切换策略，连接延时时需要ping的ip地址

最大长度：64

version

是

Integer

版本枚举,1:SDK版，2:无SDK版

switch_order

否

String

仅对无SDK版本生效。切卡顺序，运营商以英文逗号分隔，1:移动，2:电信，3:联通

最大长度：10

blacklist

否

Integer

仅对无SDK版本生效。黑名单，只支持单个运营商，1:移动，2:电信，3:联通

最小值：0

最大值：3

响应参数

状态码： 200

表2 响应Body参数

参数

参数类型

描述

-

Boolean

OK

状态码： 400

表3 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最大长度：64

error_msg

String

错误描述

最大长度：512

状态码： 403

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最大长度：64

error_msg

String

错误描述

最大长度：512

状态码： 500

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

最大长度：64

error_msg

String

错误描述

最大长度：512

请求示例

  • 新增无SDK版本三网卡策略

    POST https://{endpoint}/v1/network-switch-policies

{
  "policy_name" : "testaa",
  "version" : 2,
  "blacklist" : 1,
  "switch_order" : "3,1,2"
}

  • 新增SDK版本三网卡策略

    POST https://{endpoint}/v1/network-switch-policies

{
  "policy_name" : "test_sdk",
  "version" : 1,
  "preferred_carrier" : 3,
  "least_preferred_carrier" : 2,
  "blacklist" : 0,
  "optimal_signal" : true,
  "auto_switch" : true,
  "weak_signal_switch" : true,
  "connect_ip" : "www.example.com"
}

响应示例

状态码： 400

Parameter Invalid

{
  "error_code" : "GSL.00010001",
  "error_msg" : "参数异常"
}

状态码： 403

Forbidden

{
  "error_code" : "GSL.00010002",
  "error_msg" : "请求的内容不存在"
}

状态码： 500

Internal Server Error

{
  "error_code" : "GSL.00010004",
  "error_msg" : "系统繁忙，请稍后重试。"
}

状态码

状态码

描述

200

OK

400

Parameter Invalid

403

Forbidden

500

Internal Server Error

错误码

请参见错误码。

父主题： 三网卡策略管理

相关文档