调用ListTrafficMarkingPolicies接口查询流量标记策略的信息。

使用说明

在调用ListTrafficMarkingPolicies接口过程中:

  • 如果您未输入流量标记策略ID(即未指定TrafficMarkingPolicyId参数的值),则接口会根据TransitRouterIdTrafficMarkingPolicyNameTrafficMarkingPolicyDescription参数的值仅返回流量标记策略的信息,并不会返回流量标记策略下流分类规则的信息(即响应中不包含TrafficMatchRules字段)。
  • 如果您输入了流量标记策略ID(即指定了TrafficMarkingPolicyId参数的值),则接口会为您返回该流量标记策略的信息以及该流量标记策略下流分类规则的信息(即响应中包含TrafficMatchRules字段)。

    如果TrafficMatchRules字段为空数组,则表示当前流量标记策略下并不存在流分类规则。

调试

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

请求参数

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

系统规定参数。取值:ListTrafficMarkingPolicies

TransitRouterId String tr-bp1rmwxnk221e3fas****

转发路由器实例ID。

TrafficMarkingPolicyId String tm-iz5egnyitxiroq****

流量标记策略ID。

TrafficMarkingPolicyName String nametest

流量标记策略的名称。

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

TrafficMarkingPolicyDescription String desctest

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

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

MaxResults Integer 20

分批次查询时每次显示的条目数。取值范围:1~100,默认值:20

NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次API调用返回的NextToken值。

返回数据

名称 类型 示例值 描述
NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌(Token)。

  • 如果NextToken为空表示没有下一次查询。
  • 如果NextToken有返回值,该取值表示下一次查询开始的令牌。
RequestId String 699989E4-64A0-5F78-8B93-CDB32D98971F

请求ID。

TotalCount Integer 1

列表条目数。

MaxResults Integer 20

分批次查询时每次显示的条目数。

TrafficMarkingPolicies Array of TrafficMarkingPolicy

流量标记策略列表。

TrafficMarkingPolicyStatus String Creating

流量标记策略的状态。

  • Creating:创建中。
  • Active:可用。
  • Modifying:修改中。
  • Deleting:删除中。
  • Deleted:已删除。
TrafficMarkingPolicyId String tm-iz5egnyitxiroq****

流量标记策略ID。

MarkingDscp Integer 5

流量标记策略的DSCP值。

TrafficMarkingPolicyName String nametest

流量标记策略的名称。

Priority Integer 5

流量标记策略的优先级。

数字越小,优先级越高。

TrafficMarkingPolicyDescription String desctest

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

TrafficMatchRules Array of TrafficMatchRule

流分类规则列表。

MatchDscp Integer 6

流量报文的DSCP值。

DstCidr String 192.168.120.0/24

流量报文的目标网段。

TrafficMatchRuleDescription String desctest

流分类规则的描述信息。

Protocol String HTTP

流量报文的协议类型。

说明 流量标记策略支持匹配多种协议类型,各个协议类型详情请自行查阅文档。
TrafficMatchRuleId String tm-rule-fa9kgq1e90rmhc****

流分类规则ID。

SrcCidr String 192.168.10.0/24

流量报文的源网段。

TrafficMatchRuleName String nametest

流分类规则的名称。

TrafficMatchRuleStatus String Creating

流分类规则的状态。

  • Creating:创建中。
  • Active:可用。
  • Deleting:删除中。
  • Deleted:已删除。
DstPortRange Array of Integer 80,80

流分类规则待匹配的目的端口范围。

接口会返回两个目的端口号:

  • 如果两个目的端口号相同,例如80和80,则表示流分类规则匹配目的端口号为80的流量。

    如果两个目的端口号均为-1,则表示流分类规则匹配任意目的端口号的流量。

  • 如果两个目的端口号不相同,例如1和200,则表示流分类规则匹配目的端口号在1至200范围内的流量。
SrcPortRange Array of Integer 1,200

流分类规则待匹配的源端口范围。

接口会返回两个源端口号:

  • 如果两个源端口号相同,例如80和80,则表示流分类规则匹配源端口号为80的流量。

    如果两个源端口号均为-1,则表示流分类规则匹配任意源端口号的流量。

  • 如果两个源端口号不相同,例如1和200,则表示流分类规则匹配源端口号在1至200范围内的流量。

示例

请求示例

http(s)://[Endpoint]/?Action=ListTrafficMarkingPolicies
&TransitRouterId=tr-bp1rmwxnk221e3fas****
&TrafficMarkingPolicyId=tm-iz5egnyitxiroq****
&TrafficMarkingPolicyName=nametest
&TrafficMarkingPolicyDescription=desctest
&MaxResults=20
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&公共请求参数

正常返回示例

XML格式

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

<ListTrafficMarkingPoliciesResponse>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <RequestId>699989E4-64A0-5F78-8B93-CDB32D98971F</RequestId>
    <TotalCount>6</TotalCount>
    <MaxResults>20</MaxResults>
    <TrafficMarkingPolicies>
        <TrafficMarkingPolicyStatus>Creating</TrafficMarkingPolicyStatus>
        <TrafficMarkingPolicyId>tm-iz5egnyitxiroq****</TrafficMarkingPolicyId>
        <MarkingDscp>5</MarkingDscp>
        <TrafficMarkingPolicyName>nametest</TrafficMarkingPolicyName>
        <Priority>5</Priority>
        <TrafficMarkingPolicyDescription>desctest</TrafficMarkingPolicyDescription>
        <TrafficMatchRules>
            <MatchDscp>6</MatchDscp>
            <DstCidr>192.168.120.0/24</DstCidr>
            <TrafficMatchRuleDescription>desctest</TrafficMatchRuleDescription>
            <Protocol>HTTP</Protocol>
            <TrafficMatchRuleId>tm-rule-fa9kgq1e90rmhc****</TrafficMatchRuleId>
            <SrcCidr>192.168.10.0/24</SrcCidr>
            <TrafficMatchRuleName>nametest</TrafficMatchRuleName>
            <TrafficMatchRuleStatus>Creating</TrafficMatchRuleStatus>
            <DstPortRange>80</DstPortRange>
            <DstPortRange>80</DstPortRange>
            <SrcPortRange>1</SrcPortRange>
            <SrcPortRange>200</SrcPortRange>
        </TrafficMatchRules>
    </TrafficMarkingPolicies>
</ListTrafficMarkingPoliciesResponse>

JSON格式

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

{
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId" : "699989E4-64A0-5F78-8B93-CDB32D98971F",
  "TotalCount" : 6,
  "MaxResults" : 20,
  "TrafficMarkingPolicies" : [ {
    "TrafficMarkingPolicyStatus" : "Creating",
    "TrafficMarkingPolicyId" : "tm-iz5egnyitxiroq****",
    "MarkingDscp" : 5,
    "TrafficMarkingPolicyName" : "nametest",
    "Priority" : 5,
    "TrafficMarkingPolicyDescription" : "desctest",
    "TrafficMatchRules" : [ {
      "MatchDscp" : 6,
      "DstCidr" : "192.168.120.0/24",
      "TrafficMatchRuleDescription" : "desctest",
      "Protocol" : "HTTP",
      "TrafficMatchRuleId" : "tm-rule-fa9kgq1e90rmhc****",
      "SrcCidr" : "192.168.10.0/24",
      "TrafficMatchRuleName" : "nametest",
      "TrafficMatchRuleStatus" : "Creating",
      "DstPortRange" : [ 80, 80 ],
      "SrcPortRange" : [ 1, 200 ]
    } ]
  } ]
}

错误码

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