Query multicast domain and vSwitch associations by calling ListTransitRouterMulticastDomainAssociations - Cloud Enterprise Network - Alibaba Cloud - Cloud Enterprise Network

Queries the associations between a multicast domain and vSwitches.

Operation description

When calling this operation, you must specify at least one of the request parameters TransitRouterMulticastDomainId and TransitRouterAttachmentId. Specifying TransitRouterAttachmentId queries the information about vSwitches that are associated with a multicast domain under a VPC-connected instance. Specifying TransitRouterMulticastDomainId queries the information about vSwitches that are associated with the multicast domain.
When calling the ListTransitRouterMulticastDomainAssociations operation, make sure that the parameter values you specify are correct. If you specify incorrect parameter values, the operation still returns a RequestId but does not return the associations between the multicast domain and vSwitches.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cen:ListTransitRouterMulticastDomainAssociations

get

*TransitRouterMulticastDomain

acs:cen:*:{#accountId}:centransitroutermulticast/{#centransitroutermulticastId}

None

Request parameters

Parameter	Type	Required	Description	Example
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The client token can contain only ASCII characters.	123e4567-e89b-12d3-a456-4266****
TransitRouterMulticastDomainId	string	No	The multicast domain ID.	tr-mcast-domain-91wpg6wbhchjeq****
TransitRouterAttachmentId	string	No	The network instance connection ID.	tr-attach-p90y3ymbbwuvy5****
VSwitchIds	array	No	The list of vSwitch IDs.
	string	No	The vSwitch ID. You can specify up to 20 vSwitch IDs.	vsw-p0w9s2ig1jnwgrbzl****
ResourceType	string	No	The type of resource associated with the multicast domain. Set the value to VPC.	VPC
ResourceId	string	No	The ID of the resource associated with the multicast domain.	vpc-p0w9alkte4w2htrqe****
MaxResults	integer	No	The number of entries per page for a paged query. Default value: 20.	20
NextToken	string	No	The token that determines the start point of the query. Valid values: If this is the first query or no subsequent query is to be sent, you do not need to specify this parameter. If a subsequent query is to be sent, set the value to the NextToken value returned in the previous call.	FFmyTO70tTpLG6I3FmYAXGKPd****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1CD0969B-A605-5D2D-BFF0-699FD182FB7F
TotalCount	integer	The total number of entries returned.	1
MaxResults	integer	The number of entries per page for a paged query.	20
NextToken	string	The token that determines the start point of the query. Valid values: If NextToken is empty, no subsequent query is to be sent. If NextToken is returned, the value indicates the token for the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
TransitRouterMulticastAssociations	array<object>	The list of associations.
	object	The association information.
TransitRouterMulticastDomainId	string	The multicast domain ID.	tr-mcast-domain-91wpg6wbhchjeq****
TransitRouterAttachmentId	string	The network instance connection ID.	tr-attach-p90y3ymbbwuvy5****
VSwitchId	string	The vSwitch ID.	vsw-p0wxk12u6okfkr8xy****
Status	string	The association status. Associated: associated. Associating: being associated. Dissociating: being dissociated.	Dissociating
ResourceType	string	The type of resource associated with the multicast domain. Set the value to VPC.	VPC
ResourceOwnerId	integer	The ID of the Alibaba Cloud account to which the resource associated with the multicast domain belongs.	1210123456123456
ResourceId	string	The ID of the resource associated with the multicast domain.	vpc-p0w9b7g9l90yofr0n****

Examples

Success response

JSON format

{
  "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

HTTP status code	Error code	Error message	Description
400	IllegalParam.NextToken	The specified NextToken is illegal.	The error message returned because the NextToken parameter is set to an invalid value.
400	IllegalParam.TransitRouterMulticastDomainId	The specified TransitRouterMulticastDomainId is illegal.	The error message returned because the specified multicast domain ID specified for the transit router (TransitRouterMulticastDomainId) is invalid.
400	IllegalParam.MaxResults	The specified MaxResults is illegal.	MaxResults illegal.
400	InvalidParameter	Invalid parameter.	The error message returned because the parameter is set to an invalid value.
400	Unauthorized	The AccessKeyId is unauthorized.	The error message returned because you do not have the permissions to perform this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.