ListTransitRouterMulticastDomains查詢組播域API參考-雲企業網-阿里雲 - Cloud Enterprise Network

呼叫 ListTransitRouterMulticastDomains 介面查詢組播域的狀態、組播域 ID、組播域的描述等資訊。

介面說明

RegionId 必須和 CenId 組合使用，不能單獨使用，否則將不會顯示組播域的資訊。但 TransitRouterId 和 TransitRouterMulticastDomainId 可以單獨使用。
呼叫介面時請確保輸入的參數值無誤。如果您輸入的參數有誤，呼叫介面後仍然會返回 RequestId，但不會顯示組播域的詳細資訊。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

cen:ListTransitRouterMulticastDomains

list

*TransitRouterMulticastDomain

acs:cen:*:{#accountId}:centransitroutermulticast/*

*TransitRouterMulticastDomain

acs:cen:*:{#accountId}:centransitroutermulticast/{#centransitroutermulticastId}

無

請求參數

名稱	類型	必填	描述	樣本值
ClientToken	string	否	用戶端 Token，用於保證請求的冪等性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。ClientToken 只支援 ASCII 字元。	123e4567-e89b-12d3-a456-426655440000
CenId	string	否	雲企業網執行個體 ID。	cen-a7syd349kne38g****
TransitRouterId	string	否	轉發路由器執行個體 ID。	tr-p0wr9p28r92d598y6****
TransitRouterMulticastDomainId	string	否	組播域 ID。	tr-mcast-domain-3r3bvbypxqheej****
RegionId	string	否	轉發路由器執行個體所屬地域 ID。您可以透過呼叫 DescribeChildInstanceRegions 介面取得地域 ID。	cn-hangzhou
MaxResults	integer	否	分批次查詢時每次顯示的項目數。預設值：20。	20
NextToken	string	否	是否擁有下一次查詢的權杖（Token）。取值：第一次查詢和沒有下一次查詢時，均無需填寫。如果有下一次查詢，取值為上一次 API 呼叫返回的 NextToken 值。	FFmyTO70tTpLG6I3FmYAXGKPd****
Tag	array<object>	否	標籤資訊。一次最多支援輸入 20 個標籤資訊。
	object	否
Key	string	否	資源的標籤鍵。一旦傳入該值，則不允許為空字串。最多支援 64 個字元，不能以 `aliyun` 或者 `acs:` 開頭，不能包含 `http://` 或者 `https://`。一次最多支援輸入 20 個標籤的標籤鍵。	TagKey
Value	string	否	資源的標籤值。標籤值可以為空或輸入不超過 128 個字元的字串，不能以 `aliyun` 或者 `acs:` 開頭，不能包含 `http://` 或者 `https://`。每一個標籤鍵對應一個標籤值，一次最多支援輸入 20 個標籤鍵對應的標籤值。	TagValue

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求 ID。	8A0F93D1-FD6C-56FC-B6D2-668FC92D12D2
TotalCount	integer	清單項目數。	1
MaxResults	integer	分批次查詢時每次顯示的項目數。	20
NextToken	string	是否擁有下一次查詢的權杖（Token）。取值：如果 NextToken 為空表示沒有下一次查詢。如果 NextToken 有返回值，該取值表示下一次查詢開始的權杖。	FFmyTO70tTpLG6I3FmYAXGKPd****
TransitRouterMulticastDomains	array<object>	組播域資訊清單。
	array<object>	組播域的資訊。
TransitRouterMulticastDomainId	string	組播域 ID。	tr-mcast-domain-3r3bvbypxqheej****
TransitRouterMulticastDomainName	string	組播域的名稱。	nametest
TransitRouterMulticastDomainDescription	string	組播域的描述資訊。	desctest
Status	string	組播域的狀態。取值： `Active`，表示組播域當前可用。 `Modifying`，表示組播域在修改中。	Active
Tags	array<object>	標籤清單。
	object
Key	string	標籤鍵。	TagKey
Value	string	標籤值。	TagValue
TransitRouterId	string	轉發路由器執行個體 ID。	tr-bp1c23ijrl6d6c226h***
RegionId	string	轉發路由器執行個體所屬的地域 ID。您可以透過呼叫 DescribeChildInstanceRegions 介面取得地域 ID。	cn-hangzhou
CenId	string	雲企業網執行個體 ID。	cen-h19xdb0qy2b3ir****
Options	object	組播域功能選項。
Igmpv2Support	string	是否為組播域開啟了 IGMP 功能。	enable
StrictSourceControl	string		enable

樣本

正常返回樣本

JSON格式

{
  "RequestId": "8A0F93D1-FD6C-56FC-B6D2-668FC92D12D2",
  "TotalCount": 1,
  "MaxResults": 20,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TransitRouterMulticastDomains": [
    {
      "TransitRouterMulticastDomainId": "tr-mcast-domain-3r3bvbypxqheej****",
      "TransitRouterMulticastDomainName": "nametest",
      "TransitRouterMulticastDomainDescription": "desctest",
      "Status": "Active",
      "Tags": [
        {
          "Key": "TagKey",
          "Value": "TagValue"
        }
      ],
      "TransitRouterId": "tr-bp1c23ijrl6d6c226h***",
      "RegionId": "cn-hangzhou",
      "CenId": "cen-h19xdb0qy2b3ir****",
      "Options": {
        "Igmpv2Support": "enable",
        "StrictSourceControl": "enable"
      }
    }
  ]
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
400	IllegalParam.NextToken	The specified NextToken is illegal.	參數中指定的 NextToken 無效。
400	IllegalParam.TrInstance	The specified TrInstance is illegal.	參數 TransitRouterId 或 RegionId 無效。
400	IllegalParam.CenId	The specified CenId is illegal.	指定的 cenId 不合法。
400	IllegalParam.MaxResults	The specified MaxResults is illegal.	MaxResults 無效。
400	InvalidParameter	Invalid parameter.	參數不合法。
400	Unauthorized	The AccessKeyId is unauthorized.	帳號無權限操作。

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

變更歷史

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