华为云用户手册

响应示例 状态码： 200 OK { "limit" : 10, "offset" : 1, "count" : 1, "price_plans" : [ { "price_plan_id" : "100000", "price_plan_name" : "中国电信每月1M联接服务（实体卡）", "description" : "中国电信每月1M联接服务（实体卡）", "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 { "code" : "GSL.00010004", "message" : "参数异常"} 状态码： 500 Internal Server Error { "code" : "GSL.00010003", "message" : "系统繁忙，请稍后重试。"}

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 查询关键标识类型：套餐名称 例如中国香港每月10M联接服务 最大长度：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 运营商 101/1 中国移动/中国移动（实体卡） 102/2中国电信/中国电信（实体卡） 3中国联通（实体卡） 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 表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 运营商 101/1 中国移动/中国移动（实体卡） 102/2中国电信/中国电信（实体卡） 3中国联通（实体卡） 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 错误信息

响应示例 状态码： 200 OK [ { "id" : 100000000000, "account_id" : "04eexxxxxxxxxxxx", "sim_card_id" : 100000000000, "status" : 2, "price_plan_id" : "100001", "partner" : 1, "cid" : "8986xxxxxxxxxx", "partner_pid" : "10001", "order_id" : null, "create_time" : "2022-09-16T03:21:22.000+00:00", "active_time" : "2022-09-16T01:14:58.000+00:00", "stop_time" : null, "flow_total" : 30, "flow_used" : 0, "flow_left" : 30, "using" : "0", "price_plan_name" : "中国联通消费级每月30M联接服务（1年）", "description" : null, "package_type" : 1, "effect_type" : 1, "silent_period_day" : 6, "silent_period_unit" : 2, "auto_renew" : 0, "location_desc" : "中国"} ] 状态码： 400 Parameter Invalid { "code" : "GSL.00010004", "message" : "参数异常"} 状态码： 500 Internal Server Error { "code" : "GSL.00010003", "message" : "系统繁忙，请稍后重试。"}

URI GET /v1/sim-price-plans 表1 Query参数 参数 是否必选 参数类型 描述 sim_card_id 是 Long SIM卡标识，可通过查询SIM卡列表接口获取 最小值：0 real_time 否 Boolean 是否查实时流量 缺省值：false limit 否 Long 分页查询时每页显示的记录数，默认值为10，取值范围为10-500的整数 最小值：10 最大值：500 缺省值：10 offset 否 Long 分页查询时的页码数，默认值为1，取值范围为1-1000000的整数 最小值：1 最大值：1000000 缺省值：1

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 [数组元素] Array of SimPricePlanVO objects OK 表4 SimPricePlanVO 参数 参数类型 描述 id Long 套餐实例id 最小值：0 account_id String 账户id 最大长度：128 sim_card_id Long sim卡id 最小值：0 status Integer 套餐状态:0 已删除 1 可激活 2 在用 3. 使用完 4. 可激活 5 已停用 6. 启用失败 最小值：0 最大值：2147483647 price_plan_id String 套餐id 最大长度：128 cid String 容器ID:不同类型卡含义如下 iccid(实体卡)，eid（eSIM）cid（vSIM) 最大长度：128 order_id String 订单id 最大长度：128 create_time String 创建时间 例如2020-08-24T07:57:56.000Z active_time String 激活时间 例如2020-10-31T16:00:00.000Z stop_time String 停用时间 2021-10-31T16:00:00.000Z flow_total Double 总流量(MB) 最小值：0 flow_used Double 已使用流量(MB) 最小值：0 flow_left Double 剩余流量(MB) using String 是否使用中(0：否 1：是) 最大长度：128 price_plan_name String 套餐名 最大长度：128 description String 描述 最大长度：128 package_type Integer 套餐类型: 0.非自动续费 1.自动续费 最小值：0 最大值：2147483647 effect_type Integer 生效类型: 1.订购后激活使用时生效 2.订购即时生效 3.订购下个月开始生效 最小值：0 最大值：2147483647 silent_period_day Integer 沉默期 最小值：0 最大值：2147483647 silent_period_unit Integer 沉默期单位: 1.年 2.月 3.日 最小值：1 最大值：3 auto_renew Integer 自动续订: 0.不自动续订 1.继续续订 最小值：0 最大值：2147483647 location_desc String 位置信息:1. 中国 2. 欧洲 3. 大洋洲 4. 非洲5. 亚太 最大长度：128 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

状态码 状态码 编码 错误码说明 100 Continue 继续请求。 这个临时响应用来通知客户端，它的部分请求已经被服务器接收，且仍未被拒绝。 101 Switching Protocols 切换协议。只能切换到更高级的协议。 例如，切换到HTTP的新版本协议。 200 OK 请求成功。 201 Created 创建类的请求完全成功。 202 Accepted 已接受请求，但未处理完成。 203 Non-Authoritative Information 非授权信息，请求成功。 204 NoContent 请求完全成功，同时HTTP响应不包含响应体。 在响应OPTIONS方法的HTTP请求时返回此状态码。 205 Reset Content 重置内容，服务器处理成功。 206 Partial Content 服务器成功处理了部分GET请求。 300 Multiple Choices 多种选择。请求的资源可包括多个位置，相应可返回一个资源特征与地址的列表用于用户终端（例如：浏览器）选择。 301 Moved Permanently 永久移动，请求的资源已被永久的移动到新的URI，返回信息会包括新的URI。 302 Found 资源被临时移动。 303 See Other 查看其它地址。 使用GET和POST请求查看。 304 Not Modified 所请求的资源未修改，服务器返回此状态码时，不会返回任何资源。 305 Use Proxy 所请求的资源必须通过代理访问。 306 Unused 已经被废弃的HTTP状态码。 400 BadRequest 非法请求。 建议直接修改该请求，不要重试该请求。 401 Unauthorized 在客户端提供认证信息后，返回该状态码，表明服务端指出客户端所提供的认证信息不正确或非法。 402 Payment Required 保留请求。 403 Forbidden 请求被拒绝访问。 返回该状态码，表明请求能够到达服务端，且服务端能够理解用户请求，但是拒绝做更多的事情，因为该请求被设置为拒绝访问，建议直接修改该请求，不要重试该请求。 404 NotFound 所请求的资源不存在。 建议直接修改该请求，不要重试该请求。 405 MethodNotAllowed 请求中带有该资源不支持的方法。 建议直接修改该请求，不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证，与401类似，但请求者应当使用代理进行授权。 408 Request Time-out 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码，表明客户端尝试创建的资源已经存在，或者由于冲突请求的更新操作不能被完成。 410 Gone 客户端请求的资源已经不存在。 返回该状态码，表明请求的资源已被永久删除。 411 Length Required 服务器无法处理客户端发送的不带Content-Length的请求信息。 412 Precondition Failed 未满足前提条件，服务器未满足请求者在请求中设置的其中一个前提条件。 413 Request Entity Too Large 由于请求的实体过大，服务器无法处理，因此拒绝请求。为防止客户端的连续请求，服务器可能会关闭连接。如果只是服务器暂时无法处理，则会包含一个Retry-After的响应信息。 414 Request-URI Too Large 请求的URI过长（URI通常为网址），服务器无法处理。 415 Unsupported Media Type 服务器无法处理请求附带的媒体格式。 416 Requested range not satisfiable 客户端请求的范围无效。 417 Expectation Failed 服务器无法满足Expect的请求头信息。 422 UnprocessableEntity 请求格式正确，但是由于含有语义错误，无法响应。 429 TooManyRequests 表明请求超出了客户端访问频率的限制或者服务端接收到多于它能处理的请求。建议客户端读取相应的Retry-After首部，然后等待该首部指出的时间后再重试。 500 InternalServerError 表明服务端能被请求访问到，但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能，无法完成请求。 502 Bad Gateway 充当网关或代理的服务器，从远端服务器接收到了一个无效的请求。 503 ServiceUnavailable 被请求的服务无效。 建议直接修改该请求，不要重试该请求。 504 ServerTimeout 请求在给定的时间内无法完成。客户端仅在为请求指定超时（Timeout）参数时会得到该响应。 505 HTTP Version not supported 服务器不支持请求的HTTP协议的版本，无法完成处理。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 limit Long 每页记录数 offset Long 页码 count Long 总数 sim_cards Array of SimDeviceVO objects sim卡数据集合 表4 SimDeviceVO 参数 参数类型 描述 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 设备状态 device_model String 设备模组 act_date String 激活日期 例如2020-01-31T16:00:00.000Z device_status_date String 设备状态变更时间 例如2020-01-31T16:00:00.000Z node_id String 设备标识 iccid String 码号iccid network_type String 网络类型 dbm String 信号强度 signal_level String 信号等级:1.差 2.良 3.良 4.优（该参数只有eSIM,vSIM返回，实体卡不返回） 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 错误描述 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码： 200 OK { "limit" : 10, "offset" : 1, "count" : 1, "sim_cards" : [ { "sim_card_id" : 4900000000000, "account_id" : "04eef84xxxxxxxxxxx", "cid" : "8986xxxxxxxxxx", "sim_pool_id" : 4940000000, "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" : "8986xxxxxxxxxxx", "network_type" : null, "dbm" : null, "signal_level" : null, "sim_type" : 3, "tag_names" : null, "order_id" : 494000000000, "expire_time" : "2023-08-26T15:59:59.000+00:00", "price_plan_name" : "中国联通消费级每月10M联接服务（1年）", "sim_price_plan_id" : null, "flow_left" : 30, "flow_used" : 0, "operator_status" : 5, "msisdn" : "86xxxxxxxxx", "imsi" : "46xxxxxxxxxx", "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" : "参数异常"} 状态码： 403 Forbidden { "error_code" : "GSL.00016016", "error_msg" : "5分钟内不允许重复操作，请稍作等待。"} 状态码： 500 Internal Server Error { "error_code" : "GSL.00010003", "error_msg" : "系统繁忙，请稍后重试。"}

URI GET /v1/sim-cards 表1 Query参数 参数 是否必选 参数类型 描述 main_search_type 否 Integer 查询关键标识类型： 1.容器ID(不同类型卡含义如下:ICCID(实体卡)，EID（eSIM）CID（vSIM)) 2.批次号 3.设备IMEI 最小值：0 最大值：2147483647 main_search_key 否 String 查询关键标识值：根据查询关键标识类型进行查询，例如想根据ICCID=xxx进行查询，则main_search_type=1&main_search_key=xxx 最小长度：0 最大长度：128 limit 否 Long 分页查询时每页显示的记录数，默认值为10，取值范围为10-500的整数 最小值：10 最大值：500 缺省值：10 offset 否 Long 分页查询时的页码数，默认值为1，取值范围为1-1000000的整数 最小值：1 最大值：1000000 缺省值：1 sim_status 否 Integer sim卡状态： 10.可测试 11.未激活 13.可激活 14.已停用 20.在用 30.已拆机 最小值：0 最大值：2147483647 device_status 否 Integer 设备状态: 1.注册 2.重启 3.在线 4.离线 最小值：0 最大值：2147483647 tag_id 否 Array 标签ID，最多支持传10个 sim_type 否 Integer sim卡类型： 1.vSIM 2.eSIM 3.实体卡 最小值：0 最大值：2147483647 order 否 String 排序的顺序，asc表示顺序排序，desc表示倒序排序，不传则默认asc 缺省值：asc 枚举值： asc desc sort 否 String 排序的属性，目前支持:cid（容器ID）、flow_used（已用流量）、flow_left（剩余流量）、act_date（激活时间）、expire_time（到期时间） 枚举值： cid flow_used flow_left act_date expire_time msisdn 否 String MSISDN 最小长度：0 最大长度：32 customer_attribute1 否 String 自定义属性一 最小长度：0 最大长度：100 customer_attribute2 否 String 自定义属性二 最小长度：0 最大长度：100 customer_attribute3 否 String 自定义属性三 最小长度：0 最大长度：100 customer_attribute4 否 String 自定义属性四 最小长度：0 最大长度：100 customer_attribute5 否 String 自定义属性五 最小长度：0 最大长度：100 customer_attribute6 否 String 自定义属性六 最小长度：0 最大长度：100 min_used_flow 否 Long 最小使用流量(MB) 最小值：0 最大值：2147483647 max_used_flow 否 Long 最大使用流量(MB) 最小值：0 最大值：2147483647 min_left_flow 否 Long 最小剩余流量(MB) 最小值：0 最大值：2147483647 max_left_flow 否 Long 最大剩余流量(MB) 最小值：0 最大值：2147483647 real_named 否 Boolean 是否已实名认证: true表示是，false表示否，系统SIM卡实名认证状态非实时。 order_id 否 Long 订单号 最小值：0 最大值：9223372036854774784 filter_downtime_period 否 Boolean 是否过滤停机保号的卡 缺省值：false order_ids 否 Array 订单批次号集合 price_plan_id 否 Array 套餐id集合，最多支持传30个

响应示例 状态码： 200 OK { "work_order_id" : 1000001} 状态码： 400 Parameter Invalid { "code" : "GSL.00010004", "message" : "参数异常"} 状态码： 403 Forbidden { "code" : "GSL.00016010", "message" : "您操作的卡仍有未完成的停机受理单，请勿重复操作。"} 状态码： 500 Internal Server Error { "code" : "GSL.00010003", "message" : "系统繁忙，请稍后重试。"}

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 down_up_switch 否 Integer 启用停用开关 最小值：0 最大值：2147483647

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

响应示例 状态码： 200 OK { "work_order_id" : 1000001} 状态码： 400 Parameter Invalid { "code" : "GSL.00010004", "message" : "参数异常"} 状态码： 403 Forbidden { "code" : "GSL.00016010", "message" : "您操作的卡仍有未完成的停机受理单，请勿重复操作。"} 状态码： 500 Internal Server Error { "code" : "GSL.00010003", "message" : "系统繁忙，请稍后重试。"}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 down_up_switch 否 Integer 启用停用开关 最小值：0 最大值：2147483647

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 action 是 String 操作类型(ADD：断网，DEL:取消断网) 最大长度：10

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

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

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

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

URI GET /v1/sim-pools/{sim_pool_id}/members 表1 路径参数 参数 是否必选 参数类型 描述 sim_pool_id 是 Long 流量池标识 最小值：0 表2 Query参数 参数 是否必选 参数类型 描述 cid 否 String 容器ID limit 否 Long 每页记录数 最小值：10 最大值：500 缺省值：10 offset 否 Long 页码 最小值：1 最大值：1000000 缺省值：1 billing_cycle 是 String 账期，例如：2021-04 最小长度：7 最大长度：7

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

响应示例 状态码： 200 OK { "limit" : 10, "offset" : 1, "count" : 1, "pool_members" : [ { "id" : 100000001, "cid" : "89860XXXXXXXXXXXXXX", "sim_price_plan_id" : 455000000000, "flow_used" : 0 } ]} 状态码： 400 Bad Request { "code" : "GSL.00010004", "message" : "参数异常"} 状态码： 403 Forbidden { "code" : "GSL.00011004", "message" : "账期不合法，请检查！"} 状态码： 500 Internal Server Error { "code" : "GSL.00010003", "message" : "系统繁忙，请稍后重试。"}

响应示例 状态码： 400 Parameter Invalid 示例 1 { "error_code" : "GSL.00010004", "error_msg" : "sim_card_id:不能为null"} 示例 2 { "error_code" : "GSL.00012031", "error_msg" : "[{\"fail_reason\":\"自定义属性三未启用\",\"sim_card_id\":3552016640640009}]"} 状态码： 500 Internal Server Error { "code" : "GSL.00010003", "message" : "系统繁忙，请稍后重试。"}

请求示例 { "file_temp_id" : "null,", "attributes" : [ { "sim_card_id" : 111111, "customer_attribute1" : "attr1", "customer_attribute2" : "attr2", "customer_attribute3" : "attr3", "customer_attribute4" : "attr4", "customer_attribute5" : "attr5", "customer_attribute6" : "attr6" } ]}

请求参数 表1 请求Body参数 参数 是否必选 参数类型 描述 file_temp_id 否 Long 临时文件ID，如果通过接口调用，此字段为空 attributes 否 Array of AttributeReq objects 自定义属性集合 表2 AttributeReq 参数 是否必选 参数类型 描述 sim_card_id 是 Long SIM卡标识 customer_attribute1 否 String 自定义属性一 最大长度：100 customer_attribute2 否 String 自定义属性二 最大长度：100 customer_attribute3 否 String 自定义属性三 最大长度：100 customer_attribute4 否 String 自定义属性四 最大长度：100 customer_attribute5 否 String 自定义属性五 最大长度：100 customer_attribute6 否 String 自定义属性六 最大长度：100

响应示例 状态码： 200 OK { "limit" : 10, "offset" : 1, "count" : 1, "pool_members" : [ { "id" : 100000001, "cid" : "89860XXXXXXXXXXXXXX", "sim_price_plan_id" : 455000000000, "flow_used" : 0, "sim_status" : 20 } ]} 状态码： 400 Bad Request { "error_code" : "GSL.00010004", "error_msg" : "参数异常"} 状态码： 403 Forbidden { "error_code" : "GSL.00011004", "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 错误信息