Queries whether vSwitches in VPCs are associated with a specified multicast domain.

Usage notes

Multicast domains can be associated only with vSwitches that are in VPCs. You can call ListTransitRouterMulticastDomainAssociations to query whether vSwitches in VPCs are associated with a specified multicast domain.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes ListTransitRouterMulticastDomainAssociations

The operation that you want to perform. Set the value to ListTransitRouterMulticastDomainAssociations.

ClientToken String No 123e4567-e89b-12d3-a456-4266****

The client token that is used to ensure the idempotence of the request.

You can use the client to generate the value, but you must ensure that it is unique among all requests. The token can contain only ASCII characters.

TransitRouterMulticastDomainId String No tr-mcast-domain-91wpg6wbhchjeq****

The ID of the multicast domain.

TransitRouterAttachmentId String No tr-attach-p90y3ymbbwuvy5****

The ID of the network instance connection.

VSwitchIds.N String No vsw-p0w9s2ig1jnwgrbzl****

The IDs of the vSwitches.

You can specify at most 20 IDs.

ResourceType String No VPC

The type of resource associated with the multicast domain.

Valid value: VPC.

ResourceId String No vpc-p0w9alkte4w2htrqe****

The ID of the resource associated with the multicast domain.

MaxResults Long No 20

The number of entries to return on each page. Default value: 20.

NextToken String No FFmyTO70tTpLG6I3FmYAXGKPd****

The token that determines the start point of the query. Valid values:

  • If this is your first query or no subsequent query is to be sent, ignore this parameter.
  • If a subsequent query is to be sent, set the parameter to the value of NextToken that is returned from the last call.

Response parameters

Parameter Type Example Description
RequestId String 1CD0969B-A605-5D2D-BFF0-699FD182FB7F

The ID of the request.

TotalCount Integer 1

The number of entries returned.

MaxResults Integer 20

The number of entries returned on each page.

NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

The token that determines the start point of the query. Valid values:

  • If NextToken was not returned in the previous query, it indicates that no additional results exist.
  • If NextToken was returned in the previous query, specify the value to obtain the next set of results.
TransitRouterMulticastAssociations Array of TransitRouterMulticastAssociation

The information about the resource associated with the multicast domain.

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

The ID of the multicast domain.

TransitRouterAttachmentId String tr-attach-p90y3ymbbwuvy5****

The ID of the network instance connection.

VSwitchId String vsw-p0wxk12u6okfkr8xy****

The IDs of the vSwitches.

Status String Dissociating

The status of the associated resource. Valid values:

  • Associated: The resource is associated with the multicast domain.
  • Associating: The resource is being associated with the multicast domain.
  • Dissociating: The resource is being disassociated from the multicast domain.
ResourceType String VPC

The type of resource associated with the multicast domain.

Valid value: VPC.

ResourceOwnerId Long 1210123456123456

The ID of the Alibaba Cloud account to which the resource associated with the multicast domain belongs.

ResourceId String vpc-p0w9b7g9l90yofr0n****

The ID of the resource associated with the multicast domain.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListTransitRouterMulticastDomainAssociations
&ClientToken=123e4567-e89b-12d3-a456-4266****
&TransitRouterMulticastDomainId=tr-mcast-domain-91wpg6wbhchjeq****
&TransitRouterAttachmentId=tr-attach-p90y3ymbbwuvy5****
&VSwitchIds=["vsw-p0w9s2ig1jnwgrbzl****"]
&ResourceType=VPC
&ResourceId=vpc-p0w9alkte4w2htrqe****
&MaxResults=20
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&<Common request parameters>

Sample success responses

XML format 

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

<ListTransitRouterMulticastDomainAssociationsResponse>
    <RequestId>1CD0969B-A605-5D2D-BFF0-699FD182FB7F</RequestId>
    <TotalCount>1</TotalCount>
    <MaxResults>20</MaxResults>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <TransitRouterMulticastAssociations>
        <TransitRouterMulticastDomainId>tr-mcast-domain-91wpg6wbhchjeq****</TransitRouterMulticastDomainId>
        <TransitRouterAttachmentId>tr-attach-p90y3ymbbwuvy5****</TransitRouterAttachmentId>
        <VSwitchId>vsw-p0wxk12u6okfkr8xy****</VSwitchId>
        <Status>Dissociating</Status>
        <ResourceType>VPC</ResourceType>
        <ResourceOwnerId>1210123456123456</ResourceOwnerId>
        <ResourceId>vpc-p0w9b7g9l90yofr0n****</ResourceId>
    </TransitRouterMulticastAssociations>
</ListTransitRouterMulticastDomainAssociationsResponse>

JSON format 

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

Error codes

For a list of error codes, visit the API Error Center.