接口功能介绍
查询购买的共享流量包列表。
接口约束
无。
URI
GET /v4/flow_package/list
请求参数
Query 参数
参数 | 参数类型 | 是否必填 | 说明 | 示例 |
---|---|---|---|---|
regionID | String | 是 | 资源池 ID | 81f7728662dd11ec810800155d307d5b |
响应参数
参数 | 参数类型 | 说明 | 示例 |
---|---|---|---|
statusCode | Integer | 返回状态码(800为成功,900为失败) | 800 |
message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success |
description | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 |
errorCode | String | statusCode为900时为业务细分错误码,三段式:product.module.code; statusCode为800时为SUCCESS | SUCCESS |
returnObj | Object of Array | - | 返回购买的共享流量包列表。 |
表 returnObj
参数 | 参数类型 | 示例 | 说明 |
---|---|---|---|
id | String | 21c514816d554ef5bce825d4ce91eb3b | 唯一标识 |
statusText | String | 有效 | 购买共享流量包的状态,可能的取值:初始、有效、退订、过期、销毁 |
status | Integer | 1 | 对应 statusText 的取值为:0、1、5、6、7 |
cycleType | String | 包月 | 支持的取值:包小时、包天、包周、包月、包年 |
effectiveTime | String | 2022-11-07 14:14:01 | 生效时间 |
expireTime | String | 2022-12-07 14:14:01 | 过期时间 |
packageName | String | 包月 10.0G | 套餐名 |
totalVolumn | String | 10.0G | 总流量 |
leftVolumn | String | 10.0G | 剩余流量 |
masterResourceBundleId | String | 89ae74cb436c40b4ad420ba9fd22f89e | 资源包 ID |
请求示例
GET /v4/flow_package/list?regionID=100054c0416811e9a6690242ac110002
请求体Body
无
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "成功",
"returnObj": [
{
"id": "21c514816d554ef5bce825d4ce91eb3b",
"status": "退订",
"cycleType": "包月",
"effectiveTime": "2022-11-07 14:14:01",
"expireTime": "2022-12-07 14:14:01",
"packageName": "包月 10.0G",
"totalVolumn": 10.0,
"leftVolumn": 10.0,
"regionID": "100054c0416811e9a6690242ac110002",
"masterResourceBundleId": "89ae74cb436c40b4ad420ba9fd22f89e"
},
{
"id": "e48b915de30a43cbac5ffb564b144c12",
"status": "退订",
"cycleType": "包月",
"effectiveTime": "2022-11-07 14:14:01",
"expireTime": "2022-12-07 14:14:01",
"packageName": "包月 10.0G",
"totalVolumn": 10.0,
"leftVolumn": 10.0,
"regionID": "100054c0416811e9a6690242ac110002",
"masterResourceBundleId": "89ae74cb436c40b4ad420ba9fd22f89e"
},
{
"id": "07964761de9348e6ae2f7df433a652c8",
"status": "退订",
"cycleType": "包月",
"effectiveTime": "2022-11-07 14:14:01",
"expireTime": "2022-12-07 14:14:01",
"packageName": "包月 10.0G",
"totalVolumn": 10.0,
"leftVolumn": 10.0,
"regionID": "100054c0416811e9a6690242ac110002",
"masterResourceBundleId": "89ae74cb436c40b4ad420ba9fd22f89e"
}
]
}
状态码
状态码 | 描述 |
---|---|
200 | 表示请求成功。 |
错误码
请参考 错误码说明。