流量標記策略通過流分類規則捕獲符合規則的流量,捕獲后,您可以為流量添加DSCP(Differentiated Services Code Point)值作為標記。您可以通過調用CreateTrafficMarkingPolicy創建流量標記策略。
接口說明
-
僅企業版轉發路由器支持創建流量標記策略。
-
CreateTrafficMarkingPolicy 接口屬于異步接口,即系統會先返回一個流量標記策略 ID,但該流量標記策略并未創建完成,系統后臺的創建任務仍在進行。您可以調用 ListTrafficMarkingPolicies 接口查詢流量標記策略的狀態。
- 當流量標記策略處于 Creating 狀態時,表示流量標記策略正在創建中,在該狀態下,您只能對流量標記策略執行查詢操作,不能執行其他操作。
- 當流量標記策略處于 Active 狀態時,表示流量標記策略創建完成。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
cen:CreateTrafficMarkingPolicy | create | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 客戶端 Token,用于保證請求的冪等性。 從您的客戶端生成一個參數值,確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 說明
若您未指定,則系統自動使用 API 請求的 RequestId 作為 ClientToken 標識。每次 API 請求的 RequestId 可能不一樣。
| 123e4567-e89b-12d3-a456-426**** |
DryRun | boolean | 否 | 是否只預檢此次請求。取值:
| false |
TransitRouterId | string | 是 | 轉發路由器實例 ID。 | tr-8vbuqeo5h5pu3m01d**** |
TrafficMarkingPolicyName | string | 否 | 流量標記策略的名稱。 名稱可以為空或長度為 1~128 個字符,不能以 http://或 https://開頭。 | nametest |
TrafficMarkingPolicyDescription | string | 否 | 流量標記策略的描述信息。 描述可以為空或長度為 1~256 個字符,不能以 http://或 https://開頭。 | desctest |
Priority | integer | 是 | 流量標記策略的優先級。取值范圍:1~100。 一個轉發路由器實例下,每個流量標記策略的優先級需保證唯一。數字越小,優先級越高。 | 5 |
MarkingDscp | integer | 是 | 為符合流分類規則的流量報文添加 DSCP(Differentiated Services Code Point)值。取值范圍:0~63。 一個轉發路由器實例下,每個流量標記策略的 DCSP 值需保證唯一。 | 5 |
TrafficMatchRules | array<object> | 否 | 流量標記策略的流分類規則列表。 符合流分類規則的流量報文將被添加流量策略的 DSCP 值。 一次最多支持創建 50 個流分類規則。 | |
object | 否 | 流分類規則信息。 | ||
MatchDscp | integer | 否 | 流量報文的 DSCP 值。取值范圍:0~63。 流分類規則匹配包含指定 DSCP 值的流量,如果不設置則代表使流分類規則匹配任意 DSCP 值的流量。 說明
當前 DSCP 值是指流量報文進入跨地域連接前已攜帶的 DSCP 值。
一次最多支持創建 50 個流分類規則,每個流分類規則可指定匹配一個 DSCP 值。 | 6 |
DstCidr | string | 否 | 流量報文的目的網段,支持 IPv4 和 IPv6 地址。 流分類匹配目的 IP 地址在目的網段中的流量,如果不設置則代表使流分類規則匹配任意目的 IP 地址的流量。 一次最多支持創建 50 個流分類規則,每個流分類規則可指定一個目的網段。 | 10.10.10.0/24 |
TrafficMatchRuleDescription | string | 否 | 流分類規則的描述信息。 一次最多支持創建 50 個流分類規則,每個流分類規則可添加一個描述信息。 描述可以為空或長度為 1~256 個字符,不能以 http://或 https://開頭。 | desctest |
Protocol | string | 否 | 流量報文的協議類型。 流量標記策略支持匹配 HTTP、HTTPS、TCP、UDP、SSH、Telnet 等多種協議類型的流量。更多協議類型,請登錄云企業網管理控制臺查看。 部分協議擁有固定的端口。單擊查看端口詳情。
一次最多支持創建 50 個流分類規則,每個流分類規則可指定匹配一個協議類型。 | HTTP |
DstPortRange | array | 否 | 流量報文的目的端口。取值范圍:-1、1~65535。 流分類規則匹配目的端口號在目的端口范圍中的流量,如果不設置則代表使流分類規則匹配任意目的端口號的流量。 當前參數最多支持輸入兩個端口號。輸入格式說明如下:
一次最多支持創建 50 個流分類規則,每個流分類規則可指定一個目的端口范圍。 | |
integer | 否 | 流量報文的目的端口。取值范圍:-1、1~65535。 流分類規則匹配目的端口號在目的端口范圍中的流量,如果不設置則代表使流分類規則匹配任意目的端口號的流量。 當前參數最多支持輸入兩個端口號。輸入格式說明如下:
一次最多支持創建 50 個流分類規則,每個流分類規則可指定一個目的端口范圍。 | 80 | |
SrcCidr | string | 否 | 流量報文的源網段,支持 IPv6 和 IPv4 地址。 流分類規則匹配源 IP 地址在源網段中的流量,如果不設置則代表使流分類規則匹配任意源 IP 地址的流量。 一次最多支持創建 50 個流分類規則,每個流分類規則可指定匹配一個源網段。 | 192.168.10.0/24 |
SrcPortRange | array | 否 | 流量報文的源端口。取值范圍:-1、1~65535。 流分類規則匹配源端口號在源端口范圍中的流量,如果不設置則代表使流分類規則匹配任意源端口。 當前參數最多支持輸入兩個端口號。輸入格式說明如下:
一次最多支持創建 50 個流分類規則,每個流分類規則可指定一個源端口范圍。 | |
integer | 否 | 流量報文的源端口。取值范圍:-1、1~65535。 流分類規則匹配源端口號在源端口范圍中的流量,如果不設置則代表使流分類規則匹配任意源端口。 當前參數最多支持輸入兩個端口號。輸入格式說明如下:
一次最多支持創建 50 個流分類規則,每個流分類規則可指定一個源端口范圍。 | 1 | |
TrafficMatchRuleName | string | 否 | 流分類規則的名稱。 一次最多支持創建 50 個流分類規則,每個流分類規則可添加一個名稱。 名稱可以為空或長度為 1~128 個字符,不能以 http://或 https://開頭。 | nametest |
AddressFamily | string | 否 | 地址類型,有效值為 IPv4 或者 IPv6 或者為空。 | IPv4 |
返回參數
示例
正常返回示例
JSON
格式
{
"TrafficMarkingPolicyId": "tm-u9nxup5kww5po8****",
"RequestId": "0876E54E-3E36-5C31-89F0-9EE8A9266F9A"
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
400 | InvalidTransitRouterId.NotFound | TransitRouterId is not found. | 轉發路由實例ID不存在。 |
400 | IllegalParam.Protocol | Protocol is illegal. | 參數中指定的Protocol不合法。 |
400 | OperationFailed.TransitRouterType | Operation failed because The Basic TransitRouter does not support this action. | 基礎版轉發路由器不支持該操作。 |
400 | IllegalParam.Priority | Priority is illegal. | 參數中指定的Priority不合法。 |
400 | IllegalParam.MarkingDscp | MarkingDscp is illegal. | 參數中指定的MarkingDscp不合法。 |
400 | IllegalParam.SrcCidr | SrcCidr is illegal. | 參數中指定的SrcCidr不合法。 |
400 | IllegalParam.DstCidr | DstCidr is illegal. | 參數中指定的DstCidr不合法。 |
400 | Duplicated.Priority | The parameter Priority is duplicated. | Priority重復。 |
400 | Duplicated.MarkingDscp | The parameter MarkingDscp is duplicated. | MarkingDscp重復。 |
400 | Duplicated.TrafficMatchRules | The parameter TrafficMatchRules are duplicated. | 參數中指定的TrafficMatchRules條目重復。 |
400 | QuotaExceeded.TrafficMatchRule | The maximum number of TrafficMatchRule per Transit Router is exceeded. | 每個轉發路由器實例支持創建的流分類規則的個數超限,可提交工單提升額度。 |
400 | IllegalParam.MatchDscp | MarkingDscp is invalid. | MarkingDscp參數不合法。 |
400 | IllegalParam.SrcPortRange | The specified SrcPortRange is illegal. | 源端口不合法 |
400 | IllegalParam.DstPortRange | The specified DstPortRange is illegal. | 目的端口不合法 |
400 | AttrMismatching.CidrAddressFamily | Attribute SrcCidr or DstCidr of TrafficMarkRule does not match AddressFamily. | 流分類規則的源網段或目的網段與地址族不匹配,請修正后重試。 |
400 | IllegalParam.AddressFamily | AddressFamily is illegal. | 請求參數AddressFamily值非法,有效值為IPv4或IPv6。 |
400 | AttrMismatching.SrcCidrDstCidr | Attribute SrcCidr of TrafficMarkRule does not match DstCidr. | 流分類規則的源網段和目的網段的地址族不一致,請修正后重試。 |
400 | AttrMismatching.CidrProtocol | Attribute SrcCidr or DstCidr of TrafficMarkRule does not match Protocol. | 流分類規則的流量報文的源網段(SrcCidr)或目的網段(DstCidr)與協議(Protocol)不匹配,請按照官方文檔修改后再重新執行該操作。 |
400 | InvalidTransitRouterMode.NeedUpgrade | TransitRouter need to upgrade. | 當前轉發路由器模式不支持。 |
400 | OperationUnsupported.DstPortRange | Current TR version does not support setting destination port range. | 當前TR版本流分類規則不支持設置目標端口范圍 |
400 | OperationUnsupported.SrcPortRange | Current TR version does not support setting source port range. | 當前TR版本不支持設置源端口范圍 |
400 | OperationUnsupported.IPv6Cidr | The traffic marking policy for current TR type does not support IPv6 CIDR. | 基礎版轉發路由器的流量標記策略中流分類規則不支持IPv6網段。 |
400 | InvalidParameter | Invalid parameter. | 參數不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 賬號無權限操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-09-10 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-08-20 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-04-19 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2024-03-15 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-12-07 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2023-01-09 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
2021-11-26 | 新增 OpenAPI | 查看變更詳情 |