华为云用户手册

响应示例 状态码： 200 OK { "limit" : 10, "offset" : 1, "count" : 1, "pools" : [ { "id" : 10000000001, "pool_name" : "流量池名称", "price_plan_name" : "中国电信消费级阶梯流量池联接服务", "price_plan_id" : "520040", "effective_time" : "2022-08-26T16:00:00.000+00:00", "expired_time" : "2022-09-26T15:59:59.000+00:00", "billing_cycle" : "2022-09", "flow_used" : 102.59, "quantity" : 100, "pool_status" : 2, "modify_time" : "2022-09-22T18:57:15.000+00:00", "activated_sim_quantity" : 2, "inactive_sim_quantity" : 0, "disassembled_sim_quantity" : 98, "order_id" : 111111111, "order_ids" : "1000000" } ]} 状态码： 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" : "系统繁忙，请稍后重试。"}

请求参数 表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" : "系统繁忙，请稍后重试。"}

请求示例 查询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参数 参数 是否必选 参数类型 描述 file_temp_id 否 Long 临时文件ID，如果通过接口调用，此字段为空 attributes 否 Array of AttributeReq objects 自定义属性集合 数组长度：1 - 500 表2 AttributeReq 参数 是否必选 参数类型 描述 sim_card_id 是 Long SIM卡标识，如果SIM卡标识传0则表示需要根据iccid处理。 iccid 否 String iccid，如果SIM卡标识传0则表示需要根据iccid处理。 最小长度：19 最大长度：20 customer_attribute1 否 String 自定义属性一 最大长度：100 customer_attribute2 否 String 自定义属性二 最大长度：100 customer_attribute3 否 String 自定义属性三 最大长度：100 customer_attribute4 否 String 自定义属性四 最大长度：100 customer_attribute5 否 String 自定义属性五 最大长度：100 customer_attribute6 否 String 自定义属性六 最大长度：100

请求示例 批量设置SIM卡自定义属性。例如：批量设置sim_card_id为“4710200000”和“4710300000”的卡片自定义属性值，自定义属性1为“attr1”。 POST https://{endpoint}/v1/sim-cards/attributes/batch-set{ "attributes" : [ { "sim_card_id" : 4710200000, "customer_attribute1" : "attr1", "customer_attribute2" : "attr2", "customer_attribute3" : "attr3", "customer_attribute4" : "attr4", "customer_attribute5" : "attr5", "customer_attribute6" : "attr6" }, { "sim_card_id" : 4710300000, "customer_attribute1" : "attr1", "customer_attribute2" : "attr2", "customer_attribute3" : "attr3", "customer_attribute4" : "attr4", "customer_attribute5" : "attr5", "customer_attribute6" : "attr6" } ]} 批量设置SIM卡自定义属性。当参数sim_card_id为最小值时，批量设置卡标识iccid为“8986xxxxxxxxxxxxxxx”和“8987xxxxxxxxxxxxxxx”的卡片自定义属性值，自定义属性1为“attr1”。 POST https://{endpoint}/v1/sim-cards/attributes/batch-set{ "attributes" : [ { "sim_card_id" : 0, "iccid" : "8986xxxxxxxxxxxxxxx", "customer_attribute1" : "attr1", "customer_attribute2" : "attr2", "customer_attribute3" : "attr3", "customer_attribute4" : "attr4", "customer_attribute5" : "attr5", "customer_attribute6" : "attr6" }, { "sim_card_id" : 0, "iccid" : "8987xxxxxxxxxxxxxxx", "customer_attribute1" : "attr1", "customer_attribute2" : "attr2", "customer_attribute3" : "attr3", "customer_attribute4" : "attr4", "customer_attribute5" : "attr5", "customer_attribute6" : "attr6" } ]}

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 - Boolean OK 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

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

状态码 状态码 编码 错误码说明 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协议的版本，无法完成处理。

请求示例 创建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 表2 响应Body参数 参数 参数类型 描述 limit Long 每页记录数 offset Long 页码 count Long 记录总数 tags Array of CmTagVO objects 标签记录 表3 CmTagVO 参数 参数类型 描述 id Long 标签标识 tag_name String 标签名称 最大长度：100 status Integer 标签状态，0未使用，1使用中。 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最大长度：64 error_msg String 错误描述 最大长度：512 状态码： 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最大长度：64 error_msg String 错误描述 最大长度：512

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

URI GET /v1/tags 表1 Query参数 参数 是否必选 参数类型 描述 tag_name 否 String 标签名称 最大长度：256 limit 否 Long 分页查询时每页显示的记录数，默认值为10，取值范围为10-500的整数 最小值：10 最大值：500 缺省值：10 offset 否 Long 分页查询时的页码数，默认值为1，取值范围为1-1000000的整数 最小值：1 最大值：1000000 缺省值：1 status 否 Integer 标签状态，0未使用，1使用中。 最小值：0 最大值：1

请求参数 表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 表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/back-pools/{back_pool_id}/members 表1 路径参数 参数 是否必选 参数类型 描述 back_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 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 错误信息

响应参数 状态码： 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的卡片实名认证信息 POST https://{endpoint}/v1/sim-cards/{sim_card_id}/clear-real-name 清除SIM卡实名认证信息。当参数sim_card_id为最小值时，申请清除卡标识iccid为“898600xxxxxxxxxx”的SIM卡实名认证信息 POST https://{endpoint}/v1/sim-cards/{sim_card_id}/clear-real-name{ "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" : "系统繁忙，请稍后重试。"}

URI POST /v1/sim-cards/{sim_card_id}/clear-real-name 表1 路径参数 参数 是否必选 参数类型 描述 sim_card_id 是 Long SIM卡标识，如果SIM卡标识传0则表示需要根据iccid处理。可通过查询SIM卡列表接口获取 最小值：0 表2 Query参数 参数 是否必选 参数类型 描述 iccid 否 String iccid，传入的sim_card_id为0,则根据iccid进行处理 最小长度：19 最大长度：20

响应示例 状态码： 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 { "error_code" : "GSL.00010004", "error_msg" : "参数异常"} 状态码： 500 Internal Server Error { "error_code" : "GSL.00010003", "error_msg" : "系统繁忙，请稍后重试。"}

URI GET /v1/sim-price-plans 表1 Query参数 参数 是否必选 参数类型 描述 sim_card_id 是 Long SIM卡标识，可通过查询SIM卡列表接口获取 最小值：0 iccid 否 String iccid，传入的SIM卡标识（sim_card_id）为0,则根据iccid进行处理 最小长度：19 最大长度：20 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 最大值：99 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 最大值：9 effect_type Integer 生效类型: 1.订购后激活使用时生效 2.订购即时生效 3.订购下个月开始生效 最小值：0 最大值：99 silent_period_day Integer 沉默期 最小值：0 最大值：999 silent_period_unit Integer 沉默期单位: 1.年 2.月 3.日 最小值：1 最大值：3 auto_renew Integer 自动续订: 0.不自动续订 1.继续续订 最小值：0 最大值：9 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 错误描述

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

请求示例 创建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"}