要實現(xiàn)跨地域網(wǎng)絡(luò)實例互通,您必須購買帶寬包,您可以調(diào)用CreateCenBandwidthPackage接口創(chuàng)建帶寬包。
接口說明
-
在創(chuàng)建帶寬包實例時需要指定互通區(qū)域。帶寬包的區(qū)域是地域的集合,每個區(qū)域包含一個或多個阿里云地域,您可以根據(jù)要互通的地域來選擇帶寬包的互通區(qū)域。關(guān)于區(qū)域和地域的關(guān)系,請參見購買帶寬包。
-
帶寬包的計費詳情,請參見計費說明。
-
CreateCenBandwidthPackage 接口屬于異步接口,即系統(tǒng)會先返回一個帶寬包實例 ID,但該帶寬包并未創(chuàng)建完成,系統(tǒng)后臺的創(chuàng)建任務(wù)仍在進行。您可以調(diào)用 DescribeCenBandwidthPackages 接口查詢帶寬包的狀態(tài),當(dāng)帶寬包處于 Idle 或 InUse 狀態(tài)時,表示帶寬包創(chuàng)建完成。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權(quán)信息
下表是API對應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
cen:CreateCenBandwidthPackage | create | *CenBandwidthPackage acs:cen:*:{#accountId}:cenbandwidthpackage/* |
| 無 |
請求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。 由客戶端生成該參數(shù)值,需保證該參數(shù)在不同請求間唯一,最大值不超過 64 個 ASCII 字符。 | 02fb3da4-130e-11e9-8e44-001**** |
Name | string | 否 | 帶寬包實例的名稱。 名稱可以為空或長度為 1~128 個字符,不能以 http://或 https://開頭。 | nametest |
Description | string | 否 | 帶寬包實例的描述信息。 描述可以為空或長度為 1~256 個字符,不能以 http://或 https://開頭。 | namedesc |
Bandwidth | integer | 是 | 帶寬包實例的帶寬峰值。單位:Mbps。取值范圍:2~10000。 | 2 |
GeographicRegionAId | string | 是 | 網(wǎng)絡(luò)實例所屬的區(qū)域。取值:
| China |
GeographicRegionBId | string | 是 | 另一個網(wǎng)絡(luò)實例所屬的區(qū)域。取值:
| China |
BandwidthPackageChargeType | string | 否 | 帶寬包實例的付費類型。取值: PREPAY,表示先付費后使用的付費方式。 | PREPAY |
Period | integer | 否 | 帶寬包實例的購買時長。默認(rèn)值:1。
說明
當(dāng) BandwidthPackageChargeType 為 PREPAY 時本參數(shù)必填。
| 1 |
PricingCycle | string | 否 | 帶寬包實例的計費周期。取值:
| Month |
AutoPay | boolean | 否 | 是否自動支付帶寬包實例的賬單。取值:
如果您選擇不自動支付賬單,在您調(diào)用本接口后,請前往控制臺的訂單中心完成支付,實例才能創(chuàng)建成功。 | false |
AutoRenew | boolean | 否 | 是否開啟自動續(xù)費功能。取值:
說明
目前僅預(yù)付費帶寬包支持自動續(xù)費。
| false |
AutoRenewDuration | integer | 否 | 自動續(xù)費時長。單位:月。取值范圍:0~2147483647。默認(rèn)值:1。 | 1 |
Tag | array<object> | 否 | 標(biāo)簽信息。 一次最多支持輸入 20 個標(biāo)簽信息。 | |
object | 否 | |||
Key | string | 否 | 資源的標(biāo)簽鍵。 一旦傳入該值,則不允許為空字符串。最多支持 64 個字符,不能以 一次最多支持輸入 20 個標(biāo)簽的標(biāo)簽鍵。 | tagtest |
Value | string | 否 | 資源的標(biāo)簽值。 標(biāo)簽值可以為空或輸入不超過 128 個字符的字符串,不能以 每一個標(biāo)簽鍵對應(yīng)一個標(biāo)簽值,一次最多支持輸入 20 個標(biāo)簽鍵對應(yīng)的標(biāo)簽值。 | tagtest |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"CenBandwidthPackageId": "cenbwp-4c2zaavbvh5fx****",
"CenBandwidthPackageOrderId": "20156420004****",
"RequestId": "E4B345CD-2CBA-4881-AF6D-E5D9BAE1CA7B"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | UnSupported.ChargeType | The charge type is not supported. | 不支持該付費類型。 |
400 | ParameterIllegal.BandwidthPackage | The parameter of bandwidth packaged is illegal. | 參數(shù)中指定的BandwidthPackage不合法。 |
400 | OperationInvalid.UserCanNotBuyCrossBorderBwp | According to the laws and regulations of the operator and mainland China, you are currently not eligible to purchase or renew a cross-border bandwidth package. Please contact online customer service or your business manager for consultation. | 根據(jù)運營商及中國大陸法律法規(guī)的要求,您當(dāng)前暫不符合購買/續(xù)費跨境帶寬包條件,請聯(lián)系在線客服或您的商務(wù)經(jīng)理咨詢處理。 |
400 | OperationInvalid.UserCanNotBuyBwp | The user can not buy Cen bandwidthPackage. | 用戶不允許購買CEN帶寬包 |
400 | Order.AccountStatusIllegal | Illegal account status for postpay service not opened for this account. | 賬號未開通后付費白名單,請開通后重試。 |
400 | InvalidParameter | Invalid parameter. | 參數(shù)不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 賬號無權(quán)限操作。 |
500 | PayFor.AccountMoneyValidateError | Your channel merchant quota is insufficient. Please contact the channel merchant. | 您的渠道商額度不足,請與渠道商聯(lián)系 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-11-22 | OpenAPI 描述信息更新、OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2024-07-26 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2024-05-17 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2023-12-13 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
2023-07-13 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |