云服务器内容精选

  • 响应参数 状态码: 200 表2 响应Body参数 参数 参数类型 描述 - String OK 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 响应示例 状态码: 400 Bad Request 示例 1 { "error_code" : "GSL.00020004", "error_msg" : "参数异常" } 示例 2 { "error_code" : "GSL.00022004", "error_msg" : "登录用户没有标签的访问权限。" } 状态码: 500 Internal Server Error { "error_code" : "GSL.00020003", "error_msg" : "系统繁忙,请稍后重试。" }
  • 修订记录 发布日期 变更说明 2024-09-12 第二十一次正式发布。 本次变更如下: 切换网络和SIM卡设置网络切换策略接口,新增请求参数“cid”及示例。 2024-09-11 第二十次正式发布。 本次变更如下: 新增批量查询SIM卡日用量接口。 2024-08-28 第十九次正式发布。 本次变更如下: 新增三网卡管理、三网卡策略管理接口组。 2024-08-16 第十八次正式发布。 本次变更如下: 优化查询SIM卡列表、查询SIM卡详情接口“device_status”、“device_model”、“device_status_date”、“dbm”、“signal_level”字段描述。 2023-11-21 第十七次正式发布。 本次变更如下: 批量查询实体卡流量接口,请求参数中新增“sim_card_ids”字段。 2023-11-21 第十六次正式发布。 本次变更如下: 批量查询实体卡流量接口,请求参数中新增“sim_card_ids”字段。 2022-11-15 第十五次正式发布。 本次变更如下: 新增后向流量池管理接口。 2022-07-28 第十四次正式发布。 本次变更如下: 新增月用量统计接口。 2022-06-10 第十三次正式发布。 本次变更如下: 新增标签管理、自定义属性接口。 2021-09-07 第十二次正式发布。 本次变更如下: 查询套餐列表信息接口,响应参数中新增参数price。 2021-06-24 第十一次正式发布。 本次变更如下: sim卡套餐列表查询接口,请求参数中新增可选参数limit和offset。 2021-05-25 新增 实体卡限速。 2021-05-14 第十次正式发布。 本次变更如下: 新增激活实体卡、SIM卡机卡重绑、清除实名认证信息接口。 查询SIM卡列表接口,响应参数中的sim_cards里的每条数据新增响应参数cut_net_flag(是否单独断网 true:断网,false:未断网 (当前仅电信卡支持)),exceed_cut_net_flag(是否达量断网 true:达量断网,false:未达量断网 (当前仅电信卡支持)),exceed_cut_net_quota(达量断网阈值(单位MB 当前仅电信卡支持)),imei_bind_remain_times(本月机卡绑定剩余次数(当前仅电信卡支持))。 查询SIM卡详情接口,新增响应参数cut_net_flag(是否单独断网 true:断网,false:未断网 (当前仅电信卡支持)),exceed_cut_net_flag(是否达量断网 true:达量断网,false:未达量断网 (当前仅电信卡支持)),exceed_cut_net_quota(达量断网阈值(单位MB 当前仅电信卡支持)),imei_bind_remain_times(本月机卡绑定剩余次数(当前仅电信卡支持))。 2021-04-22 第九次正式发布。 本次变更如下: 新增SIM卡申请断网/恢复在用、SIM卡达量断网/取消达量断网接口。 2021-04-22 第八次正式发布。 本次变更如下: 新增查询SIM卡实名认证信息接口。 2021-04-21 第七次正式发布。 本次变更如下: 查询SIM卡列表接口,新增查询参数real_named(是否已实名认证: true表示是,false表示否,系统SIM卡实名认证状态非实时),响应参数中的sim_cards里的每条数据新增响应参数real_named(是否已实名认证: true表示是,false表示否,系统SIM卡实名认证状态非实时)。 查询SIM卡详情接口,新增响应参数real_named(是否已实名认证: true表示是,false表示否,系统SIM卡实名认证状态非实时)。 2021-04-07 第六次正式发布。 本次变更如下: 新增查询流量池列表、查询流量池成员列表接口。 2021-04-06 第五次正式发布。 本次变更如下: 新增SIM卡单卡停机、SIM卡单卡复机接口。 2021-02-25 第四次正式发布。 本次变更如下: 新增批量查询实体卡流量接口。 2020-12-09 第三次正式发布。 本次变更如下: 查询SIM卡列表接口,新增查询参数msisdn,customer_attribute1(自定义属性一),customer_attribute2(自定义属性二),customer_attribute3(自定义属性三),customer_attribute4(自定义属性四),customer_attribute5(自定义属性五),customer_attribute6(自定义属性六),新增返回参数sim_pool_id(流量池ID,如果该SIM卡组池的话会返回),msisdn,imsi,customer_attribute1(自定义属性一),customer_attribute2(自定义属性二),customer_attribute3(自定义属性三),customer_attribute4(自定义属性四),customer_attribute5(自定义属性五),customer_attribute6(自定义属性六)。 查询SIM卡列表接口,新增返回参数sim_pool_id(流量池ID,如果该SIM卡组池的话会返回),msisdn,imsi,customer_attribute1(自定义属性一),customer_attribute2(自定义属性二),customer_attribute3(自定义属性三),customer_attribute4(自定义属性四),customer_attribute5(自定义属性五),customer_attribute6(自定义属性六)。 2020-09-09 第二次正式发布。 本次变更如下: 查询SIM卡列表接口,新增参数排序属性(sort)和排序方向(order)字段,提供默认排序方式(按创建时间倒序)以外的排序。 2020-05-20 第一次正式发布。
  • 请求示例 发送短信,如:发送短信给cids集合里面的SIM卡“89861xxxxxxxxxxx”和“89862xxxxxxxxxxx”,短信内容sms_content为“测试”。 POST https://{endpoint}/v1/sms-send-infos { "sms_content" : "测试", "cids" : [ "89861xxxxxxxxxxx", "89862xxxxxxxxxxx" ] }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表2 请求Body参数 参数 是否必选 参数类型 描述 template_id 否 Long 模板id sms_content 是 String 短信内容 cids 否 Array of strings 容器ID order_id 否 Long 批次号 file_temp_id 否 Long 临时文件ID
  • 响应示例 状态码: 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参数 参数 参数类型 描述 - String OK 状态码: 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表4 响应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 表3 响应Body参数 参数 参数类型 描述 work_order_id Long 业务受理单号 状态码: 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 请求示例 切换目标网络为移动 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 表3 响应Body参数 参数 参数类型 描述 limit Long 每页的记录数 offset Long 页码,最小值是1,最大值为1000000。默认值是1. count Long 记录总数 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的整数 offset 否 Long 分页查询时的页码数,默认值为1,取值范围为1-1000000的整数 main_search_key 否 String 查询关键标识类型:套餐名称 例如中国移动消费级每月30M联接服务(1年) flow_total 否 Long 流量总量(MB) network_type 否 Long 网络制式 1.2g,3g,4g 2.NB location_type 否 Long 覆盖区域:1. 中国 2. 欧洲 3. 大洋洲 4. 非洲 5. 亚太 carrier_type 否 Integer 运营商 1中国移动(实体卡) 2中国电信(实体卡) 3中国联通(实体卡) 4海外运营商(实体卡) esim/vsim: 101.中国移动 102.中国电信 201.欧洲 501.中国香港 502.中国澳门 503.泰国 504.日本 505.柬埔寨 506.印度尼西亚 507.马来西亚 508.新加坡 509.斯里兰卡 510.中国台湾 511.孟加拉 country_type 否 Long 国家/地区 1中国香港,2中国澳门,3泰国,4日本,5,柬埔寨,6印尼,7马来西亚,8新加坡,9斯里兰卡,10中国台湾,11孟加拉
  • 响应示例 状态码: 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" : "系统繁忙,请稍后重试。" }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取,接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表3 请求Body参数 参数 是否必选 参数类型 描述 cid 否 String 容器ID 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 错误描述