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