ListTrafficMarkingPolicies - Cloud Enterprise Network - Alibaba Cloud Documentation Center

Queries the details about a traffic marking policy, such as the status and priority.

Operation description

Before you call the ListTrafficMarkingPolicies operation, take note of the following limits:

Specify at least one of the TransitRouterId and TrafficMarkingPolicyId parameters.
If you do not specify a traffic marking policy ID (TrafficMarkingPolicyId), the operation queries only the information about the traffic marking policy based on the TransitRouterId, TrafficMarkingPolicyName, and TrafficMarkingPolicyDescription parameters. The TrafficMatchRules parameter that contains the information about the traffic classification rules is not returned.
If you specify a traffic marking policy ID (TrafficMarkingPolicyId), the operation queries the information about the traffic marking policy and traffic classification rules. The TrafficMatchRules parameter is returned in the response. If the value of the TrafficMatchRules parameter is an empty array, the traffic marking policy does not contain a traffic classification rule.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cen:ListTrafficMarkingPolicies	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
TransitRouterId	string	No	The ID of the transit router.	tr-bp1rmwxnk221e3fas****
TrafficMarkingPolicyId	string	No	The ID of the traffic marking policy.	tm-iz5egnyitxiroq****
TrafficMarkingPolicyName	string	No	The name of the traffic marking policy. The name must be 1 to 128 characters in length, and cannot start with http:// or https://.	nametest
TrafficMarkingPolicyDescription	string	No	The description of the traffic marking policy. This parameter is optional. If you enter a description, it must be 1 to 256 characters in length and cannot start with http:// or https://.	desctest
MaxResults	integer	No	The number of entries to return on each page. Valid values: 1 to 100. Default value: 20.	20
NextToken	string	No	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 next query is to be sent, set the value to the value of NextToken that is returned from the last call.	FFmyTO70tTpLG6I3FmYAXGKPd****

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
NextToken	string	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.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	The ID of the request.	699989E4-64A0-5F78-8B93-CDB32D98971F
TotalCount	integer	The number of entries returned.	1
MaxResults	integer	The number of entries returned on each page.	20
TrafficMarkingPolicies	array<object>	The information about the traffic marking policy.
TrafficMarkingPolicy	object	The information about the traffic marking policy.
TrafficMarkingPolicyStatus	string	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.	Creating
TrafficMarkingPolicyId	string	The ID of the traffic marking policy.	tm-iz5egnyitxiroq****
MarkingDscp	integer	The Differentiated Service Code Point (DSCP) value of the traffic marking policy.	5
TrafficMarkingPolicyName	string	The name of the traffic marking policy.	nametest
Priority	integer	The priority of the traffic marking policy. A lower value indicates a higher priority.	5
TrafficMarkingPolicyDescription	string	The description of the traffic marking policy.	desctest
TrafficMatchRules	array<object>	The traffic classification rules.
TrafficMatchRule	object	The information about the traffic classification rule.
MatchDscp	integer	The DSCP value used to match data packets. Note If the value of the MatchDscp parameter is -1, data packets are considered a match regardless of the DSCP value.	6
DstCidr	string	The destination CIDR block of packets. IPv4 and IPv6 addresses are supported.	192.168.120.0/24
TrafficMatchRuleDescription	string	The description of the traffic classification rule.	desctest
Protocol	string	The protocol that is used to match packets. Note Traffic marking policies support multiple protocols. For more information, see the documentation of CEN.	HTTP
TrafficMatchRuleId	string	The ID of the traffic classification rule.	tm-rule-fa9kgq1e90rmhc****
SrcCidr	string	The source CIDR block of packets. IPv6 and IPv4 addresses are supported.	192.168.10.0/24
TrafficMatchRuleName	string	The name of the traffic classification rule.	nametest
TrafficMatchRuleStatus	string	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.	Creating
AddressFamily	string	The address family. You can set the value to IPv4 or IPv6, or leave the value empty.	IPv4
DstPortRange	array	The destination port range used to match data packets.
DstPortRange	integer	The destination port range used to match data packets. Two destination port numbers are returned. If the returned destination ports are the same, such as 80 and 80, the traffic classification rule matches packets whose destination port is port 80. `If the returned destination ports are both -1, packets are considered a match regardless of the destination port.` If the returned destination ports are different, such as 1 and 200, the traffic classification rule matches packets whose destination ports are from 1 to 200.	80,80
SrcPortRange	array	The source port range used to match data packets.
SrcPortRange	integer	The source port range used to match data packets. Two source port numbers are returned. If the returned source ports are the same, such as 80 and 80, the traffic classification rule matches packets whose source port is 80. `If the returned source ports are both -1, packets are considered a match regardless of the source port.` If the returned source ports are different, such as 1 and 200, the traffic classification rule matches packets whose source ports are from 1 to 200.	1,200
TransitRouterId	string	The ID of the transit router.	tr-ccni***

Examples

Sample success responses

JSONformat

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "699989E4-64A0-5F78-8B93-CDB32D98971F",
  "TotalCount": 1,
  "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",
          "AddressFamily": "IPv4",
          "DstPortRange": [
            0
          ],
          "SrcPortRange": [
            0
          ]
        }
      ],
      "TransitRouterId": "tr-ccni***"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	MissingParam.TransitRouterIdOrTrafficMarkingPolicyId	Either TransitRouterId or TrafficMarkingPolicyId must be specified.	The error message returned because the TransitRouterId or TrafficMarkingPolicyId parameter is not set.
400	IllegalParam.NextToken	The specified NextToken is invalid.	The error message returned because the NextToken parameter is set to an invalid value.
400	InvalidName	Name is invalid.	The error message returned because the specified name is invalid.
400	InvalidDescription	Description is invalid.	The error message returned because the description is invalid.
400	InvalidParameter	Invalid parameter.	The error message returned because the parameter is set to an invalid value.
400	Unauthorized	The AccessKeyId is unauthorized.	The error message returned because you do not have the permissions to perform this operation.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2024-09-10	The Error code has changed. The response structure of the API has changed	View Change Details
2023-12-13	The Error code has changed	View Change Details
2023-09-08	The Error code has changed	View Change Details
2023-03-09	The Error code has changed	View Change Details
2021-11-26	Add Operation	View Change Details