调用ListTransitRouterMulticastGroups接口查询组播域下组播成员和组播源的详细信息。
接口说明
您可以调用ListTransitRouterMulticastGroups接口查询组播域下组播成员和组播源（以下简称为组播资源）的信息。
- 如果您指定 GroupIpAddress 参数的值，则您可以查询组播域下指定组播组下的组播资源的信息。
- 如果您指定 VSwitchIds 参数的值，则您可以查询组播域下指定交换机下的组播资源的信息。
- 如果您指定 PeerTransitRouterMulticastDomains 参数的值，则您可以查询组播域下跨地域组播资源的信息。
- 如果您指定 ResourceType 参数的值，则您可以查询组播域下属于某一资源类型的组播资源的信息。
- 如果您指定 ResourceId 参数的值，则您可以查询某一资源下组播资源的信息。
- 如果您仅指定 TransitRouterMulticastDomainId 参数的值，则您可以查询组播域下所有组播资源的信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| 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 | 否 | 组播资源关联的资源 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 错误码发生变更 | 查看变更详情 |
| 2022-12-02 | OpenAPI 错误码发生变更 | 查看变更详情 |