创建带宽v3
更新时间 2026-07-07 14:17:28
最近更新时间: 2026-07-07 14:17:28
接口功能介绍
- 创建资源包带宽或单独付费带宽。
接口约束
无
URI
POST /v3/bandwidth/create
路径参数 无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| name | 是 | String | 带宽名称,只能由中文、英文字母、数字、下划线、中划线和小数点组成,长度限制1-16个字符 | ||
| size | 是 | Integer | 带宽大小(单位:Mbps) | ||
| resourcePackOid | 否 | String | 资源包ID(仅创建资源包带宽时有效) | ||
| vpcOid | 是 | String | VPC ID | ||
| subnetOidList | 是 | Array of Strings | 子网ID列表,长度至少为1 | ||
| billMode | 否 | String | 订购类型(仅创建单独付费带宽有效)。取值范围: - Cycle:包周期。 - OnDemand:按需。 | ||
| chargeType | 否 | String | 计费方式(仅订购类型为按需时有效):Bandwidth-固定带宽,Traffic-按流量使用 | ||
| dedicatedPublicIP | 否 | Boolean | 是否独占公网IP,默认false。取值范围: - true:是。 - false:否。 | ||
| cycleType | 否 | String | 周期类型(仅订购类型为包周期时有效)。取值范围: - Month:按月。 | ||
| cycleCnt | 否 | Integer | 周期数(仅订购类型为包周期时有效)。最大36个月。 | ||
| autoPay | 否 | Boolean | 是否自动支付(仅订购类型为包周期时有效),默认false。取值范围: - true:是。(需账号有足够金额) - false:否。 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。可能值: - 800:请求成功。 - 900:请求失败。 | 800 | |
| error | String | 错误码。 | ECPC_1000 | |
| message | String | 提示信息。 | OK. | |
| returnObj | Object | 返回数据对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| newOrderNo | String | 订单号(仅单独付费带宽有效)。 | ||
| newOrderId | String | 订单id(仅单独付费带宽有效)。 | ||
| totalPrice | String | 总价格(仅单独付费带宽有效)。 | ||
| submitted | Boolean | 是否提交成功(仅单独付费带宽有效)。 | ||
| errorMessage | String | 错误信息(仅单独付费带宽有效)。 |
枚举参数
无
请求示例
请求url
https://{host}?regionId=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
请求头header
无
请求体body
{
"name":"openapi-xxx",
"size":2,
"resourcePackOid":"res-xxx",
"vpcOid":"vpc-xxx",
"subnetOidList":["sn-xx"]
}
响应示例
{
"statusCode":800,
"message":"OK.",
"returnObj":{
"newOrderNo":20250718141255003733,
"newOrderId":"29471d1d08694681ad87ebf95e29e71a",
"totalPrice":"",
"submitted":true,
"errorMessage":""
}
}
状态码
请参考 状态码
错误码
请参考 错误码