調用ListTransitRouterMulticastDomains接口查詢組播域的狀態、組播域ID、組播域的描述等信息。
接口說明
- RegionId 必須和 CenId 組合使用，不能單獨使用，否則將不會顯示組播域的信息。 但 TransitRouterId 和 TransitRouterMulticastDomainId 可以單獨使用。
- 調用接口時請確保輸入的參數值無誤。如果您輸入的參數有誤調用接口后仍然會返回 RequestId，但不會顯示組播域的詳細信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀?。≧ead）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| cen:ListTransitRouterMulticastDomains | list |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| 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 | long | 否 | 分批次查詢時每次顯示的條目數。默認值：20。 | 20 |
| NextToken | string | 否 | 是否擁有下一次查詢的令牌（Token）。取值：
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
| Tag | array<object> | 否 | 標簽信息。 一次最多支持輸入 20 個標簽信息。 | |
| object | 否 | |||
| Key | string | 否 | 資源的標簽鍵。 一旦傳入該值，則不允許為空字符串。最多支持 64 個字符，不能以 一次最多支持輸入 20 個標簽的標簽鍵。 | TagKey |
| Value | string | 否 | 資源的標簽值。 標簽值可以為空或輸入不超過 128 個字符的字符串，不能以 每一個標簽鍵對應一個標簽值，一次最多支持輸入 20 個標簽鍵對應的標簽值。 | TagValue |
返回參數
示例
正常返回示例
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-h19xdb0qy2b3irka8z"
}
]
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | IllegalParam.NextToken | The specified NextToken is illegal. | 參數中指定的NextToken不合法。 |
| 400 | IllegalParam.TrInstance | The specified TrInstance is illegal. | 參數中指定的TrInstance不合法。 |
| 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. | 賬號無權限操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-08-04 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-07-13 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |