ListTrafficMarkingPolicies -

Usage notes

Take note of the following rules when you call the ListTrafficMarkingPolicies operation:

If you do not specify a traffic marking policy ID in the TrafficMarkingPolicyId parameter, the system returns the information about the traffic marking policy based on the TransitRouterId, TrafficMarkingPolicyName, and TrafficMarkingPolicyDescription parameters. The information about the traffic classification rules in the policy is not returned. The TrafficMatchRules parameter is not included in the response.
If you specify a traffic marking policy ID in the TrafficMarkingPolicyId parameter, this operation returns the information about the traffic marking policy and the traffic classification rules. The TrafficMatchRules parameter is included in the response.

If the TrafficMatchRules parameter contains an empty array, it indicates that the traffic marking policy does not contain a traffic classification rule.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters


Parameter	Type	Required	Example	Description
Action	String	Yes	ListTrafficMarkingPolicies	The operation that you want to perform. Set the value to ListTrafficMarkingPolicies.
TransitRouterId	String	Yes	tr-bp1rmwxnk221e3fas****	The ID of the transit router.
TrafficMarkingPolicyId	String	No	tm-iz5egnyitxiroq****	The ID of the traffic marking policy.
TrafficMarkingPolicyName	String	No	nametest	The name of the traffic marking policy. The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.
TrafficMarkingPolicyDescription	String	No	desctest	The description of the traffic marking policy. The description must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The description must start with a letter.
MaxResults	Integer	No	20	The number of entries to return on each page. Valid values: 1 to 100. Default value: 20.
NextToken	String	No	FFmyTO70tTpLG6I3FmYAXGKPd****	The token that determines the start point of the query. Valid values: If this is your first query or no subsequent query is to be sent, ignore this parameter. If a subsequent query is to be sent, set the value to the value of NextToken that was returned from the last call.

Response parameters


Parameter	Type	Example	Description
NextToken	String	FFmyTO70tTpLG6I3FmYAXGKPd****	The token that determines the start point of the query. If NextToken was not returned in the previous query, it indicates that no additional results exist. If NextToken was returned in the previous query, specify the value to obtain the next set of results.
RequestId	String	699989E4-64A0-5F78-8B93-CDB32D98971F	The ID of the request.
TotalCount	Integer	1	The number of entries returned.
MaxResults	Integer	20	The number of entries returned per page.
TrafficMarkingPolicies	Array of TrafficMarkingPolicy		The information about the traffic marking policy.
TrafficMarkingPolicyStatus	String	Creating	The status of the traffic marking policy. Valid values: Creating: The policy is being created. Active: The policy is available. Modifying: The policy is being modified. Deleting: The policy is being deleted. Deleted: The policy is deleted.
TrafficMarkingPolicyId	String	tm-iz5egnyitxiroq****	The ID of the traffic marking policy.
MarkingDscp	Integer	5	The differentiated services code point (DSCP) value of the traffic marking policy.
TrafficMarkingPolicyName	String	nametest	The name of the traffic marking policy.
Priority	Integer	5	The priority of the traffic marking policy. A smaller value indicates a higher priority.
TrafficMarkingPolicyDescription	String	desctest	The description of the traffic marking policy.
TrafficMatchRules	Array of TrafficMatchRule		The information about the traffic classification rule.
MatchDscp	Integer	6	The DSCP value used to match data packets.
DstCidr	String	192.168.120.0/24	The destination CIDR block used to match data packets.
TrafficMatchRuleDescription	String	desctest	The description of the traffic classification rule.
Protocol	String	HTTP	The protocol used to match data packets. Note Traffic marking policies support multiple protocols. For more information, see the documentation of CEN.
TrafficMatchRuleId	String	tm-rule-fa9kgq1e90rmhc****	The ID of the traffic classification rule.
SrcCidr	String	192.168.10.0/24	The source CIDR block used to match data packets.
TrafficMatchRuleName	String	nametest	The name of the traffic classification rule.
TrafficMatchRuleStatus	String	Creating	The status of the traffic classification rule. Valid values: Creating: The rule is being created. Active: The rule is available. Deleting: The rule is being deleted. Deleted: The rule is deleted.
DstPortRange	Array of Integer	80,80	The destination port range used to match data packets. Two destination port numbers are returned. If the destination ports are the same, for example, port 80, the traffic classification rule matches data packets that are sent to port 80. If the destination ports are both -1, the traffic classification rule matches all data packets. If the destination ports are different, for example, port 1 and port 200, the traffic classification rule matches data packets whose destination port ranges from port 1 to port 200.
SrcPortRange	Array of Integer	1,200	The source port range used to match data packets. Two source port numbers are returned. If the source ports are the same, for example, port 80, the traffic classification rule matches data packets that are sent from port 80. If the source ports are both -1, the traffic classification rule matches all data packets. If the source ports are different, for example, port 1 and port 200, the traffic classification rule matches data packets whose source port ranges from port 1 to port 200.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListTrafficMarkingPolicies
&TransitRouterId=tr-bp1rmwxnk221e3fas****
&TrafficMarkingPolicyId=tm-iz5egnyitxiroq****
&TrafficMarkingPolicyName=nametest
&TrafficMarkingPolicyDescription=desctest
&MaxResults=20
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&<Common request parameters>

Sample success responses

XML format

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 format

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 ]
    } ]
  } ]
}

Error codes

For a list of error codes, visit the Error Center.