文档首页/ 弹性公网IP EIP/ API参考/ API/ 带宽（V2.0）/ 按需转包年/包月带宽
更新时间：2023-12-25 GMT+08:00
查看PDF
分享

按需转包年/包月带宽

功能介绍

该接口用于将按需计费模式的带宽转为包年/包月计费模式的带宽。

URI

POST /v2.0/{project_id}/bandwidths/change-to-period

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

bandwidth_ids

是

Array

待按需转包带宽列表

extendParam

是

CreatePrePaidPublicipExtendParamOption object

按需转包周期参数
表3 CreatePrePaidPublicipExtendParamOption

参数

是否必选

参数类型

描述

charge_mode

否

String
  • 功能说明：付费方式（预付费、按需付费；预付费，即包周期付费）
  • 取值范围：
    • prePaid -预付费，即包年包月；
    • postPaid-后付费，即按需付费；
  • 后付费的场景下，extendParam的其他字段都会被忽略。

缺省值：postPaid

枚举值：

  • prePaid
  • postPaid

period_type

否

String
  • 功能说明：订购资源的周期类型（包年、包月等）
  • 取值范围：
    • month-月
    • year-年
  • 约束：如果用包周期共享带宽创建时（即携带共享带宽id创建EIP）此字段可不填。付费方式是预付费且不是使用共享带宽创建IP时，该字段必选； 使用共享带宽创建IP时，带宽资源到期时间与IP的到期时间相同。

枚举值：

  • month
  • year

period_num

否

Integer
  • 功能说明：订购周期数
  • 取值范围：(后续会随运营策略变化)
    • period_type为month时，为[1,9]
    • period_type为year时，为[1,13]
  • 约束：同period_type约束。

最小值：1

最大值：9

is_auto_renew

否

Boolean
  • 功能说明：是否自动续订
  • 取值范围： false：不自动续订 true：自动续订
  • 约束：到期后，默认自动续订1个月（自动续订时间后续可能会变化），详情可联系客服咨询。

缺省值：false

is_auto_pay

否

Boolean
  • 功能说明：下单订购后，是否自动从客户的账户中支付
  • 取值范围：
    • true：自动支付，从账户余额自动扣费
    • false：只提交订单不支付，需要客户手动去支付
  • 约束：自动支付时，只能使用账户的现金支付；如果要使用代金券，请选择不自动支付，然后在用户费用中心，选择代金券支付。

缺省值：false

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

bandwidth_ids

Array

转包带宽列表

order_id

String

订单ID

request_id

String

请求ID

请求示例

POST /v2.0/{project_id}/bandwidths/change-to-period

{
  "bandwidth_ids" : [ "fe2a11c7-c880-49f7-b1e0-e151df2cc836" ],
  "extendParam" : {
    "charge_mode" : "prePaid",
    "period_type" : "month",
    "period_num" : 1,
    "is_auto_renew" : false,
    "is_auto_pay" : true
  }
}

响应示例

状态码： 200

OK

{
  "bandwidth_ids" : [ "fe2a11c7-c880-49f7-b1e0-e151df2cc836" ],
  "order_id" : "CS2212141741L0QZG",
  "request_id" : "8bcadb5d-1bf4-42e8-909f-1606ecf781ce"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 带宽（V2.0）