华为云用户手册

请求示例 查询裸金属服务器的详情列表。 1 https://{E CS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/detail 查询标签中包含__type_baremetal的裸金属服务器的详情列表。 1 https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/detail?tags=__type_baremetal 查询标签中包含__type_baremetal且名称包含bms-test01的裸金属服务器的的详情列表。 1 https://{ECS Endpoint}/v2.1/bbf1946d374b44a0a2a95533562ba954/servers/detail?tags=__type_baremetal&name=bms-test01

URI GET /v2.1/{project_id}/servers/detail{?changes-since={changes-since}&image={image}&flavor={flavor}&name={name}&status={status}&limit={limit}&marker={marker}&tags={tags}¬-tags={not-tags}&reservation_id={reservation_id}&sort_key={sort_key}&sort_dir={sort_dir}} 参数说明请参见表1。 表1 参数说明 参数 是否必选 描述 project_id 是 项目ID。 获取方式请参见获取项目ID。

请求参数 参数 是否必选 参数类型 描述 changes-since 否 String 裸金属服务器上次更新状态的时间戳信息。格式为ISO 8601时间格式，例如：2013-06-09T06:42:18Z。 image 否 String 镜像ID。 可以在 镜像服务 控制台查询，也可以调用“查询镜像列表”API获取。 说明： 在使用image作为条件过滤时，不能同时支持其他过滤条件和分页条件。如果同时指定image及其他条件，则以image条件为准；当条件不含image时，接口功能不受限制。 flavor 否 String 规格ID。 可以在裸金属服务器控制台查询，也可以调用查询裸金属服务器规格信息列表（OpenStack原生）API获取。 name 否 String 裸金属服务器名称，使用模糊匹配的方式查询。 例如，“?name=bob”正则表达式会同时返回bob和bobb。如果必须仅匹配bob，则可以使用与基础数据库服务器的语法相匹配的正则表达式，如MySQL或PostgreSQL（官方网站：https://www.postgresql.org/docs/9.2/static/functions-matching.html）。 status 否 String 裸金属服务器状态。 取值范围： ACTIVE：运行中/正在关机/删除中 BUILD：创建中 ERROR：故障 HARD_REBOOT：强制重启中 REBOOT：重启中 SHUTOFF：关机/正在开机/删除中/重建中/重装操作系统中/重装操作系统失败/冻结 limit 否 Integer 每页返回裸金属服务器的条数。 marker 否 String 从marker指定的裸金属服务器ID的下一条数据开始查询。 tags 否 String 查询tag字段中包含该值的裸金属服务器。 微版本2.26新增 not-tags 否 String 查询tag字段中不包含该值的裸金属服务器，值为标签的Key。 说明： 如果之前添加的Tag为“Key.Value”的形式，则查询的时候需要使用“Key”来查询。 例如：之前添加的tag为“a.b”,则升级后，查询时需使用“not-tags=a”。 微版本2.26新增 reservation_id 否 String 批量创建裸金属服务器时，指定该预留ID，可以查询同批次创建的裸金属服务器。 微版本2.26新增 sort_key 否 String 用于排序的属性，包括uuid（裸金属服务器的uuid）、vm_state（裸金属服务器的状态）、display_name（裸金属服务器名称）、task_state（裸金属服务器任务状态）、power_state（电源状态）、created_at（创建时间）、updated_at（更新时间）、availability_zone（可用区）。可以指定多对sort_key和sort_dir。 默认排序顺序为created_at逆序。 sort_dir 否 String 排序方向。 asc：升序 desc：降序（默认值）

购买后向流量池 购买 全球SIM联接 服务流量套餐的时候，可以选择创建新后向流量池或加入已有后向流量池，后向流量池按当月已激活卡数和实际使用流量进行计费。 购买的后向流量池仅限中国内地使用，不能在海外区域使用； 已购买的后向流量池不支持退订； 不提供语音和短信； 物联网卡严禁在手机中使用，检测出在手机中使用直接停机处理，或账号下所有订单的物联网卡都禁止使用； 实体卡沉默期为6个月，即从物联网卡开卡开始，若6个月内没有激活使用，会在6个月后被强制激活。点此了解详细信息，其他注意事项请参见全球SIM联接使用注意事项。

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

响应参数 状态码： 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卡列表接口获取 表2 Query参数 参数 是否必选 参数类型 描述 iccid 否 String iccid，传入的sim_card_id为0,则根据iccid进行处理

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

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

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 limit Long 每页记录数 offset Long 页码 count Long 当前流量池的成员总数 pool_members Array of PoolMemVO objects 查询出来的流量池成员记录列表 表5 PoolMemVO 参数 参数类型 描述 id Long 流量池标识 cid String 容器ID sim_price_plan_id Long 套餐订购实例ID flow_used Double 已用流量(查询账期所在月份), 单位MB 状态码： 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 OK { "limit" : 10, "offset" : 1, "count" : 1, "pools" : [ { "id" : 1000000000, "pool_name" : "流量池名称", "price_plan_name" : "中国联通消费级每月30M联接服务（1年）", "price_plan_id" : "10000", "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_total" : 60, "flow_used" : 102.59, "flow_left" : -42.59, "quantity" : 100, "modify_time" : "2022-09-22T18:57:15.000+00:00", "order_id" : 100000000, "activated_sim_quantity" : 2, "inactive_sim_quantity" : 0, "disassembled_sim_quantity" : 98, "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" : "系统繁忙，请稍后重试。" }

URI GET /v1/sim-pools 表1 Query参数 参数 是否必选 参数类型 描述 pool_name 否 String 流量池名称 limit 否 Long 分页查询时每页显示的记录数，默认值为10，取值范围为10-500的整数 offset 否 Long 分页查询时的页码数，默认值为1，取值范围为1-1000000的整数 billing_cycle 否 String 账期，例如：2021-04 all_billing_cycle 否 Boolean 是否查询近六个月账期标识

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 limit Long 每页记录数 offset Long 页码 count Long 当前查询条件的流量池总数 pools Array of SimPoolVO objects 当前页的流量池记录列表 表4 SimPoolVO 参数 参数类型 描述 id Long 流量池标识 pool_name String 流量池名称 price_plan_name String 套餐名称 price_plan_id String 套餐标识 effective_time String 生效时间 expired_time String 失效时间 billing_cycle String 账期 flow_total Double 可用流量(查询账期所在月份)，单位MB flow_used Double 已用流量(查询账期所在月份), 单位MB flow_left Double 剩余流量(查询账期所在月份), 单位MB quantity Integer 流量池成员数量 modify_time String 更新时间 order_id Long 批次号 activated_sim_quantity Integer 已激活成员数量 inactive_sim_quantity Integer 未激活成员数量 disassembled_sim_quantity Integer 已拆机成员数量 order_ids String 组成流量池的批次号列表 状态码： 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 错误描述

请求示例 切换目标网络为移动 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 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 错误描述

请求示例 创建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 表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参数 参数 是否必选 参数类型 描述 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。 iccid 否 String iccid，传入的sim_card_id为0,则根据iccid进行处理

响应示例 状态码： 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参数 参数 参数类型 描述 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 错误信息

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

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孟加拉

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务 获取IAM用户Token接口获取，接口返回的响应消息头中“X-Subject-Token”就是需要获取的用户Token。简要的获取方法样例请参见 Token认证。 表2 请求Body参数 参数 是否必选 参数类型 描述 iccids 否 Array of strings iccid列表（三网卡不支持），最大支持50，且iccid和sim_card_id列表二选一 sim_card_ids 否 Array of longs sim_card_id列表，最大支持50，且iccid和sim_card_id列表二选一

请求示例 批量查询SIM卡标识为“898606xxxxxxxxxxxx”和“898607xxxxxxxxxxxx”的流量详情。 POST https://{endpoint}/v1/sim-price-plans/usage/batch-query { "iccids" : [ "898606xxxxxxxxxxxx", "898607xxxxxxxxxxxx" ] } 批量查询SIM卡ID为“100000000000”和“100000000001”的流量详情。 POST https://{endpoint}/v1/sim-price-plans/usage/batch-query { "sim_card_ids" : [ 100000000000, 100000000001 ] }