# 查询策略列表 - ListNetworkSwitchPolicies #### 功能介绍 查询策略列表 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/GSL/doc?api=ListNetworkSwitchPolicies)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ocgsl/gsl_07_0026.html)。 #### URI GET /v1/network-switch-policies 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | policy_name | 否 | String | 策略名称 最大长度：**32** | | version | 否 | Integer | 三网卡版本信息，1:SDK版，2:无SDK版 最小值：**1** 最大值：**2** | | limit | 否 | Long | 分页查询时每页显示的记录数，默认值为10，取值范围为10-500的整数 最小值：**10** 最大值：**500** 缺省值：**10** | | offset | 否 | Long | 分页查询时的页码数，默认值为1，取值范围为1-1000000的整数 最小值：**1** 最大值：**1000000** 缺省值：**1** | #### 请求参数 无 #### 响应参数 **状态码：200** 表2响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | limit | Long | 每页的记录数 最小值：**10** 最大值：**500** | | offset | Long | 页码，最小值是1，最大值为1000000。默认值是1. 最小值：**1** 最大值：**1000000** | | count | Long | 记录总数 最小值：**0** | | network_switch_policy_list | Array of [NetworkSwitchPolicyVO] objects | 网络切换策略实例列表 | 表3NetworkSwitchPolicyVO | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Long | 策略主键id | | 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** | | create_time | String | 创建时间 | | modify_time | String | 修改时间 | | status | Integer | 状态,1:启用、0:禁用 | | type | Integer | 策略类型,0:系统策略,1:私有策略 | | used | Boolean | 策略是否已被使用过，即是否已被执行过策略切换，false：未被使用过，true：已被使用过 缺省值：**false** | | version | Integer | 版本枚举，1:SDK版 2:无SDK版 | | switch_order | String | 无SDK版本特有字段。切卡顺序，运营商以英文逗号分隔，1:移动，2:电信，3:联通 最大长度：**10** | | blacklist | Integer | 无SDK版本特有字段。黑名单，只支持单个运营商，1:移动，2:电信，3:联通 最小值：**0** 最大值：**3** | **状态码：400** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 最大长度：**64** | | error_msg | String | 错误描述 最大长度：**512** | **状态码：500** 表5响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | 错误码 最大长度：**64** | | error_msg | String | 错误描述 最大长度：**512** | #### 请求示例 - 查询无SDK版本三网卡策略列表 ``` GET https://{endpoint}/v1/network-switch-policies&version=2 ``` - 查询SDK版本三网卡策略列表 ``` GET https://{endpoint}/v1/network-switch-policies&version=1 ``` #### 响应示例 **状态码：200** OK - 示例 1 ``` { "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 } ] } ``` - 示例 2 ``` { "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 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-ocgsl/ErrorCode.html)。