为流量标记策略添加流分类规则。
接口说明
AddTrafficMatchRuleToTrafficMarkingPolicy接口属于异步接口,即系统会先返回一个RequestId,但该流分类规则并未创建完成,系统后台的创建任务仍在进行。您可以调用ListTrafficMarkingPolicies接口查询流分类规则的状态。
- 当流分类规则处于Creating状态时,表示流分类规则正在创建中,在该状态下,您只能对流分类规则执行查询操作,不能执行其他操作。
- 当流分类规则处于Active状态时,表示流分类规则创建完成。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cen:AddTrafficMatchRuleToTrafficMarkingPolicy | Read |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ClientToken | string | 否 | 客户端Token,用于保证请求的幂等性。 从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。 说明
若您未指定,则系统自动使用API请求的RequestId作为ClientToken标识。每次API请求的RequestId可能不一样。
| 123e4567-e89b-12d3-a456-426**** |
DryRun | boolean | 否 | 是否只预检此次请求。取值:
| false |
TrafficMarkingPolicyId | string | 是 | 流量标记策略ID。 | tm-u9nxup5kww5po8**** |
TrafficMatchRules | object [] | 否 | 流分类规则列表。 一次最多支持添加50个流分类规则。 | |
MatchDscp | integer | 否 | 流量报文的DSCP值。取值范围:0~63。 流分类规则匹配包含指定DSCP值的流量,如果不设置则代表使流分类规则匹配任意DSCP值的流量。 说明
当前DSCP值是指流量报文进入跨地域连接前已携带的DSCP值。
| 5 |
DstCidr | string | 否 | 流量报文的目的网段。 流分类匹配目的IP地址在目的网段中的流量,如果不设置则代表使流分类规则匹配任意目的IP地址的流量。 | 10.10.10.0/24 |
TrafficMatchRuleDescription | string | 否 | 流分类规则的描述信息。 描述信息的长度为2~128个字符,以大小写字母或中文开头,可包含数字、短划线(-)和下划线(_)。 | desctest |
Protocol | string | 否 | 流量报文的协议类型。 流分类规则支持匹配HTTP、HTTPS、TCP、UDP、SSH、Telnet等多种协议类型的流量。更多协议类型,请登录云企业网管理控制台查看。 | HTTP |
DstPortRange | array | 否 | 流量报文的目的端口。取值范围:-1、1~65535。 流分类规则匹配目的端口号在目的端口范围中的流量,如果不设置则代表使流分类规则匹配任意目的端口号的流量。 当前参数最多支持输入2个端口号。输入格式说明如下:
| |
integer | 否 | 流量报文的目的端口。取值范围:-1、1~65535。 流分类规则匹配目的端口号在目的端口范围中的流量,如果不设置则代表使流分类规则匹配任意目的端口号的流量。 当前参数最多支持输入两个端口号。输入格式说明如下:
| 80 | |
SrcCidr | string | 否 | 流量报文的源网段。 流分类规则匹配源IP地址在源网段中的流量,如果不设置则代表使流分类规则匹配任意源IP地址的流量。 | 192.168.10.0/24 |
SrcPortRange | array | 否 | 流量报文的源端口。取值范围:-1、1~65535。 流分类规则匹配源端口号在源端口范围中的流量,如果不设置则代表使流分类规则匹配任意源端口号的流量。 当前参数最多支持输入两个端口号。输入格式说明如下:
| |
integer | 否 | 流量报文的源端口。取值范围:-1、1~65535。 流分类规则匹配源端口号在源端口范围中的流量,如果不设置则代表使流分类规则匹配任意源端口。 当前参数最多支持输入两个端口号。输入格式说明如下:
| 200 | |
TrafficMatchRuleName | string | 否 | 流分类分则的名称。 名称长度为2~128个字符,以大小写字母或中文开头,可包含数字、短划线(-)和下划线(_)。 | nametest |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "0876E54E-3E36-5C31-89F0-9EE8A9266F9A"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidTrafficMarkingPolicyId.NotFound | Operation is failed because traffic marking policy id is not found. | 参数中指定的TrafficMarkingPolicyId不存在。 |
400 | IllegalParam.SrcCidr | The specified SrcCidr is invalid. | 参数中指定的SrcCidr不合法。 |
400 | IncorrectStatus.TrafficMarkingPolicy | The status of TrafficMarkingPolicy is incorrect. | 当前TrafficMarkingPolicy的状态不支持该操作,请稍后重试。 |
400 | IllegalParam.DstCidr | The specified DstCidr is invalid. | 参数中指定的DstCidr不合法。 |
400 | IllegalParam.Protocol | The specified Protocol is invalid. | 参数中指定的Protocol不合法。 |
400 | Duplicated.TrafficMatchRules | The parameter AddTrafficMatchRules are duplicated. | - |
400 | InstanceExist.TrafficMatchRules | The instance already exists. | TrafficMatchRules已存在。 |
400 | MissingParam.TrafficMatchRules | The parameter TrafficMatchRules is empty. | 传入的流分类规则为空。 |
400 | InvalidParameter | Invalid parameter. | 参数不合法。 |
400 | Unauthorized | The AccessKeyId is unauthorized. | 账号无权限操作。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||
---|---|---|---|---|---|---|
2023-08-04 | OpenAPI 错误码发生变更 | 看变更集 | ||||
| ||||||
2023-01-09 | OpenAPI 错误码发生变更 | 看变更集 | ||||
|