CreateTrafficMarkingPolicy - 创建流量标记策略 - 云企业网

流量标记策略通过流分类规则捕获符合规则的流量，捕获后，您可以为流量添加DSCP（Differentiated Services Code Point）值作为标记。您可以通过调用CreateTrafficMarkingPolicy创建流量标记策略。

接口说明

仅企业版转发路由器支持创建流量标记策略。
CreateTrafficMarkingPolicy 接口属于异步接口，即系统会先返回一个流量标记策略 ID，但该流量标记策略并未创建完成，系统后台的创建任务仍在进行。您可以调用 ListTrafficMarkingPolicies 接口查询流量标记策略的状态。
- 当流量标记策略处于 Creating 状态时，表示流量标记策略正在创建中，在该状态下，您只能对流量标记策略执行查询操作，不能执行其他操作。
- 当流量标记策略处于 Active 状态时，表示流量标记策略创建完成。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
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.	转发路由实例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	查看变更详情