ListTransitRouterMulticastDomainAssociations - 查询组播域的关联信息

您可以调用ListTransitRouterMulticastDomainAssociations接口查询组播域和交换机的关联关系。

接口说明

  • 调用接口时请求参数 TransitRouterMulticastDomainIdTransitRouterAttachmentId 必须输入一个。输入 TransitRouterAttachmentId 表示查询 VPC 实例下已绑定组播域的交换机的信息。输入 TransitRouterMulticastDomainId 表示查询组播域下已绑定的交换机的信息。

  • 在调用 ListTransitRouterMulticastDomainAssociations 接口过程时请确保输入的参数值无误。如果您输入的参数有误调用接口后仍然会返回 RequestId,但不会显示组播域和交换机的关联关系。

调试

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

授权信息

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

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

请求参数

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

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

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

123e4567-e89b-12d3-a456-4266****
TransitRouterMulticastDomainIdstring

组播域 ID。

tr-mcast-domain-91wpg6wbhchjeq****
TransitRouterAttachmentIdstring

网络实例连接 ID。

tr-attach-p90y3ymbbwuvy5****
VSwitchIdsarray

交换机 ID 列表。

string

交换机 ID。

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

vsw-p0w9s2ig1jnwgrbzl****
ResourceTypestring

组播域关联的资源类型。

仅取值:VPC

VPC
ResourceIdstring

组播域关联的资源的 ID。

vpc-p0w9alkte4w2htrqe****
MaxResultslong

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

20
NextTokenstring

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

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

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

1CD0969B-A605-5D2D-BFF0-699FD182FB7F
TotalCountinteger

列表条目数。

1
MaxResultsinteger

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

20
NextTokenstring

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

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

关联信息列表。

TransitRouterMulticastAssociationobject

关联信息。

TransitRouterMulticastDomainIdstring

组播域 ID。

tr-mcast-domain-91wpg6wbhchjeq****
TransitRouterAttachmentIdstring

网络实例连接 ID。

tr-attach-p90y3ymbbwuvy5****
VSwitchIdstring

交换机 ID。

vsw-p0wxk12u6okfkr8xy****
Statusstring

关联状态。

  • Associated:已关联。
  • Associating:关联中。
  • Dissociating:解除关联中。
Dissociating
ResourceTypestring

组播域关联的资源类型。

仅取值:VPC

VPC
ResourceOwnerIdlong

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

1210123456123456
ResourceIdstring

组播域关联的资源的 ID。

vpc-p0w9b7g9l90yofr0n****

示例

正常返回示例

JSON格式

{
  "RequestId": "1CD0969B-A605-5D2D-BFF0-699FD182FB7F",
  "TotalCount": 1,
  "MaxResults": 20,
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TransitRouterMulticastAssociations": [
    {
      "TransitRouterMulticastDomainId": "tr-mcast-domain-91wpg6wbhchjeq****",
      "TransitRouterAttachmentId": "tr-attach-p90y3ymbbwuvy5****",
      "VSwitchId": "vsw-p0wxk12u6okfkr8xy****",
      "Status": "Dissociating",
      "ResourceType": "VPC",
      "ResourceOwnerId": 1210123456123456,
      "ResourceId": "vpc-p0w9b7g9l90yofr0n****"
    }
  ]
}

错误码

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 错误码发生变更查看变更详情