華為云計(jì)算 云知識(shí) 按需轉(zhuǎn)包APIChangeBandwidthToPeriod
按需轉(zhuǎn)包APIChangeBandwidthToPeriod

 

功能介紹

該接口用于將按需計(jì)費(fèi)模式的帶寬轉(zhuǎn)為包年/包月計(jì)費(fèi)模式的帶寬。

調(diào)試

您可以在API Explorer中調(diào)試該接口,支持自動(dòng)認(rèn)證鑒權(quán)。API Explorer可以自動(dòng)生成SDK代碼示例,并提供SDK代碼示例調(diào)試功能。

URI

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

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項(xiàng)目ID

請(qǐng)求參數(shù)

表2 請(qǐng)求Body參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

bandwidth_ids

Array

待按需轉(zhuǎn)包帶寬列表

extendParam

CreatePrePaidPublicipExtendParamOption object

按需轉(zhuǎn)包周期參數(shù)

表3 CreatePrePaidPublicipExtendParamOption

參數(shù)

是否必選

參數(shù)類型

描述

charge_mode

String

  • 功能說(shuō)明:付費(fèi)方式(預(yù)付費(fèi)、按需付費(fèi);預(yù)付費(fèi),即包周期付費(fèi))

  • 取值范圍:

    • prePaid -預(yù)付費(fèi),即包年包月;

    • postPaid-后付費(fèi),即按需付費(fèi);

  • 后付費(fèi)的場(chǎng)景下,extendParam的其他字段都會(huì)被忽略。

缺省值:postPaid

枚舉值:

  • prePaid

  • postPaid

period_type

String

  • 功能說(shuō)明:訂購(gòu)資源的周期類型(包年、包月等)

  • 取值范圍:

    • month-月

    • year-年

  • 約束:如果用包周期共享帶寬創(chuàng)建時(shí)(即攜帶共享帶寬id創(chuàng)建EIP)此字段可不填。付費(fèi)方式是預(yù)付費(fèi)且不是使用共享帶寬創(chuàng)建IP時(shí),該字段必選; 使用共享帶寬創(chuàng)建IP時(shí),帶寬資源到期時(shí)間與IP的到期時(shí)間相同。

枚舉值:

  • month

  • year

period_num

Integer

  • 功能說(shuō)明:訂購(gòu)周期數(shù)

  • 取值范圍:(后續(xù)會(huì)隨運(yùn)營(yíng)策略變化)

    • period_type為month時(shí),為[1,9]

    • period_type為year時(shí),為[1,3]

  • 約束:同period_type約束。

最小值:1

最大值:9

is_auto_renew

Boolean

  • 功能說(shuō)明:是否自動(dòng)續(xù)訂

  • 取值范圍: false:不自動(dòng)續(xù)訂 true:自動(dòng)續(xù)訂

  • 約束:到期后,默認(rèn)自動(dòng)續(xù)訂1個(gè)月(自動(dòng)續(xù)訂時(shí)間后續(xù)可能會(huì)變化),詳情可聯(lián)系客服咨詢。

缺省值:false

is_auto_pay

Boolean

  • 功能說(shuō)明:下單訂購(gòu)后,是否自動(dòng)從客戶的賬戶中支付

  • 取值范圍:

    • true:自動(dòng)支付,從賬戶余額自動(dòng)扣費(fèi)

    • false:只提交訂單不支付,需要客戶手動(dòng)去支付

  • 約束:自動(dòng)支付時(shí),只能使用賬戶的現(xiàn)金支付;如果要使用代金券,請(qǐng)選擇不自動(dòng)支付,然后在用戶費(fèi)用中心,選擇代金券支付。

缺省值:false

響應(yīng)參數(shù)

狀態(tài)碼: 200

表4 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

bandwidth_ids

Array

轉(zhuǎn)包帶寬列表

order_id

String

訂單ID

request_id

String

請(qǐng)求ID

請(qǐng)求示例

將ID為fe2a11c7-c880-49f7-b1e0-e151df2cc836的按需帶寬轉(zhuǎn)為包周期帶寬,訂購(gòu)周期為1個(gè)月,不自動(dòng)續(xù)費(fèi)。

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
  }
}

響應(yīng)示例

狀態(tài)碼: 200

按需轉(zhuǎn)包正常返回

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

狀態(tài)碼

狀態(tài)碼

描述

200

按需轉(zhuǎn)包正常返回

錯(cuò)誤碼

請(qǐng)參見(jiàn)錯(cuò)誤碼。