使用CreateTrafficMarkingPolicy建立流量標記策略-雲企業網-阿里雲 - Cloud Enterprise Network

流量標記策略透過流分類規則擷取符合規則的流量，擷取後，您可以為流量新增 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

*All Resource

*

無

請求參數

名稱	類型	必填	描述	樣本值
ClientToken	string	否	用戶端 Token，用於保證請求的冪等性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。說明若您未指定，則系統自動使用 API 請求的 RequestId 作為 ClientToken 識別碼。每次 API 請求的 RequestId 可能不一樣。	123e4567-e89b-12d3-a456-426****
DryRun	boolean	否	是否僅預檢此次請求。取值： true：傳送檢查請求，不會建立流量標記策略。檢查項目包括是否填寫了必要參數、請求格式、業務限制等。如果檢查不通過，則返回對應錯誤。如果檢查通過，則返回錯誤碼 `DryRunOperation`。 false（預設值）：傳送正常請求，通過檢查後直接建立流量標記策略。	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 等多種通訊協定類型的流量。更多通訊協定類型，請登入雲企業網管理主控台檢視。部分通訊協定擁有固定的連接埠。按一下檢視連接埠詳情。通訊協定類型為 ICMP 時，目的連接埠號需指定為 -1。通訊協定類型為 GRE 時，目的連接埠號需指定為 -1。通訊協定類型為 SSH 時，目的連接埠號需指定為 22。通訊協定類型為 Telnet 時，目的連接埠號需指定為 23。通訊協定類型為 HTTP 時，目的連接埠號需指定為 80。通訊協定類型為 HTTPS 時，目的連接埠號需指定為 443。通訊協定類型為 MS SQL 時，目的連接埠號需指定為 1443。通訊協定類型為 Oracle 時，目的連接埠號需指定為 1521。通訊協定類型為 Mysql 時，目的連接埠號需指定為 3306。通訊協定類型為 RDP 時，目的連接埠號需指定為 3389。通訊協定類型為 Postgre SQL 時，目的連接埠號需指定為 5432。通訊協定類型為 Redis 時，目的連接埠號需指定為 6379。一次最多支援建立 50 個流分類規則，每個流分類規則可指定匹配一個通訊協定類型。	HTTP
DstPortRange	array	否	流量封包的目的連接埠。取值範圍：-1、1~65535。流分類規則匹配目的連接埠號在目的連接埠範圍中的流量，如果不設定則代表使流分類規則匹配任意目的連接埠號的流量。當前參數最多支援輸入兩個連接埠號。輸入格式說明如下：如果您只輸入一個連接埠號，例如 1，則系統預設匹配目的連接埠為 1 的流量。如果為 -1，則表示匹配任意目的連接埠。如果您輸入了兩個連接埠號，例如 1 和 200，則系統預設匹配目的連接埠處於 1 至 200 範圍內的流量。如果您輸入了兩個連接埠號且其中一個連接埠號為 -1，則另一個連接埠也必須為 -1，表示匹配任意目的連接埠。一次最多支援建立 50 個流分類規則，每個流分類規則可指定一個目的連接埠範圍。
	integer	否	流量封包的目的連接埠。取值範圍：-1、1~65535。流分類規則匹配目的連接埠號在目的連接埠範圍中的流量，如果不設定則代表使流分類規則匹配任意目的連接埠號的流量。當前參數最多支援輸入兩個連接埠號。輸入格式說明如下：如果您只輸入一個連接埠號，例如 1，則系統預設匹配目的連接埠為 1 的流量。如果您輸入了兩個連接埠號，例如 1 和 200，則系統預設匹配目的連接埠處於 1 至 200 範圍內的流量。如果您輸入了兩個連接埠號且其中一個連接埠號為 -1，則另一個連接埠也必須為 -1，表示匹配任意目的連接埠。一次最多支援建立 50 個流分類規則，每個流分類規則可指定一個目的連接埠範圍。	80
SrcCidr	string	否	流量封包的來源網段，支援 IPv6 和 IPv4 位址。流分類規則匹配來源 IP 位址在來源網段中的流量，如果不設定則代表使流分類規則匹配任意來源 IP 位址的流量。一次最多支援建立 50 個流分類規則，每個流分類規則可指定匹配一個來源網段。	192.168.10.0/24
SrcPortRange	array	否	流量封包的來源連接埠。取值範圍：-1、1~65535。流分類規則匹配來源連接埠號在來源連接埠範圍中的流量，如果不設定則代表使流分類規則匹配任意來源連接埠。當前參數最多支援輸入兩個連接埠號。輸入格式說明如下：如果您只輸入一個連接埠號，例如 1，則系統預設匹配來源連接埠為 1 的流量。如果為 -1，則表示匹配任意來源連接埠。如果您輸入了兩個連接埠號，例如 1 和 200，則系統預設匹配來源連接埠處於 1 至 200 範圍內的流量。如果您輸入了兩個連接埠號且其中一個連接埠號為 -1，則另一個連接埠也必須為 -1，表示匹配任意來源連接埠。一次最多支援建立 50 個流分類規則，每個流分類規則可指定一個來源連接埠範圍。
	integer	否	流量封包的來源連接埠。取值範圍：-1、1~65535。流分類規則匹配來源連接埠號在來源連接埠範圍中的流量，如果不設定則代表使流分類規則匹配任意來源連接埠。當前參數最多支援輸入兩個連接埠號。輸入格式說明如下：如果您只輸入一個連接埠號，例如 1，則系統預設匹配來源連接埠為 1 的流量。如果您輸入了兩個連接埠號，例如 1 和 200，則系統預設匹配來源連接埠處於 1 至 200 範圍內的流量。如果您輸入了兩個連接埠號且其中一個連接埠號為 -1，則另一個連接埠也必須為 -1，表示匹配任意來源連接埠。一次最多支援建立 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.	參數中指定的 TransitRouterId 不存在。
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.	傳入的流分類規則重複。
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 類型不支援此操作。
400	InvalidParameter.TransitRouterId	The specified parameter TransitRouterId is invalid.	輸入的參數 TransitRouterId 不合法。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。