RegisterTransitRouterMulticastGroupMembers - Cloud Enterprise Network

Adds multicast members to a multicast group.

Operation Description

Enterprise Edition transit routers allow you to specify elastic network interfaces (ENIs) as multicast members. You can call the RegisterTransitRouterMulticastGroupMembers operation to add ENIs in the same region or in different regions to a multicast group as multicast members.

If you specify a value for NetworkInterfaceIds, ENIs in the current region are specified as multicast members. Make sure that the vSwitches of the ENIs are associated with the multicast domain. For more information, see AssociateTransitRouterMulticastDomain.

If you specify a value for PeerTransitRouterMulticastDomains, multicast members in the multicast group that has the same IP address as the current multicast group but is in a different region are added to the current multicast group. Make sure that an inter-region connection is created. For more information, see CreateTransitRouterPeerAttachment.

For example, Alice created a multicast domain (Domain A) in the Australia (Sydney) region and a multicast domain (Domain B) in the UK (London) region. Domain A contains a multicast group (Group A), and Domain B contains a multicast group (Group B). Group A and Group B have the same multicast IP address. Group B in UK (London) contains a multicast member (Member B). When Alice calls the `RegisterTransitRouterMulticastGroupMembers` operation, if she sets **PeerTransitRouterMulticastDomains** to the ID of Member B in Group B that is in the UK (London) region, Member B is added to Group A in the Australia (Sydney) region.

The RegisterTransitRouterMulticastGroupMembers operation is an asynchronous operation. After you send a request, the system returns a request ID and runs the task in the background. You can call the ListTransitRouterMulticastGroups operation to query the status of a multicast member.
- If a multicast member is in the Registering state, the multicast member is being added. You can query the multicast member but cannot perform other operations.
- If a multicast member is in the Registered state, the multicast member is added.

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.

Operation	Access level	Resource type	Condition key	Association operation
cen:RegisterTransitRouterMulticastGroupMembers	Read	CEN acs:cen:*:{#accountId}:centransitroutermulticast/{#centransitroutermulticastId}	none	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 all requests. The token can contain only ASCII characters. NoteIf you do not set this parameter, ClientToken is set to the value of RequestId. The value of RequestId may be different for each request.	123e4567-e89b-12d3-a456-426655440000
TransitRouterMulticastDomainId	string	Yes	The ID of the multicast domain to which the multicast members belong.	tr-mcast-domain-91wpg6wbhchjeq****
GroupIpAddress	string	Yes	The IP address of the multicast group to which the multicast members belong. Valid values: 224.0.0.1 to 239.255.255.254. If the multicast group does not exist in the specified multicast domain, the system automatically creates the multicast group in the multicast domain.	239.XX.XX.2
NetworkInterfaceIds	array	No	The IDs of ENIs.
	string	No	The ID of the ENI. You can specify at most five ENIs in each call.	eni-p0weuda3lszwzjly****
PeerTransitRouterMulticastDomains	array	No	The IDs of the multicast domains that are in different regions.
	string	No	The ID of the multicast domain that is in a different region. You can specify at most five multicast domains that are in different regions.	tr-mcast-domain-5mjb5gjb6dgu98****
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run. The system checks the required parameters, request syntax, and limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): performs a dry run and sends the request.	false
VpcId	string	No	The ID of the VPC to which the ENI belongs. If the ENI belongs to the current Alibaba Cloud account, ignore this parameter. If the ENI belongs to a different Alibaba Cloud account, you must set this parameter.	vpc-wz9fusm6zq8uy7cfa****

Response parameters

Parameter	Type	Description	Example
	object	The response.
RequestId	string	The ID of the request.	EB985B7E-2CF8-5EC9-A7DB-F7C82ABD3ACE

Examples

Sample success responses

JSONformat

{
  "RequestId": "EB985B7E-2CF8-5EC9-A7DB-F7C82ABD3ACE"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.GroupIpAddress	The specified GroupIpAddress is illegal.	The error message returned because the GroupIpAddress parameter is set to an invalid value.
400	InvalidMulticastDomainId.NotFound	The specified AttachmentId is not found.	The error message returned because the specified multicast domain does not exist.
400	IncorrectStatus.MulticastDomainId	The status of MulticastDomainId is incorrect.	The error message returned because the status of the specified multicast domain does not support this operation. Try again later.
400	IncorrectStatus.Cen	The status of Cen is incorrect.	The error message returned because the status of the specified CEN instance does not support this operation. Try again later.
400	InstanceNotExist	The instance is not exist.	The error message returned because the specified instance does not exist.
400	InvalidOperation.PeerMulticastDomainRegion	Operation is invalid because to peer multicast domain in the same region with multicast domain.	-
400	InvalidOperation.MulticastDomainStatus	Operation is invalid, due to multicast domain not Active.	The error message returned because the status of the specified multicast domain does not support this operation.
400	InvalidOperation.BandwidthLimitNotExist	Operation is invalid because a bandwidth limit not exist.	The error message returned because the specified bandwidth cap of the bandwidth plan does not exist.
400	AttachmentNotFound	"The attachment does not exist.	-
400	IncorrectStatus.AttachmentId	The status of AttachmentId is incorrect.	The error message returned because the status of the attachment does not support this operation. Try again later.
400	InstanceExist	The instance already exists.	The error message returned because the specified instance already exists.
400	InvalidOperation.NetworkInterfaceNotExist	Operation is invalid bacause network interface not exist.	The error message returned because the network instance does not exist.
400	InvalidOperation.NTRNetworkInterfaceNotSupport	Operation is invalid, due to ntr eni not support.	The error message returned because the ENI of the transit router cannot be added to the multicast group.
400	InvalidOperation.MulticastDomainAssociationNotExist	Operation is invalid because multicast association domain association not exist.	The error message returned because this operation is not supported when the specified multicast domain is not associated with the specified resource.
400	InvalidOperation.MulticastDomainAssociationStatus	Operation is invalid, due to multicast domain association not Active.	The error message returned because the status of the specified multicast domain does not support this operation. Try again later.
400	InvalidPeerTrMulticastDomainId.NotFound	The specified PeerTrMulticastDomainId is not found.	The error message returned because the specified multicast domain on the peer transit does not exist.
400	IncorrectStatus.PeerTrMulticastDomainId	The status of PeerTrMulticastDomainId is incorrect.	The error message returned because the specified multicast domain on the peer transit router (PeerTrMulticastDomain) does not support this operation. Try again later.
400	IllegalParam.PeerTrMulticastDomainId	The specified PeerTrMulticastDomainId is illegal.	The error message returned because the PeerTrMulticastDomainId parameter is set to an invalid value.
400	InvalidOperation	Operation is invalid.	The error message returned because the operation is invalid.
400	QuotaFull.MulticastGroupPerDomain	The number of multicast group has exceed the maximum value that can be created.	The error message returned because the number of multicast groups in the multicast domain has reached the upper limit.
400	QuotaFull.MulticastMemberPerGroup	The number of multicast group member has exceed the maximum value that can be created.	The error message returned because the number of multicast members in the multicast group has reached the upper limit.
400	QuotaFull.MulticastPeerMemberPerGroup	The number of multicast group member peer domain has exceed the maximum value that can be created.	The error message returned because the number of multicast members from another region in the multicast group has reached the upper limit.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	The error message returned because the dry run request passed the precheck.
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.

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