RegisterTransitRouterMulticastGroupSources - Cloud Enterprise Network

Creates a multicast source for a one-to-many multicast network.

Operation description

You can specify only elastic network interfaces (ENIs) as multicast sources.
RegisterTransitRouterMulticastGroupSources is an asynchronous operation. After a request is sent, 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 source.
- If a multicast source is in the Registering state, the multicast source is being created. You can query the multicast source but cannot perform other operations on the multicast source.
- If a multicast source is in the Registered state, the multicast source is created.

Prerequisite

Before you call RegisterTransitRouterMulticastGroupSources, make sure that the vSwitch on which the ENI is created is associated with the multicast domain. For more information, see AssociateTransitRouterMulticastDomain .

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

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	Associated operation
cen:RegisterTransitRouterMulticastGroupSources	create	TransitRouterMulticastDomain 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 different requests. The token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID is different for each request.	123e4567-e89b-12d3-a456-4266****
TransitRouterMulticastDomainId	string	Yes	The ID of the multicast domain to which the multicast source belongs.	tr-mcast-domain-5mjb5gjb6dgu98****
GroupIpAddress	string	Yes	The IP address of the multicast group to which the multicast source belongs. Valid values: 224.0.1.0 to 239.255.255.254. Note 224.0.0.0 to 224.0.0.255 are reserved by the system and cannot be used by multicast groups. If the multicast group does not exist in the multicast domain, the system automatically creates the multicast group in the multicast domain.	239.XX.XX.2
NetworkInterfaceIds	array	No	The IDs of the ENIs.
	string	No	The ID of the ENI that you want to specify as a multicast source. You can specify at most five multicast sources for a multicast group. Note This parameter is required.	eni-p0w92o2wupc3c05t****
DryRun	boolean	No	Specifies whether to perform a dry run, without sending the actual request. Default values: true: performs only a dry run. The system checks the request for potential issues, including missing parameter values, incorrect request syntax, and service limits. If the request fails the dry run, an error code is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): performs a dry run and performs the actual request. If the request passes the dry run, a 2xx HTTP status code is returned and the operation is performed.	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 parameters.
RequestId	string	The request ID.	9C5D5D70-0AFF-5E5C-8D8A-E92C90C8FB08

Examples

Sample success responses

JSONformat

{
  "RequestId": "9C5D5D70-0AFF-5E5C-8D8A-E92C90C8FB08"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidOperation.PeerMulticastDomainSource	Operation is invalid because peer multicast domain can not be group source.	The error message returned because you cannot specify a multicast domain in another region as the multicast source.
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	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	InstanceNotExist	The instance is not exist.	The error message returned because the specified instance does not exist.
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	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.MulticastSourcePerGroup	The number of multicast group source has exceed the maximum value that can be created.	The error message returned because the number of multicast sources 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	IncorrectStatus.ConnectPeerIds	Connect Peer statuses are incorrect.	Connect Peer statuses are incorrect.
400	InvalidConnectPeerIds.NotFound	The Connect Peer Ids are invalid.	The Connect Peer Ids are invalid.
400	OperationUnsupported.ExistsIgmpv2MemberOnEni	An igmpv2 multicast source or multicast member already exists on the ENI.	An igmpv2 multicast source or multicast member already exists on the ENI.
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.

Change history

Change time	Summary of changes	Operation
2024-09-25	The Error code has changed	View Change Details
2023-11-22	The Error code has changed	View Change Details