GET 获取网络流量
接口概览
| 项目 | 内容 |
|---|---|
| 文档类型 | 前台接口 |
| 请求方式 | GET |
| 接口地址 | /console/v1/mf_cloud/{id}/flow |
| 所属业务 | 模块 |
| 来源模块/系统 | 魔方云(自定义配置) |
| 认证方式 | Bearer Token（用户令牌） |
完整请求
请求
正在加载示例…失败请求
正在加载示例…接口说明
获取网络流量
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
|---|---|---|---|---|
| id | path | integer(int32) | 是 | 产品ID |
成功响应
正在加载示例…失败响应 400：请求参数或业务校验失败
正在加载示例…失败响应 401：未认证或登录已失效
正在加载示例…失败响应 403：无权执行当前操作
正在加载示例…失败响应 404：接口或业务资源不存在
正在加载示例…失败响应 500：服务器内部错误
正在加载示例…响应状态
| 状态码 | 状态码含义 | 说明 | 数据模型 |
|---|---|---|---|
| 200 | OK | 成功响应 | 内联对象 |
| 400 | Bad Request | 请求参数或业务校验失败 | 内联对象 |
| 401 | Unauthorized | 未认证或登录已失效 | 内联对象 |
| 403 | Forbidden | 无权执行当前操作 | 内联对象 |
| 404 | Not Found | 接口或业务资源不存在 | 内联对象 |
| 500 | Internal Server Error | 服务器内部错误 | 内联对象 |
响应参数
状态码 200
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| status | integer(int32) | 否 | — | — | 状态码 |
| msg | string | 否 | — | — | 提示信息 |
| data | object | 否 | — | — | — |
| data.total | string | 否 | — | — | 总流量 |
| data.used | string | 否 | — | — | 已用流量 |
| data.leave | string | 否 | — | — | 剩余流量 |
| data.reset_flow_date | string | 否 | — | — | 流量归零时间 |
| data.total_num | integer(int32) | 否 | — | — | 总流量大小(0=不限) |
| data.used_num | number(double) | 否 | — | — | 已用流量大小 |
| data.base_flow | number(double) | 否 | — | — | 基础流量(0=不限) |
| data.temp_flow | number(double) | 否 | — | — | 临时流量 |
| data.flow_packet | object | 否 | — | — | — |
| data.flow_packet.leave_size | number(double) | 否 | — | — | 流量包剩余流量大小(GB) |
| data.flow_packet.total_size | integer(int32) | 否 | — | — | 流量包总大小(GB) |
| data.flow_packet.used_size | number(double) | 否 | — | — | 流量包已用大小(GB) |
失败状态码 400、401、403、404、500 共用以下结构：
| 名称 | 类型 | 必选 | 约束 | 中文名 | 说明 |
|---|---|---|---|---|---|
| status | integer(int32) | 是 | — | — | 错误状态码 |
| msg | string | 是 | — | — | 错误提示 |