华为云用户手册

URI GET /v1/work-orders 表1 Query参数 参数 是否必选 参数类型 描述 main_search_key 否 String 业务受理ID 最小长度：0 最大长度：17 limit 否 Long 分页查询时每页显示的记录数，默认值为10，取值范围为10-500的整数 最小值：10 最大值：500 缺省值：10 offset 否 Long 分页查询时的页码数，默认值为1，取值范围为1-1000000的整数 最小值：1 最大值：1000000 缺省值：1 sim_type 否 Integer SIM卡类型: 1.vSIM 2.eSIM 3.实体卡 最小值：1 最大值：10 work_order_type 否 Integer 业务受理类型：1.批量激活实体卡 2.批量转移实体卡 3.创建流量池 4.实体卡复机 5.实体卡停机 6.批量启用或复机 7.批量停用或停机 8.批量订购 9.批量退订 10.实体卡激活 11.申请断网 12.达量断网 13.机卡重绑 14.实名制信息清除 15.实体卡限速 16.批量补卡 17.批量机卡重绑 18.重启已废弃后向流量池 19.批量达量断网 20断网恢复 21取消达量断网 22批量取消达量断网 23批量拆机 最小值：1 最大值：99 status 否 Integer 业务受理状态:：1审核中、2已审核、3处理中、4已完成、5已取消、6失败、7 审核不通过 最小值：1 最大值：7

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 limit Long 每页的记录数 最小值：10 最大值：500 offset Long 页码，最小值是1，最大值为1000000。默认值是1. 最小值：1 最大值：1000000 count Long 记录总数 最小值：0 work_orders Array of WorkOrderVo objects 业务受理单列表 表3 WorkOrderVo 参数 参数类型 描述 id Long 业务受理ID sim_type Integer SIM卡类型: 1.vSIM 2.eSIM 3.实体卡 work_order_type Integer 业务受理类型：1.批量激活实体卡 2.批量转移实体卡 3.创建流量池 4.实体卡复机 5.实体卡停机 6.批量启用或复机 7.批量停用或停机 8.批量订购 9.批量退订 10.实体卡激活 11.申请断网 12.达量断网 13.机卡重绑 14.实名制信息清除 15.实体卡限速 16.批量补卡 17.批量机卡重绑 18.重启已废弃后向流量池 19.批量达量断网 20断网恢复 21取消达量断网 22批量取消达量断网 23批量拆机 req_detail String 请求详情 total_count Integer 业务受理明细总数 success_count Integer 业务受理明细成功数 fail_count Integer 业务受理明细失败数 process_count Integer 业务受理明细处理中数 status Integer 业务受理状态：1审核中、2已审核、3处理中、4已完成、5已取消、6失败、7 审核不通过 create_time String 创建时间 finish_time String 完成时间 fail_reason String 失败原因 response String 响应内容 work_order_source Integer 业务受理单来源,1:运营人员生成,2:用户操作生成(console),3:自动化规则生成,4:后向流量池超阈值停用次月自动复机任务,5:单卡没流量停机定时任务,6:SIM卡到期自动停机定时任务,7:流量池停机定时任务,8:用户操作生成(api) work_order_source_desc String 业务受理单来源描述 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 limit Long 每页记录数 offset Long 页码 count Long 总数 sim_cards Array of SimDeviceMultiplyVO objects 三网卡数据集合 表3 SimDeviceMultiplyVO 参数 参数类型 描述 sim_card_id Long SIM卡标识 cid String 三网卡标识 iccid_mobile String 移动网络iccid iccid_unicom String 联通网络iccid iccid_telcom String 电信网络iccid online_carrier Integer 在线运营商标识，1：中国移动 2：中国电信 3:中国联通 network_switch_policy_id Long 网络切换策略id policy_name String 网络切换策略名称 version Integer 版本信息，1:SDK版，2:无SDK版 order_id Long 批次号 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

URI GET /v1/sim-cards-multiply 表1 Query参数 参数 是否必选 参数类型 描述 order_id 否 Long 批次号 最小长度：1 最大长度：20 cid 否 String cid 最小长度：1 最大长度：20 iccid 否 String iccid 最小长度：1 最大长度：20 online_carrier 否 Integer 在线运营商标识 最小值：1 最大值：3 sim_card_id 否 Long SIM卡标识 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 OK { "limit" : 10, "offset" : 1, "count" : 1, "sim_cards" : [ { "sim_card_id" : "1234XXXXXX", "cid" : "13152562XXXXX", "iccid_mobile" : "89860061XXXXX", "iccid_unicom" : "89860161XXXXX", "iccid_telcom" : "8986033XXXXX", "order_id" : 123456789, "online_carrier" : 1, "network_switch_policy_id" : 1111111111111111, "policy_name" : "默认策略无SDK版", "version" : 2 } ] } 状态码： 400 Bad Request { "error_code" : "GSL.00010004", "error_msg" : "参数异常" } 状态码： 500 Internal Server Error { "error_code" : "GSL.00010003", "error_msg" : "系统繁忙，请稍后重试。" }

响应示例 状态码： 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

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 limit Long 每页记录数 offset Long 页码 count Long 记录总数 attributes Array of CmAttributeVO objects 自定义属性记录 表3 CmAttributeVO 参数 参数类型 描述 id Long 自定义属性标识 default_attr_name_cn String 默认属性名称中文 最大长度：32 default_attr_name_en String 默认属性名称英文 最大长度：32 cust_attr_name String 自定义属性名称 最大长度：32 status Integer 自定义属性状态：0 未启用，1 已启用。 create_time String 创建时间 modify_time String 更新时间 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最大长度：64 error_msg String 错误描述 最大长度：512 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最大长度：64 error_msg String 错误描述 最大长度：512

URI GET /v1/attributes 表1 Query参数 参数 是否必选 参数类型 描述 cust_attr_name 否 String 自定义属性名称 最大长度：32 limit 否 Long 分页查询时每页显示的记录数，默认值为10，取值范围为10-500的整数 最小值：10 最大值：500 缺省值：10 offset 否 Long 分页查询时的页码数，默认值为1，取值范围为1-1000000的整数 最小值：1 最大值：1000000 缺省值：1 status 否 Integer 自定义属性状态：0 未启用，1 已启用。 最小值：0 最大值：1

响应示例 状态码： 400 Bad Request 示例 1 { "error_code" : "GSL.00020004", "error_msg" : "参数异常" } 示例 2 { "error_code" : "GSL.00022001", "error_msg" : "标签名称不合法，请检查！" } 示例 3 { "error_code" : "GSL.00022002", "error_msg" : "标签名称已存在，请重新输入！" } 示例 4 { "error_code" : "GSL.00022003", "error_msg" : "登录用户最多可以创建10000个标签。" } 示例 5 { "error_code" : "GSL.00022004", "error_msg" : "登录用户没有标签的访问权限。" } 状态码： 500 Internal Server Error { "error_code" : "GSL.00020003", "error_msg" : "系统繁忙，请稍后重试。" }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 id Long 标签标识 tag_name String 标签名称 最大长度：100 status Integer 标签状态，0未使用，1使用中。 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 最大长度：64 error_msg String 错误描述 最大长度：512 状态码： 500 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最大长度：64 error_msg String 错误描述 最大长度：512

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 cid 否 String 容器ID 最大长度：256 network_switch_policy_id 是 Long 网络切换策略标识

响应参数 状态码： 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 错误描述

请求示例 切换三网卡策略 POST https://{endpoint}/v1/sim-cards/{sim_card_id}/network-switch-policy/set { "network_switch_policy_id" : 1 } 使用cid切换三网卡策略 POST https://{endpoint}/v1/sim-cards/0/network-switch-policy/set { "network_switch_policy_id" : 1, "cid" : "888888888888888881" }

响应示例 状态码： 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参数 参数 是否必选 参数类型 描述 action 是 Integer 操作类型(1:设置达量断网域值，2：取消达量断网域值) 最小值：1 最大值：2 quota 否 String 阈值,只能是0,-1,正整数，-1表示无限制，0表示有上网流量产生就会立即断网，取消达量断网功能时可不传，单位MB iccid 否 String iccid，传入的sim_card_id为0,则根据iccid进行处理 最小长度：19 最大长度：20

响应参数 状态码： 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卡片的达量断网阈值为10 POST https://{endpoint}/v1/sim-cards/{sim_card_id}/exceed-cut-net { "action" : 1, "quota" : 10 } 创建SIM卡达量断网/取消达量断网的申请。例如：参数sim_card_id为最小值，设置卡标识iccid为“898600xxxxxxxxxx”的达量断网阈值为10。 POST https://{endpoint}/v1/sim-cards/{sim_card_id}/cut-net { "action" : 1, "quota" : 10, "iccid" : "898600xxxxxxxxxx" }

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

请求示例 查询sim_card_id对应的卡详情信息。 GET https://{endpoint} /v1/sim-cards/{sim_card_id} 查询SIM卡详情。当参数sim_card_id为最小值时，查询卡标识iccid为“8986xxxxxxxxxxxxxxx”的SIM卡详情。 GET https://{endpoint} /v1/sim-cards/{sim_card_id} { "iccid" : "8986xxxxxxxxxxxxxxx" }

响应示例 状态码： 200 OK { "sim_card_id" : 10000000000000000, "account_id" : "04eexxxxxxxxx", "cid" : "8986xxxxxxxxxxxxxxx", "sim_pool_id" : 10000000000000000, "imei" : null, "sim_status" : 14, "device_status" : null, "device_model" : null, "act_date" : "2022-09-16T01:14:58.000+00:00", "device_status_date" : null, "node_id" : null, "iccid" : "8986xxxxxxxxxxxxxxx", "network_type" : null, "dbm" : null, "signal_level" : null, "sim_type" : 3, "tag_names" : null, "order_id" : 10000000000000000, "expire_time" : "2023-08-26T15:59:59.000+00:00", "price_plan_name" : "中国联通消费级每月30M联接服务（1年）", "sim_price_plan_id" : 10000000000000000, "flow_left" : 10, "flow_used" : 0, "operator_status" : 5, "msisdn" : "8986xxxxxxxxxxxxxxx", "imsi" : "46xxxxxxxxxxxxxxx", "customer_attribute1" : null, "customer_attribute2" : null, "customer_attribute3" : null, "customer_attribute4" : null, "customer_attribute5" : null, "customer_attribute6" : null, "real_named" : false, "cut_net_flag" : false, "exceed_cut_net_flag" : false, "exceed_cut_net_quota" : null, "imei_bind_remain_times" : null, "speed_value" : null } 状态码： 400 Parameter Invalid { "error_code" : "GSL.00010004", "error_msg" : "参数异常" } 状态码： 500 Internal Server Error { "error_code" : "GSL.00010003", "error_msg" : "系统繁忙，请稍后重试。" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 sim_card_id Long sim卡id account_id String 账户id cid String 容器ID:不同类型卡含义如下 iccid(实体卡)，eid（eSIM）cid（vSIM) sim_pool_id Long 流量池ID imei String 设备IMEI sim_status Integer sim卡状态： 10.可测试 11.未激活 13.可激活 14.已停用 20.在用 30.已拆机 device_status Integer 设备状态：1.注册 2.重启 3.在线 4.离线（该参数只有ESIM、VSIM返回，实体卡返回null） device_model String 设备模组（该参数只有ESIM、VSIM返回，实体卡返回null） act_date String 激活日期 例如2020-01-31T16:00:00.000Z device_status_date String 设备状态变更时间 例如2020-01-31T16:00:00.000Z（该参数只有ESIM、VSIM返回，实体卡返回null） node_id String 设备标识 iccid String 码号iccid network_type String 网络类型 dbm String 信号强度（该参数只有ESIM、VSIM返回，实体卡返回null） signal_level String 信号等级:1.差 2.良 3.优（该参数只有ESIM、VSIM返回，实体卡返回null） sim_type Integer sim卡类型 1.vSIM 2.eSIM 3.实体卡 tag_names String 标签名 order_id Long 批次号 expire_time String 到期时间 例如2021-06-30T00:00:00.000Z price_plan_name String 在用套餐名 最大长度：128 sim_price_plan_id Long 套餐订购实例ID flow_left Double 剩余流量(单位M)，数据默认截止到昨日24点。 flow_used Double 已用流量(单位M)，数据默认截止到昨日24点。 operator_status Integer 停机类型 -1.正常（非停机状态） 1.停机（超流量停机） 2.停机（超流量阈值停机） 3.停机（流量池停机） 4.停机（套餐到期停机） 5.停机（主动停机） 6.停机（违规停机） 7.停机（机卡分离停机） msisdn String MSISDN 最大长度：32 imsi String IMSI 最大长度：32 customer_attribute1 String 自定义属性一 最大长度：100 customer_attribute2 String 自定义属性二 最大长度：100 customer_attribute3 String 自定义属性三 最大长度：100 customer_attribute4 String 自定义属性四 最大长度：100 customer_attribute5 String 自定义属性五 最大长度：100 customer_attribute6 String 自定义属性六 最大长度：100 real_named Boolean 是否已实名认证: true表示是，false表示否，系统SIM卡实名认证状态非实时。 cut_net_flag Boolean 是否单独断网 true:断网，false:未断网 （当前只支持联通、移动的组池卡，电信卡不限制） exceed_cut_net_flag Boolean 是否达量断网 true:达量断网，false:未达量断网 （当前只支持联通、移动的组池卡，电信卡不限制） exceed_cut_net_quota Integer 达量断网阈值（单位MB 当前仅电信卡支持） imei_bind_remain_times Integer 本月机卡绑定剩余次数（当前仅电信卡支持） speed_value Integer 网络限制速率（单位Kbps,当前电信联通卡支持） 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 OK { "limit" : 10, "offset" : 1, "count" : 2, "work_order_details" : [ { "id" : 5367068399387648, "sim_type" : 3, "status" : 1, "cid" : "8806660527032540000", "sim_card_id" : "6666660527032540666", "create_time" : "2023-07-14T11:20:00.000+00:00", "finish_time" : "2023-07-14T11:20:00.000+00:00", "description" : null }, { "id" : 5367068399387649, "sim_type" : 3, "status" : 1, "cid" : "8806660527032540001", "sim_card_id" : "6666660527032540667", "create_time" : "2023-07-14T11:20:00.000+00:00", "finish_time" : "2023-07-14T11:20:00.000+00:00", "description" : null } ] } 状态码： 400 Parameter Invalid { "error_code" : "GSL.00010004", "error_msg" : "参数异常" } 状态码： 500 Internal Server Error { "error_code" : "GSL.00010003", "error_msg" : "系统繁忙，请稍后重试。" }

URI GET /v1/work-orders/{work_order_id}/details 表1 路径参数 参数 是否必选 参数类型 描述 work_order_id 是 Long 业务受理ID 最小值：0 表2 Query参数 参数 是否必选 参数类型 描述 main_search_key 否 String 容器ID limit 否 Long 每页的记录数 最小值：10 最大值：500 缺省值：10 offset 否 Long 页码，最小值是1，最大值为1000000。默认值是1 最小值：1 最大值：1000000 缺省值：1 sim_type 否 Integer SIM卡类型: 1.vSIM 2.eSIM 3.实体卡 最小值：1 最大值：10 status 否 Integer 业务受理明细状态：1成功、2处理中、3失败 最小值：1 最大值：3

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 limit Long 每页的记录数 最小值：10 最大值：500 offset Long 页码，最小值是1，最大值为1000000。默认值是1. 最小值：1 最大值：1000000 count Long 记录总数 最小值：0 work_order_details Array of WorkOrderDetailVo objects 业务受理明细列表 表4 WorkOrderDetailVo 参数 参数类型 描述 id Long 业务受理ID sim_type Integer SIM卡类型: 1.vSIM 2.eSIM 3.实体卡 status Integer 业务受理明细状态：1成功、2处理中、3失败 cid String 容器ID:不同类型卡含义如下 iccid(实体卡)，eid（eSIM）cid（vSIM) sim_card_id Long SIM卡标识 create_time String 创建时间 finish_time String 完成时间 description String 描述 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误信息

请求示例 创建SIM卡机卡重绑申请。将SIM卡通过固定机卡重绑方式，绑定到IMEI为”84584xxxxxx“的设备上。 POST https://{endpoint}/v1/sim-cards/{sim_card_id}/bind-device { "bind_type" : 2, "imei" : "84584xxxxxx" } 创建SIM卡机卡重绑申请。通过普通机卡重绑方式，当参数sim_card_id为最小值时，将卡标识iccid为“898600xxxxxxxxxx”的SIM卡绑定到正在使用的设备上。 POST https://{endpoint}/v1/sim-cards/{sim_card_id}/bind-device { "bind_type" : 1, "iccid" : "898600xxxxxxxxxx" }

响应示例 状态码： 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 错误描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 bind_type 是 Integer 绑定类型(1:普通机卡重绑，2：固定机卡重绑) 最小值：1 最大值：2 imei 否 String 设备IMEI,84584xxxxxx iccid 否 String iccid，传入的sim_card_id为0,则根据iccid进行处理 最小长度：19 最大长度：20

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 down_up_switch 否 Integer 启用停用开关 最小值：0 最大值：9 iccid 否 String iccid，传入的sim_card_id为0,则根据iccid进行处理 最小长度：19 最大长度：20