智简魔方文档

POST 获取网络线路

智简魔方业务系统 V10 地域购物车网络线路接口,供前台在选定产品类型、计费方式、部署区域和可用区后读取可用线路。响应包含线路稳定标识、带宽或流量计费类型及商品数量,供后续获取可购商品时原样传递。

接口概览

项目内容
文档类型前台接口
请求方式POST
接口地址/console/v1/location_cart/availability
所属业务地域购物车
来源模块/系统地域购物车插件(location_cart)
接口版本v2
认证方式允许游客访问;登录用户可沿用前台 JWT。

完整请求

请求

bash
正在加载示例…

接口说明

在产品类型、计费方式、部署区域和可用区已经选定后获取网络线路。

lines[].key 作为获取商品时的 line_key;bill_type 中 bw 表示带宽,flow 表示流量。

请求参数

名称位置类型必选默认值说明
categorybodystring是—产品类型 cloud=魔方云 dcim=DCIM
billing_modebodystring是—计费方式 recurring_prepayment=包年包月 on_demand=按需计费;DCIM仅允许包年包月
region_keybodystring是—区域稳定标识,由部署区域接口返回
zone_keybodystring是—可用区稳定标识,由部署区域接口返回

成功响应

以下为结构示例,部分可选或动态字段省略;全部响应字段定义见“响应参数”。

json
正在加载示例…

失败响应

业务状态 400:参数或业务校验失败。提示信息以实际响应中的 msg 为准。

json
正在加载示例…

响应状态

业务状态码含义说明
200请求成功读取 data 继续购买流程。
400请求参数或业务校验失败地域参数缺失,或所选部署区域、可用区已不可用。

上表为 JSON 响应体中的 status,不是 HTTP 状态码。不能仅凭 HTTP 请求成功判断业务是否成功。

响应参数

成功响应与特定业务失败响应中使用的字段如下。字段是否出现取决于响应场景;原文档未声明返回字段的必选属性。

名称类型说明
statusinteger状态码 200成功 400失败
msgstring提示信息
dataobject所选地域下的可用条件
data.selectionobject服务端确认的当前地域选择
data.selection.categorystring产品类型
data.selection.billing_modestring规范化后的计费方式
data.selection.region_keystring区域稳定标识
data.selection.zone_keystring可用区稳定标识
data.linesarray支持的网络线路列表
data.lines[].keystring线路稳定标识,获取商品时作为line_key提交
data.lines[].region_keystring线路所属区域稳定标识
data.lines[].zone_keystring线路所属可用区稳定标识
data.lines[].namestring线路名称
data.lines[].bill_typestring线路计费类型 bw=带宽 flow=流量
data.lines[].product_countinteger该线路下可售商品数量

相关文档