接口功能介绍
购买共享流量包。
接口约束
无。
URI
POST /v4/flow_package/buy
请求参数
请求Body参数
| 参数 | 参数类型 | 是否必填 | 说明 | 示例 |
|---|---|---|---|---|
| regionID | String | 是 | 资源池 ID | |
| cycleType | String | 是 | 订阅周期，仅支持 MONTH 和 YEAR | MONTH |
| cycleCount | Integer | 是 | 订阅周期时长，仅支持购买 1 个月 / 购买 1 年 | 1 |
| count | Integer | 是 | 购买数量，最大支持 20 个，最少 1 个 | 1 |
| spec | Integer | 是 | 规格，规格说明见下表 | 10 |
| clientToken | String | 是 | 客户端存根，用于保证订单幂等性。要求单个云平台账户内唯一，长度 1 - 64 |
表 spec
当 cycleType = MONTH 时，定义如下
| 规格 | 描述 |
|---|---|
| 10 | 10GB |
| 50 | 50GB |
| 100 | 100GB |
| 500 | 500GB |
| 1024 | 1TB |
| 5120 | 5TB |
| 10240 | 10TB |
| 51200 | 50TB |
当 cycleType = YEAR 时，定义如下
| 规格 | 描述 |
|---|---|
| 120 | 120GB |
| 512 | 512GB |
| 8192 | 8TB |
| 36864 | 36TB |
| 122880 | 120TB |
| 614400 | 600TB |
| 1048576 | 1PB |
| 2097152 | 2PB |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| 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 | - | 接口业务数据 |
表 returnObj
| 参数 | 参数类型 | 示例 | 说明 |
|---|---|---|---|
| masterOrderID | String | 55d531d7bf2d47658897c42ffb918423 | 订单id。 |
| masterOrderNO | String | 20221021191602644224 | 订单编号, 可以为 null。 |
| masterResourceStatus | String | started | 资源状态。 |
| masterResourceID | String | d48cace2da7b4c81b4c0444768a04608 | 可以为 null。 |
| regionID | String | 81f7728662dd11ec810800155d307d5b | 可用区id。 |
请求示例
POST /v4/flow_package/buy
请求体body
{
"regionID": "100054c0416811e9a6690242ac110002",
"resourceType": "flow_pkg",
"cycleType": "YEAR",
"cycleCount": 1,
"count": 1,
"spec": 120,
"clientToken": "xxxxxxx"
}
响应示例
{
"statusCode": 800,
"message": "success",
"description": "成功",
"errorCode": "SUCCESS",
"returnObj": {
"masterOrderID": "08b383fc640711ed8a63acde48001122",
"masterOrderNO": null,
"masterResourceID": "dc3d7abe3f5e47ecaa51052316337fac",
"masterResourceStatus": "started",
"regionID": "81f7728662dd11ec810800155d307d5b"
}
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
