All Products
Search
Document Center

Cloud Enterprise Network:ListTransitRouterMulticastDomainAssociations

Last Updated:Mar 25, 2024

Queries whether a multicast domain is associated with a vSwitch.

Operation description

  • You must set at least TransitRouterMulticastDomainId and TransitRouterAttachmentId. If you set TransitRouterAttachmentId, the information about the vSwitches in a virtual private cloud (VPC) that are associated with a multicast domain is returned. If you set TransitRouterMulticastDomainId, the information about the vSwitches that are associated with a multicast domain is returned.
  • Before you call ListTransitRouterMulticastDomainAssociations, make sure that all the request parameters are valid. If a request parameter is invalid, the system returns a request ID but does not return the vSwitches that are associated with the multicast domain.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
cen:ListTransitRouterMulticastDomainAssociationsRead
  • TransitRouterMulticastDomain
    acs:cen:*:{#accountId}:centransitroutermulticast/{#centransitroutermulticastId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ClientTokenstringNo

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 make sure that it is unique among all requests. The token can only contain ASCII characters.

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

The ID of the multicast domain.

tr-mcast-domain-91wpg6wbhchjeq****
TransitRouterAttachmentIdstringNo

The ID of the network instance connection.

tr-attach-p90y3ymbbwuvy5****
VSwitchIdsarrayNo

The IDs of vSwitches.

stringNo

The ID of the vSwitch.

You can specify at most 20 vSwitch IDs.

vsw-p0w9s2ig1jnwgrbzl****
ResourceTypestringNo

The type of resource associated with the multicast domain.

Valid value: VPC.

VPC
ResourceIdstringNo

The ID of the resource associated with the multicast domain.

vpc-p0w9alkte4w2htrqe****
MaxResultslongNo

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

20
NextTokenstringNo

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

  • If this is your first query and no next queries are 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.
FFmyTO70tTpLG6I3FmYAXGKPd****

Response parameters

ParameterTypeDescriptionExample
object

The response.

RequestIdstring

The ID of the request.

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

The total number of entries returned.

1
MaxResultsinteger

The number of entries returned on each page.

20
NextTokenstring

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

  • If NextToken is empty, it indicates that no subsequent query is to be sent.
  • If NextToken was returned in the previous query, specify the value to obtain the next set of results.
FFmyTO70tTpLG6I3FmYAXGKPd****
TransitRouterMulticastAssociationsobject []

The information about the resource associated with the multicast domain.

TransitRouterMulticastDomainIdstring

The ID of the multicast domain.

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

The ID of the network instance connection.

tr-attach-p90y3ymbbwuvy5****
VSwitchIdstring

The ID of the vSwitch.

vsw-p0wxk12u6okfkr8xy****
Statusstring

The association status. 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.
Dissociating
ResourceTypestring

The type of resource associated with the multicast domain.

Valid value: VPC.

VPC
ResourceOwnerIdlong

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

1210123456123456
ResourceIdstring

The ID of the resource associated with the multicast domain.

vpc-p0w9b7g9l90yofr0n****

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400IllegalParam.NextTokenThe specified NextToken is illegal.The error message returned because the NextToken parameter is set to an invalid value.
400IllegalParam.TransitRouterMulticastDomainIdThe specified TransitRouterMulticastDomainId is illegal.The error message returned because the specified multicast domain ID specified for the transit router (TransitRouterMulticastDomainId) is invalid.
400IllegalParam.MaxResultsThe specified MaxResults is illegal.MaxResults illegal.
400InvalidParameterInvalid parameter.The error message returned because the parameter is set to an invalid value.
400UnauthorizedThe AccessKeyId is unauthorized.The error message returned because you do not have the permissions to perform this operation.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-08-04The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change