流量標記策略通過流分類規則捕獲符合規則的流量,捕獲後,您可以為流量添加DSCP(Differentiated Services Code Point)值作為標記。您可以通過調用CreateTrafficMarkingPolicy建立流量標記策略。
介面說明
-
僅企業版轉寄路由器支援建立流量標記策略。
-
CreateTrafficMarkingPolicy 介面屬於非同步介面,即系統會先返回一個流量標記策略 ID,但該流量標記策略並未建立完成,系統背景建立任務仍在進行。您可以調用 ListTrafficMarkingPolicies 介面查詢流量標記策略的狀態。
當流量標記策略處於 Creating 狀態時,表示流量標記策略正在建立中,在該狀態下,您只能對流量標記策略執行查詢操作,不能執行其他動作。
當流量標記策略處於 Active 狀態時,表示流量標記策略建立完成。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
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 |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回結果。 |
||
| TrafficMarkingPolicyId |
string |
流量標記策略 ID。 |
tm-u9nxup5kww5po8**** |
| RequestId |
string |
請求 ID。 |
0876E54E-3E36-5C31-89F0-9EE8A9266F9A |
樣本
正常返回樣本
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 | IncorrectStatus.TransitRouterInstance | The status of TransitRouter is incorrect. | 轉寄路由器狀態不正確。 |
| 400 | InvalidParameter | Invalid parameter. | 參數不合法。 |
| 400 | Unauthorized | The AccessKeyId is unauthorized. | 帳號無許可權操作。 |
| 400 | MissingParam.TransitRouterId | The parameter TransitrouterId is mandatory. | 缺少參數TransitRouterId。 |
| 400 | OperationUnsupported.TransitRouterType | The specified TransitRouterType does not support the operation. | 當前TransitRouter類型不支援該操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。