调用ListTransitRouterMulticastGroups接口查询组播域下组播成员和组播源的信息。

使用说明

您可以调用ListTransitRouterMulticastGroups接口查询组播域下组播成员和组播源(以下简称为组播资源)的信息。

  • 如果您指定GroupIpAddress参数的值,则您可以查询组播域下指定组播组下的组播资源的信息。
  • 如果您指定VSwitchIds参数的值,则您可以查询组播域下指定交换机下的组播资源的信息。
  • 如果您指定PeerTransitRouterMulticastDomains参数的值,则您可以查询组播域下跨地域组播资源的信息。
  • 如果您指定ResourceType参数的值,则您可以查询组播域下属于某一资源类型的组播资源的信息。
  • 如果您指定ResourceId参数的值,则您可以查询某一资源下组播资源的信息。
  • 如果您仅指定TransitRouterMulticastDomainId参数的值,则您可以查询组播域下所有组播资源的信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListTransitRouterMulticastGroups

系统规定参数。取值:ListTransitRouterMulticastGroups

ClientToken String 123e4567-e89b-12d3-a456-426655440000

客户端Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken只支持ASCII字符。

TransitRouterMulticastDomainId String tr-mcast-domain-5mjb5gjb6dgu98****

组播域ID。

GroupIpAddress String 239.XX.XX.2

组播组的IP地址。

每个组播组通过一个组播IP地址进行标识。

TransitRouterAttachmentId String tr-attach-g3kz2k3u76amsk****

网络实例连接ID。

ResourceType String VPC

组播资源的类型。

  • VPC:表示查询专有网络VPC(Virtual Private Cloud)下的组播资源信息。
  • TR:表示查询跨地域的组播资源的信息。
ResourceId String vpc-p0w9alkte4w2htrqe****

组播资源关联的资源ID。

MaxResults Long 20

分批次查询时每次显示的条目数。默认值:20

NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次API调用返回的NextToken值。
VSwitchIds.N String vsw-p0w9s2ig1jnwgrbzl****

交换机ID。

最多支持输入20个交换机ID。

PeerTransitRouterMulticastDomains.N String tr-mcast-domain-91wpg6wbhchjeq****

跨地域组播域ID。

最多支持输入20个跨地域组播域ID。

返回数据

名称 类型 示例值 描述
RequestId String FB3C4A16-0933-5850-9D43-0C3EA37BCBFB

请求ID。

TotalCount Integer 1

列表条目数。

MaxResults Integer 20

分批次查询时每次显示的条目数。

NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌(Token)。取值:

  • 如果NextToken为空表示没有下一次查询。
  • 如果NextToken有返回值,该取值表示下一次查询开始的令牌。
TransitRouterMulticastGroups Array of TransitRouterMulticastGroup

组播组信息列表。

GroupIpAddress String 239.XX.XX.2

组播资源所属的组播组的IP地址。

TransitRouterAttachmentId String tr-attach-g3kz2k3u76amsk****

网络实例连接ID。

VSwitchId String vsw-p0w9s2ig1jnwgrbzl****

组播资源所属交换机的ID。

NetworkInterfaceId String eni-p0weuda3lszwzjly****

弹性网卡ID(即组播资源ID)。

PeerTransitRouterMulticastDomainId String tr-mcast-domain-91wpg6wbhchjeq****

跨地域的组播资源关联的组播域的ID。

Status String Registered

组播资源的状态。

  • Registering:创建中。
  • Registered:可用。
  • Deregistering:删除中。
GroupSource Boolean false

当前组播资源是否是组播源。

  • true:是组播源。
  • false:不是组播源。
GroupMember Boolean true

当前组播资源是否是组播成员。

  • true:是组播成员。
  • false:不是组播成员。
MemberType String Static

组播源的类型。

仅返回:Static,表示当前组播源是通过手动方式指定的。

SourceType String Static

组播成员的类型。

仅返回:Static,表示当前组播成员是通过手动方式指定的。

ResourceType String VPC

组播资源的类型。

  • VPC:表示当前组播资源为VPC下的资源。
  • TR:表示当前组播资源为跨地域的资源。
ResourceOwnerId Long 253460731706911258

组播资源所属的阿里云账号(主账号)ID。

ResourceId String vpc-p0w9alkte4w2htrqe****

组播资源关联的资源ID。

示例

请求示例

http(s)://[Endpoint]/?Action=ListTransitRouterMulticastGroups
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&TransitRouterMulticastDomainId=tr-mcast-domain-5mjb5gjb6dgu98****
&GroupIpAddress=239.XX.XX.2
&TransitRouterAttachmentId=tr-attach-g3kz2k3u76amsk****
&VSwitchIds=["vsw-p0w9s2ig1jnwgrbzl****"]
&PeerTransitRouterMulticastDomains=["tr-mcast-domain-91wpg6wbhchjeq****"]
&ResourceType=VPC
&ResourceId=vpc-p0w9alkte4w2htrqe****
&MaxResults=20
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListTransitRouterMulticastGroupsResponse>
    <RequestId>FB3C4A16-0933-5850-9D43-0C3EA37BCBFB</RequestId>
    <TotalCount>1</TotalCount>
    <MaxResults>20</MaxResults>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <TransitRouterMulticastGroups>
        <GroupIpAddress>239.XX.XX.2</GroupIpAddress>
        <TransitRouterAttachmentId>tr-attach-g3kz2k3u76amsk****</TransitRouterAttachmentId>
        <VSwitchId>vsw-p0w9s2ig1jnwgrbzl****</VSwitchId>
        <NetworkInterfaceId>eni-p0weuda3lszwzjly****</NetworkInterfaceId>
        <PeerTransitRouterMulticastDomainId>tr-mcast-domain-91wpg6wbhchjeq****</PeerTransitRouterMulticastDomainId>
        <Status>Registered</Status>
        <GroupSource>false</GroupSource>
        <GroupMember>true</GroupMember>
        <MemberType>Static</MemberType>
        <SourceType>Static</SourceType>
        <ResourceType>VPC</ResourceType>
        <ResourceOwnerId>253460731706911260</ResourceOwnerId>
        <ResourceId>vpc-p0w9alkte4w2htrqe****</ResourceId>
    </TransitRouterMulticastGroups>
</ListTransitRouterMulticastGroupsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/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****"
  } ]
}

错误码

访问错误中心查看更多错误码。