ListCenInterRegionTrafficQosPolicies - 查詢流量調度策略的資訊 -

調用ListCenInterRegionTrafficQosPolicies介面查詢流量調度策略的資訊。

介面說明

在調用 ListCenInterRegionTrafficQosPolicies 介面過程中：

TransitRouterId 或 TrafficQosPolicyId 參數至少輸入一個。
如果您未輸入資料流量調度策略 ID（即未指定 TrafficQosPolicyId 參數的值），則介面會根據 TransitRouterId、TransitRouterAttachmentId、TrafficQosPolicyName 和 TrafficQosPolicyDescription 參數的值僅返迴流量調度策略的資訊，並不會查詢流量調度策略下隊列的資訊（即響應中不包含 TrafficQosQueues 欄位）。
如果您輸入了流量調度策略 ID（即指定了 TrafficQosPolicyId 參數的值），則介面會為您返回該流量調度策略的資訊以及該流量調度策略下隊列的資訊（即響應中包含 TrafficQosQueues 欄位）。如果 TrafficQosQueues 欄位為空白數組，則表示當前流量調度策略下僅存在預設隊列
調用介面時請確保輸入的參數值無誤。如果您輸入的參數有誤調用介面後仍然會返回 RequestId，但不會顯示流量調度策略的資訊。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

cen:ListCenInterRegionTrafficQosPolicies

list

*全部資源

*

無

請求參數

名稱	類型	必填	描述	樣本值
TransitRouterId	string	否	轉寄路由器執行個體 ID。	tr-bp1rmwxnk221e3fas****
TransitRouterAttachmentId	string	否	跨地區串連 ID。	tr-attach-r6g0m3epjehw57****
TrafficQosPolicyId	string	否	流量調度策略 ID。	qos-rnghap5gc8155x****
TrafficQosPolicyName	string	否	流量調度策略的名稱。名稱可以為空白或長度為 1～128 個字元，不能以 http://或 https://開頭。	nametest
TrafficQosPolicyDescription	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。	113BFD47-63DF-5D9D-972C-033FB9C360CD
TotalCount	integer	列表條目數。	1
MaxResults	integer	分批次查詢時每次顯示的條目數。	20
TrafficQosPolicies	array<object>	流量調度策略列表。
	object	流量策略的資訊。
TrafficQosPolicyName	string	流量調度策略的名稱。	nametest
TrafficQosPolicyStatus	string	流量調度策略的狀態。 Creating：建立中。 Active：可用。 Modifying：修改中。 Deleting：刪除中。	Creating
TrafficQosPolicyId	string	流量調度策略 ID。	qos-rnghap5gc8155x****
TrafficQosPolicyDescription	string	流量調度策略的描述資訊。	desctest
BandwidthGuaranteeMode	string	頻寬保障類型。 byBandwidth：按頻寬絕對值模式配置 QoS 隊列。 byBandwidthPercent：按頻寬百分比模式配置 QoS 隊列。	byBandwidthPercent
TrafficQosQueues	array<object>	隊列資訊列表。
	object	隊列的資訊。
QosQueueName	string	隊列的名稱。	namtest
RemainBandwidthPercent	integer	頻寬保障類型為按百分比模式時，當前隊列佔用的跨地區頻寬的百分比。	1
Bandwidth	string	頻寬保障類型為按絕對值模式時，當前隊列分配的跨地區頻寬的值。	1
QosQueueId	string	隊列 ID。	qos-queue-njcrmr9fiu1jii****
QosQueueDescription	string	隊列的描述資訊。	desctest
Dscps	array	當前隊列待匹配的流量報文的 DSCP 值。
	integer	當前隊列待匹配的流量報文的 DSCP 值。	5
EffectiveBandwidth	string	當前隊列實際生效的頻寬值。	1.35
TransitRouterId	string	轉寄路由器執行個體 ID。	tr-2ze4ta4v32umj0rb***
TransitRouterAttachmentId	string	網路執行個體串連 ID。	tr-attach-q7ct7c06jpw***

樣本

正常返回樣本

JSON格式

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "113BFD47-63DF-5D9D-972C-033FB9C360CD",
  "TotalCount": 1,
  "MaxResults": 20,
  "TrafficQosPolicies": [
    {
      "TrafficQosPolicyName": "nametest",
      "TrafficQosPolicyStatus": "Creating",
      "TrafficQosPolicyId": "qos-rnghap5gc8155x****",
      "TrafficQosPolicyDescription": "desctest",
      "BandwidthGuaranteeMode": "byBandwidthPercent",
      "TrafficQosQueues": [
        {
          "QosQueueName": "namtest",
          "RemainBandwidthPercent": 1,
          "Bandwidth": "1",
          "QosQueueId": "qos-queue-njcrmr9fiu1jii****",
          "QosQueueDescription": "desctest",
          "Dscps": [
            5
          ],
          "EffectiveBandwidth": "1.35"
        }
      ],
      "TransitRouterId": "tr-2ze4ta4v32umj0rb***",
      "TransitRouterAttachmentId": "tr-attach-q7ct7c06jpw***"
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	MissingParam.TransitRouterIdOrTrafficQosPolicyId	Either TransitRouterId or TrafficQosPolicyId must be specified.
400	InvalidDescription	Description is invalid.	描述不合法。
400	InvalidName	Name is invalid.	name不合法。
400	InvalidParameter	Invalid parameter.	參數不合法。
400	Unauthorized	The AccessKeyId is unauthorized.	帳號無許可權操作。

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

變更歷史

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