All Products
Search
Document Center

Cloud Enterprise Network:ListTrafficMarkingPolicies

Last Updated:Mar 01, 2024

Queries information about traffic marking policies.

Operation description

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 policies based on the TransitRouterId, TrafficMarkingPolicyName, and TrafficMarkingPolicyDescription parameters. The information about the traffic classification rules in the policies 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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
cen:ListTrafficMarkingPoliciesList
  • CenInstance
    acs:cen:*:{#accountId}:ceninstance/*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TransitRouterIdstringNo

The ID of the transit router.

tr-bp1rmwxnk221e3fas****
TrafficMarkingPolicyIdstringNo

The ID of the traffic marking policy.

tm-iz5egnyitxiroq****
TrafficMarkingPolicyNamestringNo

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.

nametest
TrafficMarkingPolicyDescriptionstringNo

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.

desctest
MaxResultsintegerNo

The number of entries to return on each page. Valid values: 1 to 100. Default value: 20.

20
NextTokenstringNo

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

ParameterTypeDescriptionExample
object

The response.

NextTokenstring

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****
RequestIdstring

The ID of the request.

699989E4-64A0-5F78-8B93-CDB32D98971F
TotalCountinteger

The number of entries returned.

1
MaxResultsinteger

The number of entries returned on each page.

20
TrafficMarkingPoliciesobject []

The list of traffic marking policies.

TrafficMarkingPolicyStatusstring

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.
Creating
TrafficMarkingPolicyIdstring

The ID of the traffic marking policy.

tm-iz5egnyitxiroq****
MarkingDscpinteger

The differentiated services code point (DSCP) value of the traffic marking policy.

5
TrafficMarkingPolicyNamestring

The name of the traffic marking policy.

nametest
Priorityinteger

The priority of the traffic marking policy.

A smaller value indicates a higher priority.

5
TrafficMarkingPolicyDescriptionstring

The description of the traffic marking policy.

desctest
TrafficMatchRulesobject []

The list of traffic classification rules.

MatchDscpinteger

The DSCP value used to match data packets.

6
DstCidrstring

The destination CIDR block used to match data packets.

192.168.120.0/24
TrafficMatchRuleDescriptionstring

The description of the traffic classification rule.

desctest
Protocolstring

The protocol used to match data packets.

Note Traffic marking policies support multiple protocols. For more information, see the documentation of CEN.
HTTP
TrafficMatchRuleIdstring

The ID of the traffic classification rule.

tm-rule-fa9kgq1e90rmhc****
SrcCidrstring

The source CIDR block used to match data packets.

192.168.10.0/24
TrafficMatchRuleNamestring

The name of the traffic classification rule.

nametest
TrafficMatchRuleStatusstring

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.
Creating
DstPortRangearray

The destination port range used to match data packets.

integer

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.

80,80
SrcPortRangearray

The source port range used to match data packets.

integer

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.

1,200
TransitRouterIdstring

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",
          "DstPortRange": [
            0
          ],
          "SrcPortRange": [
            0
          ]
        }
      ],
      "TransitRouterId": "tr-ccni***"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400MissingParam.TransitRouterIdOrTrafficMarkingPolicyIdEither TransitRouterId or TrafficMarkingPolicyId must be specified.The error message returned because the TransitRouterId or TrafficMarkingPolicyId parameter is not set.
400IllegalParam.NextTokenThe specified NextToken is invalid.The error message returned because the NextToken parameter is set to an invalid value.
400InvalidNameName is invalid.The error message returned because the specified name is invalid.
400InvalidDescriptionDescription is invalid.The error message returned because the description is invalid.
400InvalidParameterInvalid parameter.The error message returned because the parameter is set to an invalid value.
400UnauthorizedThe 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 timeSummary of changesOperation
2023-12-13The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
2023-09-08The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
2023-03-09The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
2021-11-26Add Operationsee changesets