如果您需要優(yōu)化和控制跨區(qū)域的網(wǎng)絡(luò)流量,您可以調(diào)用CreateCenInterRegionTrafficQosPolicy接口創(chuàng)建企業(yè)版轉(zhuǎn)發(fā)路由器下的跨地域流量調(diào)度策略。
接口說明
-
僅企業(yè)版轉(zhuǎn)發(fā)路由器下的跨地域連接支持創(chuàng)建跨地域流量調(diào)度策略。
-
流量調(diào)度功能僅作用在企業(yè)版轉(zhuǎn)發(fā)路由器的出方向。
例如,您創(chuàng)建了華東 1(杭州)與華北 1(青島)地域的跨地域連接,您在華東 1(杭州)地域的轉(zhuǎn)發(fā)路由器下配置流量調(diào)度功能后,在流量從華東 1(杭州)地域去往華北 1(青島)地域的過程中,流量調(diào)度功能可以幫您保證各類業(yè)務(wù)的使用帶寬。在流量從華北 1(青島)地域去往華東 1(杭州)地域的過程中,流量調(diào)度功能不幫您保證業(yè)務(wù)帶寬。
-
CreateCenInterRegionTrafficQosPolicy 接口屬于異步接口,即系統(tǒng)會(huì)先返回一個(gè)流量調(diào)度策略 ID,但該流量調(diào)度策略并未創(chuàng)建完成,系統(tǒng)后臺(tái)的創(chuàng)建任務(wù)仍在進(jìn)行。您可以調(diào)用 ListCenInterRegionTrafficQosPolicies 接口查詢流量調(diào)度策略的狀態(tài)。
- 當(dāng)流量調(diào)度策略處于 Creating 狀態(tài)時(shí),表示流量調(diào)度策略正在創(chuàng)建中,在該狀態(tài)下,您只能對(duì)流量調(diào)度策略執(zhí)行查詢操作,不能執(zhí)行其他操作。
- 當(dāng)流量調(diào)度策略處于 Active 狀態(tài)時(shí),表示流量調(diào)度策略創(chuàng)建完成。
前提條件
在調(diào)用 CreateCenInterRegionTrafficQosPolicy 接口前,確保已滿足以下條件:
- 已創(chuàng)建跨地域連接。具體操作,請(qǐng)參見 CreateTransitRouterPeerAttachment 。
- 已創(chuàng)建流量標(biāo)記策略。具體操作,請(qǐng)參見 CreateTrafficMarkingPolicy 。
調(diào)試
您可以在OpenAPI Explorer中直接運(yùn)行該接口,免去您計(jì)算簽名的困擾。運(yùn)行成功后,OpenAPI Explorer可以自動(dòng)生成SDK代碼示例。
授權(quán)信息
下表是API對(duì)應(yīng)的授權(quán)信息,可以在RAM權(quán)限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調(diào)用此API的權(quán)限。具體說明如下:
- 操作:是指具體的權(quán)限點(diǎn)。
- 訪問級(jí)別:是指每個(gè)操作的訪問級(jí)別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權(quán)的資源類型。具體說明如下:
- 對(duì)于必選的資源類型,用背景高亮的方式表示。
- 對(duì)于不支持資源級(jí)授權(quán)的操作,用
全部資源
表示。
- 條件關(guān)鍵字:是指云產(chǎn)品自身定義的條件關(guān)鍵字。
- 關(guān)聯(lián)操作:是指成功執(zhí)行操作所需要的其他權(quán)限。操作者必須同時(shí)具備關(guān)聯(lián)操作的權(quán)限,操作才能成功。
操作 | 訪問級(jí)別 | 資源類型 | 條件關(guān)鍵字 | 關(guān)聯(lián)操作 |
---|---|---|---|---|
cen:CreateCenInterRegionTrafficQosPolicy | create | *全部資源 * |
| 無 |
請(qǐng)求參數(shù)
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 客戶端 Token,用于保證請(qǐng)求的冪等性。 由客戶端生成該參數(shù)值,要保證在不同請(qǐng)求間唯一,最大值不超過 64 個(gè) ASCII 字符。 | 123e4567-e89b-12d3-a456-426655**** |
DryRun | boolean | 否 | 是否只預(yù)檢此次請(qǐng)求。取值:
| false |
TransitRouterId | string | 是 | 轉(zhuǎn)發(fā)路由器實(shí)例 ID。 | tr-8vbuqeo5h5pu3m01d**** |
TransitRouterAttachmentId | string | 是 | 跨地域連接 ID。 | tr-attach-r6g0m3epjehw57**** |
TrafficQosPolicyName | string | 否 | 流量調(diào)度策略的名稱。 名稱可以為空或長(zhǎng)度為 1~128 個(gè)字符,不能以 http://或 https://開頭。 | nametest |
TrafficQosPolicyDescription | string | 否 | 流量調(diào)度策略的描述信息。 描述可以為空或長(zhǎng)度為 1~256 個(gè)字符,不能以 http://或 https://開頭。 | desctest |
BandwidthGuaranteeMode | string | 否 | 帶寬保障類型,可以選擇按帶寬絕對(duì)值或者按帶寬百分比模式。取值:
| byBandwidthPercent |
TrafficQosQueues | array<object> | 否 | 流量調(diào)度策略包含的隊(duì)列信息。 最多支持創(chuàng)建 3 個(gè)隊(duì)列,更多隊(duì)列需要用 CreateCenInterRegionTrafficQosQueue 創(chuàng)建。 | |
object | 否 | 隊(duì)列信息。 | ||
QosQueueName | string | 否 | 當(dāng)前隊(duì)列的名稱。 一個(gè)流量調(diào)度策略最多支持創(chuàng)建 3 個(gè)隊(duì)列,每個(gè)隊(duì)列可以被指定一個(gè)隊(duì)列名稱。 名稱可以為空或長(zhǎng)度為 1~128 個(gè)字符,不能以 http://或 https://開頭。 | nametest |
RemainBandwidthPercent | string | 否 | 當(dāng)前隊(duì)列可使用的跨地域帶寬的百分比。 一個(gè)流量調(diào)度策略最多支持創(chuàng)建 10 個(gè)隊(duì)列,每個(gè)隊(duì)列可以被指定允許使用的跨地域帶寬百分比。 例如,您輸入 1,則表示符合當(dāng)前隊(duì)列的流量報(bào)文最多只能使用 1%的跨地域帶寬。 說明
一個(gè)流量調(diào)度策略下,所有隊(duì)列的跨地域帶寬百分比之和不能超過 100%。
| 1 |
Bandwidth | string | 否 | 當(dāng)前隊(duì)列可使用的跨地域帶寬的絕對(duì)值,單位是 Mbps。 一個(gè)流量調(diào)度策略最多支持創(chuàng)建 10 個(gè)隊(duì)列,每個(gè)隊(duì)列可以被指定允許使用的跨地域帶寬。 例如,您輸入 1,則表示符合當(dāng)前隊(duì)列的流量報(bào)文最多只能使用 1Mbps 的跨地域帶寬。 說明
一個(gè)流量調(diào)度策略下,所有已分配隊(duì)列的跨地域帶寬絕對(duì)值之和不能超過跨地域帶寬的值。
| 1 |
Dscps | array | 否 | 當(dāng)前隊(duì)列匹配的 DSCP 值。 一個(gè)流量調(diào)度策略最多支持創(chuàng)建 3 個(gè)隊(duì)列,每個(gè)隊(duì)列最多支持匹配 60 個(gè) DSCP 值,DSCP 值之間使用半角逗號(hào)(,)分隔。 | |
integer | 否 | 當(dāng)前隊(duì)列匹配的 DSCP 值。 一個(gè)流量調(diào)度策略最多支持創(chuàng)建 3 個(gè)隊(duì)列,每個(gè)隊(duì)列最多支持匹配 60 個(gè) DSCP 值,DSCP 值之間使用半角逗號(hào)(,)分隔。 | 5 | |
QosQueueDescription | string | 否 | 當(dāng)前隊(duì)列的描述信息。 一個(gè)流量調(diào)度策略最多支持創(chuàng)建 10 個(gè)隊(duì)列,每個(gè)隊(duì)列可以被添加一個(gè)隊(duì)列描述信息。 描述可以為空或長(zhǎng)度為 1~256 個(gè)字符,不能以 http://或 https://開頭。 | desctest |
返回參數(shù)
示例
正常返回示例
JSON
格式
{
"TrafficQosPolicyId": "qos-eczzew0v1kzrb5****",
"RequestId": "6DF9A765-BCD2-5C7E-8C32-C35C8A361A39"
}
錯(cuò)誤碼
HTTP status code | 錯(cuò)誤碼 | 錯(cuò)誤信息 | 描述 |
---|---|---|---|
400 | AssociationExist.TrafficQos | The traffic qos with the specified attachment already exists. | 該Attachment已存在流量調(diào)度策略。 |
400 | InvalidTransitRouterId.NotFound | The specified TransitRouterId is not found. | 指定的轉(zhuǎn)發(fā)路由器不存在 |
400 | IllegalParam.TransitRouterAttachmentId | TransitRouterAttachmentId is illegal. | 參數(shù)中指定的TrInstance不合法。 |
400 | InvalidParamSize.TrafficQosQueues | The queue size included in the traffic QoS policy exceeds the limit. | 流量調(diào)度策略中包含的隊(duì)列大小超出限制。 |
400 | IllegalParam.BandwidthGuaranteeModeMismatch | The BandwidthGuaranteeMode does not match the Bandwidth or RemainBandwidthPercent. | 帶寬保障類型和帶寬絕對(duì)值或百分比的類型不匹配。 |
400 | IllegalParam.AttachmentBandwidthExceed | The entered bandwidth causes the total QoS guaranteed bandwidth to exceed the cross-region bandwidth allocation value. | 輸入的帶寬使得QoS總保障帶寬超過了跨地域帶寬分配的值。 |
400 | IllegalParam.BandwidthGuaranteeMode | The input bandwidth guarantee type is not valid. | 輸入的帶寬保障類型不合法。 |
400 | MissingParam.RemainBandwidthPercent | RemainBandwidthPercent is missing. | 缺少保障帶寬百分比。 |
400 | MissingParam.Bandwidth | The parameter Bandwidth is mandatory. | 帶寬值參數(shù)是必需的。 |
400 | IllegalParam.RemainBandwidthPercent | The specified RemainBandwidthPercent is invalid. | 參數(shù)中指定的RemainBandwidthPercent不合法。 |
400 | IllegalParam.Bandwidth | Bandwidth is illegal | 跨地域連接時(shí)入?yún)捴捣欠ā?/span> |
400 | IllegalParam.BandwidthPackageStatus | The status of the bandwidth package is incorrect. | 帶寬包的狀態(tài)錯(cuò)誤。 |
400 | InvalidParameter | Invalid parameter. | 參數(shù)不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 賬號(hào)無權(quán)限操作。 |
訪問錯(cuò)誤中心查看更多錯(cuò)誤碼。
變更歷史
變更時(shí)間 | 變更內(nèi)容概要 | 操作 |
---|---|---|
2024-08-28 | OpenAPI 錯(cuò)誤碼發(fā)生變更、OpenAPI 入?yún)l(fā)生變更 | 查看變更詳情 |
2024-08-16 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
2024-07-10 | OpenAPI 錯(cuò)誤碼發(fā)生變更 | 查看變更詳情 |
2021-11-26 | 新增 OpenAPI | 查看變更詳情 |