云服务器内容精选

  • 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 表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 GET /v1/sim-cards/{sim_card_id}/real-named 表1 路径参数 参数 是否必选 参数类型 描述 sim_card_id 是 Long SIM卡标识,如果SIM卡标识传0则表示需要根据iccid处理。可通过查询SIM卡列表接口获取 最小值:0 表2 Query参数 参数 是否必选 参数类型 描述 iccid 否 String iccid,传入的sim_card_id为0,则根据iccid进行处理 最小长度:19 最大长度:20
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 iccid String ICCID real_named Boolean 是否已实名认证: true表示是,false表示否。 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码: 500 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述
  • 请求示例 查询sim_card_id对应的SIM卡最新实名认证信息。 GET https://{endpoint}/v1/sim-cards/{sim_card_id}/real-named 查询SIM卡最新实名认证信息。当参数sim_card_id为最小值时,查询卡标识iccid为“8986xxxxxxxxxxxxxxx”的卡片最新实名认证信息。 GET https://{endpoint}/v1/sim-cards/{sim_card_id}/real-named { "iccid" : "898600xxxxxxxxxxxxxx" }
  • 响应示例 状态码: 200 OK { "iccid" : "898600xxxxxxxxxxxxxx", "real_named" : false } 状态码: 400 Parameter Invalid { "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.00022004", "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 OK { "limit" : 10, "offset" : 1, "count" : 1, "pool_members" : [ { "id" : 100000001, "cid" : "89860XXXXXXXXXXXXXX", "sim_price_plan_id" : 455000000000, "flow_used" : 0 } ] } 状态码: 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 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
  • 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
  • 请求示例 发送短信,如:发送短信给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 短信内容 最大长度:1000 cids 否 Array of strings 容器ID order_id 否 Long 批次号 file_temp_id 否 Long 临时文件ID