調用ListTransitRouterMulticastGroups接口查詢組播域下組播成員和組播源的詳細信息。
接口說明
您可以調用ListTransitRouterMulticastGroups接口查詢組播域下組播成員和組播源（以下簡稱為組播資源）的信息。
- 如果您指定 GroupIpAddress 參數的值，則您可以查詢組播域下指定組播組下的組播資源的信息。
- 如果您指定 VSwitchIds 參數的值，則您可以查詢組播域下指定交換機下的組播資源的信息。
- 如果您指定 PeerTransitRouterMulticastDomains 參數的值，則您可以查詢組播域下跨地域組播資源的信息。
- 如果您指定 ResourceType 參數的值，則您可以查詢組播域下屬于某一資源類型的組播資源的信息。
- 如果您指定 ResourceId 參數的值，則您可以查詢某一資源下組播資源的信息。
- 如果您僅指定 TransitRouterMulticastDomainId 參數的值，則您可以查詢組播域下所有組播資源的信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯(lián)操作：是指成功執(zhí)行操作所需要的其他權限。操作者必須同時具備關聯(lián)操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯(lián)操作 |
|---|---|---|---|---|
| cen:ListTransitRouterMulticastGroups | get |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ClientToken | string | 否 | 客戶端 Token，用于保證請求的冪等性。 從您的客戶端生成一個參數值，確保不同請求間該參數值唯一。ClientToken 只支持 ASCII 字符。 | 123e4567-e89b-12d3-a456-426655440000 |
| TransitRouterMulticastDomainId | string | 否 | 組播域 ID。 TransitRouterMulticastDomainId 或 TransitRouterAttachmentId 參數必須輸入其中一個。 | tr-mcast-domain-5mjb5gjb6dgu98**** |
| GroupIpAddress | string | 否 | 組播組的 IP 地址。 每個組播組通過一個組播 IP 地址進行標識。 | 239.XX.XX.2 |
| TransitRouterAttachmentId | string | 否 | 網絡實例連接 ID。 TransitRouterMulticastDomainId 或 TransitRouterAttachmentId 參數必須輸入其中一個。 | tr-attach-g3kz2k3u76amsk**** |
| VSwitchIds | array | 否 | 交換機 ID 列表。 | |
| string | 否 | 交換機 ID。 最多支持輸入 20 個交換機 ID。 | vsw-p0w9s2ig1jnwgrbzl**** | |
| PeerTransitRouterMulticastDomains | array | 否 | 跨地域組播域 ID 列表。 | |
| string | 否 | 跨地域組播域 ID。 最多支持輸入 20 個跨地域組播域 ID。 | tr-mcast-domain-91wpg6wbhchjeq**** | |
| ResourceType | string | 否 | 組播資源的類型。
| VPC |
| ResourceId | string | 否 | 組播資源關聯(lián)的資源 ID。 | vpc-p0w9alkte4w2htrqe**** |
| MaxResults | long | 否 | 分批次查詢時每次顯示的條目數。默認值：20。 | 20 |
| NextToken | string | 否 | 是否擁有下一次查詢的令牌（Token）。取值：
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
| IsGroupSource | boolean | 否 | 是否查詢組播源。
說明
和 IsGroupMember 配合使用。
| true |
| IsGroupMember | boolean | 否 | 是否查詢組播成員。
說明
和 IsGroupMember 配合使用。
| false |
| NetworkInterfaceIds | array | 否 | 彈性網卡 ID 列表。 | |
| string | 否 | 彈性網卡 ID。 最多支持輸入 20 個彈性網卡 ID。 | eni-p0weuda3lszwzjly**** |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "FB3C4A16-0933-5850-9D43-0C3EA37BCBFB",
"TotalCount": 1,
"MaxResults": 20,
"NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
"TransitRouterMulticastGroups": [
{
"GroupIpAddress": "239.XX.XX.2",
"TransitRouterAttachmentId": "tr-attach-g3kz2k3u76amsk****",
"VSwitchId": "vsw-p0w9s2ig1jnwgrbzl****",
"NetworkInterfaceId": "eni-p0weuda3lszwzjly****",
"PeerTransitRouterMulticastDomainId": "tr-mcast-domain-91wpg6wbhchjeq****",
"Status": "Registered",
"GroupSource": false,
"GroupMember": true,
"MemberType": "Static",
"SourceType": "Static",
"ResourceType": "VPC",
"ResourceOwnerId": 253460731706911260,
"ResourceId": "vpc-p0w9alkte4w2htrqe****",
"TransitRouterMulticastDomainId": "tr-mcast-domain-kx0vk0v7fz8kx4****"
}
]
}錯誤碼
| HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
|---|---|---|---|
| 400 | IllegalParam.NextToken | The specified NextToken is illegal. | 參數中指定的NextToken不合法。 |
| 400 | IllegalParam.TransitRouterMulticastDomainId | The specified TransitRouterMulticastDomainId is illegal. | 參數中指定的TransitRouterMulticastDomainId不合法。 |
| 400 | IllegalParam.MaxResults | The specified MaxResults is illegal. | MaxResults非法。 |
| 400 | InvalidParameter | Invalid parameter. | 參數不合法。 |
| 400 | Unauthorized | The AccessKeyId is unauthorized. | 賬號無權限操作。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-08-04 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |
| 2022-12-02 | OpenAPI 錯誤碼發(fā)生變更 | 查看變更詳情 |