调用CreateTrafficMarkingPolicy接口创建流量标记策略。

使用说明

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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateTrafficMarkingPolicy

系统规定参数。取值:CreateTrafficMarkingPolicy

ClientToken String 123e4567-e89b-12d3-a456-426****

客户端Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

说明 若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
DryRun Boolean false

是否只预检此次请求。取值:

  • true:发送检查请求,不会创建流量标记策略。检查项包括是否填写了必需参数、请求格式、业务限制等。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后直接创建流量标记策略。
TransitRouterId String tr-8vbuqeo5h5pu3m01d****

转发路由器实例ID。

TrafficMarkingPolicyName String nametest

流量标记策略的名称。

名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、短划线(-)和下划线(_)。

TrafficMarkingPolicyDescription String desctest

流量标记策略的描述信息。

描述信息的长度为2~128个字符,以大小写字母或中文开头,可包含数字、短划线(-)和下划线(_)。

Priority Integer 5

流量标记策略的优先级。取值范围:1~100

一个转发路由器实例下,每个流量标记策略的优先级需保证唯一。数字越小,优先级越高。

MarkingDscp Integer 5

为符合流分类规则的流量报文添加DSCP(Differentiated Services Code Point)值。取值范围:0~63

一个转发路由器实例下,每个流量标记策略的DCSP值需保证唯一。

TrafficMatchRules.N.MatchDscp Integer 6

流量报文的DSCP值。取值范围:0~63

流分类规则匹配包含指定DSCP值的流量,如果不设置则代表使流分类规则匹配任意DSCP值的流量。

说明 当前DSCP值是指流量报文进入跨地域连接前已携带的DSCP值。

一次最多支持创建50个流分类规则,每个流分类规则可指定匹配一个DSCP值。

TrafficMatchRules.N.DstCidr String 10.10.10.0/24

流量报文的目的网段。

流分类匹配目的IP地址在目的网段中的流量,如果不设置则代表使流分类规则匹配任意目的IP地址的流量。

一次最多支持创建50个流分类规则,每个流分类规则可指定一个目的网段。

TrafficMatchRules.N.TrafficMatchRuleDescription String desctest

流分类规则的描述信息。

一次最多支持创建50个流分类规则,每个流分类规则可添加一个描述信息。

描述信息的长度为2~128个字符,以大小写字母或中文开头,可包含数字、短划线(-)和下划线(_)。

TrafficMatchRules.N.Protocol String HTTP

流量报文的协议类型。

流量标记策略支持匹配HTTPHTTPSTCPUDPSSHTelnet等多种协议类型的流量。更多协议类型,请登录云企业网管理控制台查看。

一次最多支持创建50个流分类规则,每个流分类规则可指定匹配一个协议类型。

TrafficMatchRules.N.DstPortRange.N Integer 80

流量报文的目的端口。取值范围:-11~65535

流分类规则匹配目的端口号在目的端口范围中的流量,如果不设置则代表使流分类规则匹配任意目的端口号的流量。

当前参数最多支持输入两个端口号。输入格式说明如下:

  • 如果您只输入一个端口号,例如1,则系统默认匹配目的端口为1的流量。
  • 如果您输入了两个端口号,例如1和200,则系统默认匹配目的端口处于1至200范围内的流量。
  • 如果您输入了两个端口号且其中一个端口号为-1,则另一个端口也必须为-1,表示匹配任意目的端口。

一次最多支持创建50个流分类规则,每个流分类规则可指定一个目的端口范围。

TrafficMatchRules.N.SrcCidr String 192.168.10.0/24

流量报文的源网段。

流分类规则匹配源IP地址在源网段中的流量,如果不设置则代表使流分类规则匹配任意源IP地址的流量。

一次最多支持创建50个流分类规则,每个流分类规则可指定匹配一个源网段。

TrafficMatchRules.N.SrcPortRange.N Integer 1

流量报文的源端口。取值范围:-11~65535

流分类规则匹配源端口号在源端口范围中的流量,如果不设置则代表使流分类规则匹配任意源端口。

当前参数最多支持输入两个端口号。输入格式说明如下:

  • 如果您只输入一个端口号,例如1,则系统默认匹配源端口为1的流量。
  • 如果您输入了两个端口号,例如1和200,则系统默认匹配源端口处于1至200范围内的流量。
  • 如果您输入了两个端口号且其中一个端口号为-1,则另一个端口也必须为-1,表示匹配任意源端口。

一次最多支持创建50个流分类规则,每个流分类规则可指定一个源端口范围。

TrafficMatchRules.N.TrafficMatchRuleName String nametest

流分类规则的名称。

一次最多支持创建50个流分类规则,每个流分类规则可添加一个名称。

名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、短划线(-)和下划线(_)。

返回数据

名称 类型 示例值 描述
TrafficMarkingPolicyId String tm-u9nxup5kww5po8****

流量标记策略ID。

RequestId String 0876E54E-3E36-5C31-89F0-9EE8A9266F9A

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=CreateTrafficMarkingPolicy
&ClientToken=123e4567-e89b-12d3-a456-426****
&DryRun=false
&TransitRouterId=tr-8vbuqeo5h5pu3m01d****
&TrafficMarkingPolicyName=nametest
&TrafficMarkingPolicyDescription=desctest
&Priority=5
&MarkingDscp=5
&TrafficMatchRules=[{"MatchDscp":6,"DstCidr":"10.10.10.0/24","TrafficMatchRuleDescription":"desctest","Protocol":"HTTP","DstPortRange":[80],"SrcCidr":"192.168.10.0/24","SrcPortRange":[1],"TrafficMatchRuleName":"nametest"}]
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateTrafficMarkingPolicyResponse>
    <TrafficMarkingPolicyId>tm-u9nxup5kww5po8****</TrafficMarkingPolicyId>
    <RequestId>0876E54E-3E36-5C31-89F0-9EE8A9266F9A</RequestId>
</CreateTrafficMarkingPolicyResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TrafficMarkingPolicyId" : "tm-u9nxup5kww5po8****",
  "RequestId" : "0876E54E-3E36-5C31-89F0-9EE8A9266F9A"
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidTransitRouterId.NotFound TransitRouterId is not found. 转发路由实例ID不存在。

访问错误中心查看更多错误码。