使用ListTrafficMarkingPolicies查詢流量標記策略及流分類規則-雲企業網-阿里雲 - Cloud Enterprise Network

呼叫 ListTrafficMarkingPolicies 介面查詢流量標記策略的狀態、流量標記策略的優先順序等詳細資訊。

介面說明

在呼叫 ListTrafficMarkingPolicies 介面過程中：

TransitRouterId 和 TrafficMarkingPolicyId 參數需至少輸入一個。
如果您未輸入流量標記策略 ID（即未指定 TrafficMarkingPolicyId 參數的值），則介面會根據 TransitRouterId、TrafficMarkingPolicyName 和 TrafficMarkingPolicyDescription 參數的值僅返回流量標記策略的資訊，並不會返回流量標記策略下流分類規則的資訊（即回應中不包含 TrafficMatchRules 欄位）。
如果您輸入了流量標記策略 ID（即指定了 TrafficMarkingPolicyId 參數的值），則介面會為您返回該流量標記策略的資訊以及該流量標記策略下流分類規則的資訊（即回應中包含 TrafficMatchRules 欄位）。如果 TrafficMatchRules 欄位為空陣列，則表示當前流量標記策略下並不存在流分類規則。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

cen:ListTrafficMarkingPolicies

list

*All Resource

*

無

請求參數

名稱	類型	必填	描述	樣本值
TransitRouterId	string	否	轉發路由器執行個體 ID。	tr-bp1rmwxnk221e3fas****
TrafficMarkingPolicyId	string	否	流量標記策略 ID。	tm-iz5egnyitxiroq****
TrafficMarkingPolicyName	string	否	流量標記策略的名稱。名稱可以為空或長度為 1～128 個字元，不能以 http:// 或 https:// 開頭。	nametest
TrafficMarkingPolicyDescription	string	否	流量標記策略的描述資訊。描述可以為空或長度為 1～256 個字元，不能以 http:// 或 https:// 開頭。	desctest
MaxResults	integer	否	分批次查詢時每次顯示的項目數。取值範圍：1~100，預設值：20。	20
NextToken	string	否	是否擁有下一次查詢的權杖（Token）。取值：第一次查詢和沒有下一次查詢時，均無需填寫。如果有下一次查詢，取值為上一次 API 呼叫返回的 NextToken 值。	FFmyTO70tTpLG6I3FmYAXGKPd****

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
NextToken	string	是否擁有下一次查詢的權杖（Token）。如果 NextToken 為空表示沒有下一次查詢。如果 NextToken 有返回值，該取值表示下一次查詢開始的權杖。	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	請求 ID。	699989E4-64A0-5F78-8B93-CDB32D98971F
TotalCount	integer	清單項目數。	1
MaxResults	integer	分批次查詢時每次顯示的項目數。	20
TrafficMarkingPolicies	array<object>	流量標記策略清單。
	array<object>	流量標記策略的資訊。
TrafficMarkingPolicyStatus	string	流量標記策略的狀態。 Creating：建立中。 Active：可用。 Modifying：修改中。 Deleting：刪除中。	Creating
TrafficMarkingPolicyId	string	流量標記策略 ID。	tm-iz5egnyitxiroq****
MarkingDscp	integer	流量標記策略的 DSCP 值。	5
TrafficMarkingPolicyName	string	流量標記策略的名稱。	nametest
Priority	integer	流量標記策略的優先順序。數字越小，優先順序越高。	5
TrafficMarkingPolicyDescription	string	流量標記策略的描述資訊。	desctest
TrafficMatchRules	array<object>	流分類規則清單。
	object	流分類規則資訊。
MatchDscp	integer	流量封包的 DSCP 值。說明如果 MatchDscp 返回值為 -1 則表示匹配任意的 DSCP 值。	6
DstCidr	string	流量封包的目的網段，支援 IPv4 和 IPv6 位址。	192.168.120.0/24
TrafficMatchRuleDescription	string	流分類規則的描述資訊。	desctest
Protocol	string	流量封包的通訊協定類型。說明流量標記策略支援匹配多種通訊協定類型，各個通訊協定類型詳情請自行查閱文件。	HTTP
TrafficMatchRuleId	string	流分類規則 ID。	tm-rule-fa9kgq1e90rmhc****
SrcCidr	string	流量封包的來源網段，支援 IPv6 和 IPv4 位址。	192.168.10.0/24
TrafficMatchRuleName	string	流分類規則的名稱。	nametest
TrafficMatchRuleStatus	string	流分類規則的狀態。 Creating：建立中。 Active：可用。 Deleting：刪除中。	Creating
AddressFamily	string	位址類型，有效值為 IPv4 或者 IPv6 或者為空。	IPv4
DstPortRange	array	流分類規則待匹配的目的連接埠範圍。
	integer	流分類規則待匹配的目的連接埠範圍。介面會返回兩個目的連接埠號：如果兩個目的連接埠號相同，例如 80 和 80，則表示流分類規則匹配目的連接埠號為 80 的流量。 `如果兩個目的連接埠號均為 -1，則表示流分類規則匹配任意目的連接埠號的流量。` 如果兩個目的連接埠號不相同，例如 1 和 200，則表示流分類規則匹配目的連接埠號在 1 至 200 範圍內的流量。	80,80
SrcPortRange	array	流分類規則待匹配的來源連接埠範圍。
	integer	流分類規則待匹配的來源連接埠範圍。介面會返回兩個來源連接埠號：如果兩個來源連接埠號相同，例如 80 和 80，則表示流分類規則匹配來源連接埠號為 80 的流量。 `如果兩個來源連接埠號均為 -1，則表示流分類規則匹配任意來源連接埠號的流量。` 如果兩個來源連接埠號不相同，例如 1 和 200，則表示流分類規則匹配來源連接埠號在 1 至 200 範圍內的流量。	1,200
TransitRouterId	string	轉發路由器執行個體 ID。	tr-ccni***

樣本

正常返回樣本

JSON格式

{
  "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***"
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	MissingParam.TransitRouterIdOrTrafficMarkingPolicyId	Either TransitRouterId or TrafficMarkingPolicyId must be specified.	缺少參數 TransitRouterId 或 TrafficMarkingPolicyId。
400	IllegalParam.NextToken	The specified NextToken is invalid.	參數中指定的 NextToken 無效。
400	InvalidName	Name is invalid.	name 不合法。
400	InvalidDescription	Description is invalid.	描述不合法。
400	InvalidParameter	Invalid parameter.	參數不合法。
400	Unauthorized	The AccessKeyId is unauthorized.	帳號無權限操作。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。