文档

ListTransitRouterMulticastGroups - 查询组播域下组播成员和组播源的信息

更新时间:

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

接口说明

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

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cen:ListTransitRouterMulticastGroupsRead
  • TransitRouterMulticastDomain
    acs:cen:*:{#accountId}:centransitroutermulticast/{#centransitroutermulticastId}

请求参数

名称类型必填描述示例值
ClientTokenstring

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

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

123e4567-e89b-12d3-a456-426655440000
TransitRouterMulticastDomainIdstring

组播域 ID。

TransitRouterMulticastDomainId 或 TransitRouterAttachmentId 参数必须输入其中一个。

tr-mcast-domain-5mjb5gjb6dgu98****
GroupIpAddressstring

组播组的 IP 地址。

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

239.XX.XX.2
TransitRouterAttachmentIdstring

网络实例连接 ID。

TransitRouterMulticastDomainId 或 TransitRouterAttachmentId 参数必须输入其中一个。

tr-attach-g3kz2k3u76amsk****
VSwitchIdsarray

交换机 ID 列表。

string

交换机 ID。

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

vsw-p0w9s2ig1jnwgrbzl****
PeerTransitRouterMulticastDomainsarray

跨地域组播域 ID 列表。

string

跨地域组播域 ID。

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

tr-mcast-domain-91wpg6wbhchjeq****
ResourceTypestring

组播资源的类型。

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

组播资源关联的资源 ID。

vpc-p0w9alkte4w2htrqe****
MaxResultslong

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

20
NextTokenstring

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

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。
FFmyTO70tTpLG6I3FmYAXGKPd****
IsGroupSourceboolean

是否查询组播源。

  • false:否。
  • true:是。
说明 和 IsGroupMember 配合使用。
  • 若两者均不配置,则默认查询组播源和成员。
  • 若只配置其一或两者均配置,则以配置参数为准。
  • true
    IsGroupMemberboolean

    是否查询组播成员。

    • false:否。
    • true:是。
    说明 和 IsGroupMember 配合使用。
  • 若两者均不配置,则默认查询组播源和成员。
  • 若只配置其一或两者均配置,则以配置参数为准。
  • false
    NetworkInterfaceIdsarray

    弹性网卡 ID 列表。

    string

    弹性网卡 ID。

    最多支持输入 20 个弹性网卡 ID。

    eni-p0weuda3lszwzjly****

    返回参数

    名称类型描述示例值
    object

    返回结果。

    RequestIdstring

    请求 ID。

    FB3C4A16-0933-5850-9D43-0C3EA37BCBFB
    TotalCountinteger

    列表条目数。

    1
    MaxResultsinteger

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

    20
    NextTokenstring

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

    • 如果 NextToken 为空表示没有下一次查询。
    • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
    FFmyTO70tTpLG6I3FmYAXGKPd****
    TransitRouterMulticastGroupsobject []

    组播组信息列表。

    GroupIpAddressstring

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

    239.XX.XX.2
    TransitRouterAttachmentIdstring

    网络实例连接 ID。

    tr-attach-g3kz2k3u76amsk****
    VSwitchIdstring

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

    vsw-p0w9s2ig1jnwgrbzl****
    NetworkInterfaceIdstring

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

    eni-p0weuda3lszwzjly****
    PeerTransitRouterMulticastDomainIdstring

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

    tr-mcast-domain-91wpg6wbhchjeq****
    Statusstring

    组播资源的状态。

    • Registering:创建中。
    • Registered:可用。
    • Deregistering:删除中。
    Registered
    GroupSourceboolean

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

    • true:是组播源。
    • false:不是组播源。
    false
    GroupMemberboolean

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

    • true:是组播成员。
    • false:不是组播成员。
    true
    MemberTypestring

    组播源的类型。

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

    Static
    SourceTypestring

    组播成员的类型。

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

    Static
    ResourceTypestring

    组播资源的类型。

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

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

    253460731706911258
    ResourceIdstring

    组播资源关联的资源 ID。

    vpc-p0w9alkte4w2htrqe****
    TransitRouterMulticastDomainIdstring

    组播域 ID。

    tr-mcast-domain-kx0vk0v7fz8kx4****

    示例

    正常返回示例

    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错误码错误信息描述
    400IllegalParam.NextTokenThe specified NextToken is illegal.参数中指定的NextToken不合法。
    400IllegalParam.TransitRouterMulticastDomainIdThe specified TransitRouterMulticastDomainId is illegal.参数中指定的TransitRouterMulticastDomainId不合法。
    400IllegalParam.MaxResultsThe specified MaxResults is illegal.MaxResults非法。
    400InvalidParameterInvalid parameter.参数不合法。
    400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

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

    变更历史

    变更时间变更内容概要操作
    2023-08-04OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      错误码 400 变更
    2022-12-02OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    • 本页导读 (1)
    文档反馈