华为云用户手册

请求示例 切换目标网络为移动 POST https://{endpoint}/v1/sim-cards-multiply/{sim_card_id}/switch-network { "carrier_type" : 1 } 使用cid切换目标网络为移动 POST https://{endpoint}/v1/sim-cards-multiply/0/switch-network { "carrier_type" : 1, "cid" : "88888888888881" }

响应示例 状态码： 200 OK { "work_order_id" : 1000001 } 状态码： 400 Parameter Invalid { "error_code" : "GSL.00010004", "error_msg" : "参数异常" } 状态码： 500 Internal Server Error { "error_code" : "GSL.00010003", "error_msg" : "系统繁忙，请稍后重试。" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 speed_value 是 Integer 限制带宽速率，单位 Kbps，-1表示不限速,1Mbps=1024Kbps。正整数表示限制到当前速率，电信支持限制速率:1Kbps,64 Kbps,256 Kbps,512Kbps,1Mbs，3Mbs,5Mbs,7Mbs,10Mbs,20Mbs,30Mbs,40Mbs,50Mbs,60Mbs,70Mbs,80Mbs,90Mbs,100Mbs,110Mbs,120Mbs,130Mbs,140Mbs,150Mbs。联通支持限制速率:256Kbps,512Kbps,1Mbps,2Mbps,7.25Mbps。 最小值：-1 iccid 否 String iccid，传入的sim_card_id为0,则根据iccid进行处理 最小长度：19 最大长度：20

响应示例 状态码： 200 OK { "work_order_id" : 1000001 } 状态码： 400 Parameter Invalid { "error_code" : "GSL.00010004", "error_msg" : "参数异常" } 状态码： 500 Internal Server Error { "error_code" : "GSL.00010003", "error_msg" : "系统繁忙，请稍后重试。" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 work_order_id Long 业务受理单号 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

请求示例 创建SIM卡限速的申请。限制指定sim_card_id卡片的带宽速率为1024Kbps。 POST https://{endpoint}/v1/sim-cards/{sim_card_id}/speed-limit { "speed_value" : 1024 } 创建SIM卡限速的申请。当参数sim_card_id为最小值时，限制SIM卡标识iccid为“898600xxxxxxxxxx”的带宽速率为1024Kbps POST https://{endpoint}/v1/sim-cards/{sim_card_id}/speed-limit { "iccid" : "898600xxxxxxxxxx", "speed_value" : 1024 }

响应示例 状态码： 200 OK { "limit" : 10, "offset" : 1, "count" : 1, "price_plans" : [ { "price_plan_id" : "100000", "price_plan_name" : "中国电信消费级每月30M联接服务（1年）", "description" : "中国电信消费级每月30M联接服务（1年）", "flow_total" : 10, "package_type" : 1, "period" : 1, "period_type" : 20, "effect_type" : 1, "silent_period_day" : 6, "silent_period_unit" : 2, "auto_renew" : false, "location_desc" : "中国", "location_type" : 1, "sim_type" : 3, "carrier_type" : 2, "price" : 1 } ] } 状态码： 400 Parameter Invalid { "error_code" : "GSL.00010004", "error_msg" : "参数异常" } 状态码： 500 Internal Server Error { "error_code" : "GSL.00010003", "error_msg" : "系统繁忙，请稍后重试。" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 limit Long 每页的记录数 最小值：10 最大值：500 offset Long 页码，最小值是1，最大值为1000000。默认值是1. 最小值：1 最大值：1000000 count Long 记录总数 最小值：0 price_plans Array of ProPricePlanVo objects 套餐列表 表4 ProPricePlanVo 参数 参数类型 描述 price_plan_id String 套餐ID price_plan_name String 套餐名称 description String 描述 flow_total Long 流量总量(MB) package_type Integer 套餐类型 1基础套餐;2叠加包套餐;如果是国际漫游不区分基础套餐包和叠加包 period Integer 套餐周期 period_type Integer 套餐周期类型 10:日;20:月;30:季;40:半年;50:年 effect_type Integer 套餐生效类型 1.订购后激活使用时生效 2.订购即时生效 3.订购下个月开始生效 silent_period_day Integer 沉默期 silent_period_unit Integer 沉默期单位 1.年 2.月 3.日 auto_renew Boolean 是否自动续订 location_desc String 套餐适用区域 location_type Integer 区域 1.中国 2.欧洲 3.大洋洲 4.非洲 5.亚太 sim_type Integer SIM卡类型 1.vSIM 2.eSIM 3.实体卡 carrier_type Integer 运营商 1中国移动（实体卡） 2中国电信（实体卡） 3中国联通（实体卡） 4海外运营商（实体卡） esim/vsim: 101.中国移动 102.中国电信 201.欧洲 501.中国香港 502.中国澳门 503.泰国 504.日本 505.柬埔寨 506.印度尼西亚 507.马来西亚 508.新加坡 509.斯里兰卡 510.中国台湾 511.孟加拉 price Integer 价格(分) 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

URI GET /v1/price-plans 表1 Query参数 参数 是否必选 参数类型 描述 limit 否 Long 分页查询时每页显示的记录数，默认值为10，取值范围为10-500的整数 最小值：10 最大值：500 缺省值：10 offset 否 Long 分页查询时的页码数，默认值为1，取值范围为1-1000000的整数 最小值：1 最大值：1000000 缺省值：1 main_search_key 否 String 查询关键标识类型：套餐名称 例如中国移动消费级每月30M联接服务（1年） 最大长度：256 flow_total 否 Long 流量总量(MB) 最小值：0 network_type 否 Long 网络制式 1.2g,3g,4g 2.NB 最小值：0 location_type 否 Long 覆盖区域:1. 中国 2. 欧洲 3. 大洋洲 4. 非洲 5. 亚太 最小值：0 carrier_type 否 Integer 运营商 1中国移动（实体卡） 2中国电信（实体卡） 3中国联通（实体卡） 4海外运营商（实体卡） esim/vsim: 101.中国移动 102.中国电信 201.欧洲 501.中国香港 502.中国澳门 503.泰国 504.日本 505.柬埔寨 506.印度尼西亚 507.马来西亚 508.新加坡 509.斯里兰卡 510.中国台湾 511.孟加拉 最小值：0 country_type 否 Long 国家/地区 1中国香港，2中国澳门，3泰国，4日本，5，柬埔寨，6印尼，7马来西亚，8新加坡，9斯里兰卡，10中国台湾，11孟加拉 最小值：0

响应示例 状态码： 200 OK [ { "id" : 100000000000, "account_id" : "04eexxxxxxxxxx", "sim_card_id" : 100000000000, "price_plan_id" : "10001", "price_plan_name" : "中国联通消费级每月30M联接服务（1年）", "iccid" : "898606xxxxxxxxxxxx", "flow_total" : 30, "flow_used" : 0, "flow_left" : 30 }, { "id" : 100000000001, "account_id" : "04eexxxxxxxxxx", "sim_card_id" : 100000000001, "price_plan_id" : "10001", "price_plan_name" : "中国联通消费级每月30M联接服务（1年）", "iccid" : "898607xxxxxxxxxxxx", "flow_total" : 30, "flow_used" : 0, "flow_left" : 30 } ] 状态码： 400 Parameter Invalid { "error_code" : "GSL.00010004", "error_msg" : "参数异常" } 状态码： 403 Forbidden { "error_code" : "GSL.00010001", "error_msg" : "请求携带的token无效。" } 状态码： 500 Internal Server Error { "error_code" : "GSL.00010003", "error_msg" : "系统繁忙，请稍后重试。" }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表2 请求Body参数 参数 是否必选 参数类型 描述 iccids 否 Array of strings iccid列表（三网卡不支持），最大支持50，且iccid和sim_card_id列表二选一 最大长度：64 数组长度：0 - 50 sim_card_ids 否 Array of longs sim_card_id列表，最大支持50，且iccid和sim_card_id列表二选一 最小值：0 数组长度：0 - 50

请求示例 批量查询SIM卡标识为“898606xxxxxxxxxxxx”和“898607xxxxxxxxxxxx”的流量详情。 POST https://{endpoint}/v1/sim-price-plans/usage/batch-query { "iccids" : [ "898606xxxxxxxxxxxx", "898607xxxxxxxxxxxx" ] } 批量查询SIM卡ID为“100000000000”和“100000000001”的流量详情。 POST https://{endpoint}/v1/sim-price-plans/usage/batch-query { "sim_card_ids" : [ 100000000000, 100000000001 ] }

请求示例 新增无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 表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

请求参数 表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

响应示例 状态码： 400 Parameter Invalid 示例 1 { "error_code" : "GSL.00010001", "error_msg" : "请求携带的token无效。" } 示例 2 { "error_code" : "GSL.00012016", "error_msg" : "SIM卡文件不存在，请检查！" } 示例 3 { "error_code" : "GSL.000160051", "error_msg" : "SIM卡数量必须介于1和500之间，请重新输入！" } 示例 4 { "error_code" : "GSL.000160052", "error_msg" : "标签数量必须介于0-10之间，请重新输入！" } 示例 5 { "error_code" : "GSL.000160053", "error_msg" : "以下simCardId/tagId不存在或没有操作权限，请重新输入！simCardId/tagId : [-3333, 111, 656565465]" } 示例 6 { "error_code" : "GSL.000160054", "error_msg" : "以下simCardId/tagId重复，请重新输入！simCardId/tagId : [2, 3]" } 状态码： 500 Internal Server Error { "error_code" : "GSL.00010003", "error_msg" : "系统繁忙，请稍后重试。" }

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 file_temp_id 否 Long 临时文件ID sim_card_ids 否 Array of longs SIM卡id列表，最多500.sim_card_ids与iccids不能同时为空，sim_card_ids参数为空则根据iccids参数处理 最小值：0 数组长度：0 - 500 iccids 否 Array of strings iccid列表，最多支持传入500个iccid。sim_card_ids与iccids不能同时为空，sim_card_ids参数为空则根据iccids参数处理 最小长度：19 最大长度：20 数组长度：0 - 500 tag_ids 否 Array of longs 绑定的标签id列表，最多10 最小值：0 数组长度：0 - 10

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 - Boolean OK 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 最大长度：64 error_msg String 错误描述 最大长度：512 状态码： 500 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最大长度：64 error_msg String 错误描述 最大长度：512

请求示例 批量设置/取消设置标签。指定SIM卡ID“123456”和“234567”绑定标签“123”。 POST https://{endpoint}/v1/sim-tags/batch-set { "sim_card_ids" : [ 123456, 234567 ], "tag_ids" : [ 123 ] } 批量设置/取消标签。当参数sim_card_ids不传或长度为0时，指定SIM卡iccid“898606xxxxxxxxxxxx”和“898601xxxxxxxxxxxx”绑定标签“123”。 POST https://{endpoint}/v1/sim-tags/batch-set { "sim_card_ids" : [ ], "iccids" : [ "898606xxxxxxxxxxxx", "898601xxxxxxxxxxxx" ], "tag_ids" : [ 123 ] }

响应示例 状态码： 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" : "系统繁忙，请稍后重试。" }

URI GET /v1/network-switch-policies 表1 Query参数 参数 是否必选 参数类型 描述 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 网络切换策略实例列表 表3 NetworkSwitchPolicyVO 参数 参数类型 描述 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

响应示例 状态码： 400 Bad Request 示例 1 { "error_code" : "GSL.00020004", "error_msg" : "参数异常" } 示例 2 { "error_code" : "GSL.00027005", "error_msg" : "登录用户没有自定义属性的访问权限。" } 状态码： 500 Internal Server Error { "error_code" : "GSL.00020003", "error_msg" : "系统繁忙，请稍后重试。" }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 - Boolean OK 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 最大长度：64 error_msg String 错误描述 最大长度：512 状态码： 500 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最大长度：64 error_msg String 错误描述 最大长度：512

请求示例 查询SIM卡的历史月用量，卡ID为“4710226018477568”，账期为“2022-07”。 POST https://{endpoint}/v1/sim-cards/month-usages { "sim_card_ids" : [ 4710226018477568 ], "billing_cycles" : [ "2022-07" ] } 查询SIM卡的历史月用量。当参数sim_card_ids不传或长度为0时，根据iccids，查询卡标识为“8695xxxxxxxx”的历史月用量，账期为“2022-07”。 POST https://{endpoint}/v1/sim-cards/month-usages { "iccids" : [ "8695xxxxxxxx" ], "billing_cycles" : [ "2022-07" ] }

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 sim_card_ids 否 Array of longs sim卡id列表，最多支持传入500个SIM卡id。sim_card_ids与iccids不能同时为空，sim_card_ids参数为空则根据iccids参数处理 最小值：0 数组长度：0 - 500 iccids 否 Array of strings iccid列表，最多支持传入500个iccid。sim_card_ids与iccids不能同时为空，sim_card_ids参数为空则根据iccids参数处理 最小长度：19 最大长度：20 数组长度：0 - 500 billing_cycles 是 Array of strings 账期，最多支持传入本月在内的6个月账期，例如[2022-07, 2022-06]，不支持传入未来账期。 最小长度：0 最大长度：7 数组长度：0 - 6

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 month_usages Array of MonthUsageVo objects 月用量列表 表3 MonthUsageVo 参数 参数类型 描述 sim_card_id Long SIM卡ID 最小值：0 iccid String iccid 最小长度：0 flow_usages Array of FlowUsageVo objects 月用量 表4 FlowUsageVo 参数 参数类型 描述 billing_cycle String 账期 flow_used Double 已用流量（MB） 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 OK { "month_usages" : [ { "sim_card_id" : 4710226018477568, "iccid" : "8695xxxxxxxx", "flow_usages" : [ { "billing_cycle" : "202207", "flow_used" : 85.27 } ] } ] } 状态码： 400 Parameter Invalid { "error_code" : "GSL.00010004", "error_msg" : "参数异常" } 状态码： 500 Internal Server Error { "error_code" : "GSL.00010003", "error_msg" : "系统繁忙，请稍后重试。" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 limit Long 每页记录数 offset Long 页码 count Long 当前流量池的成员总数 pool_members Array of BackPoolMemVO objects 查询出来的流量池成员记录列表 表5 BackPoolMemVO 参数 参数类型 描述 id Long 流量池标识 cid String 容器ID 最大长度：64 sim_price_plan_id Long 套餐订购实例ID flow_used Double 已用流量(查询账期所在月份), 单位MB 最小值：0 sim_status Integer 卡当前状态：11-未激活，13-可激活，14-已停用，20-在用，30-已拆机 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 403 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息