GET 获取部署区域和可用区
智简魔方业务系统 V10 地域购物车部署区域与可用区接口,供前台按产品类型和计费方式读取可售地域目录。支持魔方云和 DCIM 商品,响应中的区域与可用区稳定标识用于后续获取线路、商品配置与报价,允许游客访问。
接口概览
| 项目 | 内容 |
|---|---|
| 文档类型 | 前台接口 |
| 请求方式 | GET |
| 接口地址 | /console/v1/location_cart/locations |
| 所属业务 | 地域购物车 |
| 来源模块/系统 | 地域购物车插件(location_cart) |
| 接口版本 | v2 |
| 认证方式 | 允许游客访问;登录用户可沿用前台 JWT。 |
完整请求
请求
正在加载示例…接口说明
前端先选择产品类型和计费方式,再获取对应的部署区域与可用区。
regions[].key 作为后续请求的 region_key,zones[].key 作为 zone_key。标识必须从响应取得并原样传递。
请求参数
| 名称 | 位置 | 类型 | 必选 | 默认值 | 说明 |
|---|---|---|---|---|---|
category | query | string | 是 | — | 产品类型 cloud=魔方云 dcim=DCIM |
billing_mode | query | string | 是 | — | 计费方式 recurring_prepayment=包年包月 on_demand=按需计费;DCIM仅允许包年包月 |
成功响应
以下为结构示例,部分可选或动态字段省略;全部响应字段定义见“响应参数”。
正在加载示例…失败响应
业务状态 400:参数或业务校验失败。提示信息以实际响应中的 msg 为准。
正在加载示例…响应状态
| 业务状态码 | 含义 | 说明 |
|---|---|---|
200 | 请求成功 | 读取 data 继续购买流程。 |
400 | 请求参数或业务校验失败 | 产品类型或计费方式参数缺失、不合法。 |
上表为 JSON 响应体中的
status,不是 HTTP 状态码。不能仅凭 HTTP 请求成功判断业务是否成功。
响应参数
成功响应与特定业务失败响应中使用的字段如下。字段是否出现取决于响应场景;原文档未声明返回字段的必选属性。
| 名称 | 类型 | 说明 |
|---|---|---|
status | integer | 状态码 200成功 400失败 |
msg | string | 提示信息 |
data | object | 区域目录数据 |
data.selection | object | 服务端确认的产品类型和计费方式 |
data.selection.category | string | 产品类型 cloud或dcim |
data.selection.billing_mode | string | 规范化后的计费方式 |
data.categories | array | 产品类型列表 |
data.categories[].value | string | 产品类型 cloud或dcim |
data.categories[].name | string | 产品类型名称 |
data.categories[].product_count | integer | 该类型下可售商品数量 |
data.regions | array | 部署区域列表,包含下属可用区 |
data.regions[].key | string | 区域稳定标识,后续接口作为region_key提交 |
data.regions[].category | string | 产品类型 cloud或dcim |
data.regions[].name | string | 区域名称 |
data.regions[].country_id | integer | 国家ID |
data.regions[].country_name | string | 国家名称 |
data.regions[].city | string | 城市 |
data.regions[].product_count | integer | 区域内可售商品数量 |
data.regions[].zones | array | 区域下的可用区列表 |
data.regions[].zones[].key | string | 可用区稳定标识,后续接口作为zone_key提交 |
data.regions[].zones[].name | string | 可用区名称 |
data.regions[].zones[].area | string | 原生区域字段 |
data.regions[].zones[].product_count | integer | 可用区内可售商品数量 |
data.zones | array | 全部可用区扁平列表,便于前端按key检索 |
data.zones[].key | string | 可用区稳定标识 |
data.zones[].parent_key | string | 所属区域稳定标识 |
data.zones[].region_key | string | 所属区域稳定标识 |
data.zones[].category | string | 产品类型 cloud或dcim |
data.zones[].name | string | 可用区名称 |
data.zones[].area | string | 原生区域字段 |
data.zones[].product_count | integer | 可用区内可售商品数量 |