查询策略列表
功能介绍
查询策略列表
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/network-switch-policies
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
policy_name |
否 |
String |
策略名称 |
version |
否 |
Integer |
三网卡版本信息 1:SDK版 2:无SDK版 |
limit |
否 |
Long |
分页查询时每页显示的记录数,默认值为10,取值范围为10-500的整数 |
offset |
否 |
Long |
分页查询时的页码数,默认值为1,取值范围为1-1000000的整数 |
请求参数
无
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
limit |
Long |
每页的记录数 |
offset |
Long |
页码,最小值是1,最大值为1000000。默认值是1 |
count |
Long |
记录总数 |
network_switch_policy_list |
Array of NetworkSwitchPolicyVO objects |
网络切换策略实例列表 |
参数 |
参数类型 |
描述 |
---|---|---|
id |
Long |
策略主键ID |
policy_name |
String |
策略名称 |
preferred_carrier |
Integer |
最优选运营商,仅对SDK版本生效。 1:移动 2:电信 3:联通 4:上次使用的运营商 |
least_preferred_carrier |
Integer |
最不优选运营商,仅对SDK版本生效。 1:移动 2:电信 3:联通 |
optimal_signal |
Boolean |
最优信号选取策略是否开启,仅对SDK版本生效。 true:开启 false:不开启 |
auto_switch |
Boolean |
自动切卡是否开启,仅对SDK版本生效。 true:开启 false:不开启 |
weak_signal_switch |
Boolean |
弱信号切换策略是否开启,仅对SDK版本生效。 true:开启 false:不开启 |
connect_ip |
String |
连接延时切换策略,连接延时时需要ping的ip地址,仅对SDK版本生效。 |
create_time |
String |
创建时间 |
modify_time |
String |
修改时间 |
status |
Integer |
状态 1:启用 0:禁用 |
type |
Integer |
策略类型 0:系统策略 1:私有策略 |
used |
Boolean |
策略是否已被使用过,即是否已被执行过策略切换。 false:未被使用过 true:已被使用过 |
version |
Integer |
版本枚举 1:SDK版 2:无SDK版 |
switch_order |
String |
切卡顺序,运营商以英文逗号分隔,无SDK版本特有字段。 1:移动 2:电信 3:联通 |
blacklist |
Integer |
黑名单,只支持单个运营商,无SDK版本特有字段。 1:移动 2:电信 3:联通 |
状态码: 400
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
状态码: 500
参数 |
参数类型 |
描述 |
---|---|---|
error_code |
String |
错误码 |
error_msg |
String |
错误描述 |
请求示例
响应示例
状态码: 200
OK
-
{ "limit" : 10, "offset" : 1, "count" : 1, "network_switch_policy_list" : [ { "id" : 1111111111111111, "policy_name" : "默认策略无SDK版", "preferred_carrier" : null, "least_preferred_carrier" : null, "optimal_signal" : false, "auto_switch" : false, "weak_signal_switch" : null, "connect_ip" : null, "create_time" : "2023-11-01T08:00:00.000+00:00", "modify_time" : "2023-11-01T08:00:00.000+00:00", "status" : 1, "type" : 0, "used" : true, "version" : 2, "switch_order" : "3,1,2", "blacklist" : 0 } ] }
-
{ "limit" : 10, "offset" : 1, "count" : 1, "network_switch_policy_list" : [ { "id" : 1000000000000000, "policy_name" : "默认策略", "preferred_carrier" : 3, "least_preferred_carrier" : 2, "optimal_signal" : false, "auto_switch" : true, "weak_signal_switch" : true, "connect_ip" : null, "create_time" : "2023-11-01T08:00:00.000+00:00", "modify_time" : "2023-11-01T08:00:00.000+00:00", "status" : 1, "type" : 0, "used" : true, "version" : 1, "switch_order" : null, "blacklist" : 0 } ] }
状态码: 400
Parameter Invalid
{ "code" : "GSL.00010004", "message" : "参数异常" }
状态码: 500
Internal Server Error
{ "code" : "GSL.00010003", "message" : "系统繁忙,请稍后重试。" }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
400 |
Parameter Invalid |
500 |
Internal Server Error |
错误码
请参见错误码。