Delete multicast group members using DeregisterTransitRouterMulticastGroupMembers - Cloud Enterprise Network - Alibaba Cloud - Cloud Enterprise Network

Removes a multicast member from a multicast group if the member no longer needs to receive multicast traffic by calling the DeregisterTransitRouterMulticastGroupMembers operation.

Operation description

DeregisterTransitRouterMulticastGroupMembers is an asynchronous operation. After you call this operation, the system returns a RequestId but the multicast member is not immediately removed. The removal task continues to run in the background. You can call ListTransitRouterMulticastGroups to query the status of the multicast member.

If the multicast member is in the Deregistering state, the multicast member is being removed. In this state, you can only query the multicast member but cannot perform other operations on it.
If the multicast member cannot be found in the multicast domain when you call the ListTransitRouterMulticastGroups operation, the multicast member has been removed.

When you call the DeregisterTransitRouterMulticastGroupMembers operation, make sure that the parameter values you specify are correct. If you specify incorrect parameter values, the system still returns a RequestId but does not remove the multicast member.

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:DeregisterTransitRouterMulticastGroupMembers

delete

*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-426655440000
TransitRouterMulticastDomainId	string	Yes	The ID of the multicast domain to which the multicast member belongs.	tr-mcast-domain-91wpg6wbhchjeq****
GroupIpAddress	string	Yes	The IP address of the multicast group to which the multicast member belongs.	239.XX.XX.2
NetworkInterfaceIds	array	No	The list of network interface controller (NIC) IDs.
	string	No	The network interface controller (NIC) ID. You can delete multiple network interface controllers (NICs) at a time. Make sure that the total number of network interface controllers (NICs) and cross-region multicast domains that you specify is less than or equal to 5.	eni-p0weuda3lszwzjly****
PeerTransitRouterMulticastDomains	array	No	The list of cross-region multicast domain IDs.
	string	No	The cross-region multicast domain ID. You can delete multiple cross-region multicast domains at a time. Make sure that the total number of network interface controllers (NICs) and cross-region multicast domains that you specify is less than or equal to 5.	tr-mcast-domain-5mjb5gjb6dgu98****
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run without removing the multicast member. The system checks the required parameters, request syntax, and business restrictions. If the check fails, the corresponding error is returned. If the check succeeds, the error code `DryRunOperation` is returned. false (default): performs a dry run and sends the request. After the check succeeds, the multicast member is removed.	false

Response elements

Element	Type	Description	Example
	object	The response.
RequestId	string	The request ID.	61D0A553-5E4E-53B5-9DA3-01CBA076A286

Examples

Success response

JSON format

{
  "RequestId": "61D0A553-5E4E-53B5-9DA3-01CBA076A286"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidTransitRouterMulticastDomainId.NotFound	The specified TransitRouterMulticastDomainId is not found.	The error message returned because the specified ID of the multicast domain (TransitRouterMulticastDomainId) on the transit router does not exist.
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	IncorrectStatus.MulticastGroup	The status of MulticastGroup is incorrect.	The error message returned because the status of the specified multicast group does not support this operation. Try again later.
400	DryRunOperation	Request validation has been passed with DryRun flag set.	The error message returned because the dry run request passed the precheck.
400	OperationUnsupported.NotAllowedDeleteIgmpv2Member	You cannot delete a multicast source or multicast member of the igmpv2 type.	You cannot delete a multicast source or member of the igmpv2 type.
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.
400	InvalidParameter.TransitRouterMulticastDomainId	The specified parameter TransitRouterMulticastDomainId is invalid.	The parameter TransitRouterMulticastDomainId entered is illegal.
400	InvalidParameter.PeerTransitRouterMulticastDomains	The specified parameter PeerTransitRouterMulticastDomains is invalid.	The parameter PeerTransitRouterMulticastDomains entered is illegal.
400	InvalidParameter.ConnectPeerIds	The specified parameter ConnectPeerIds is invalid.	The parameter ConnectPeerIds entered is illegal.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.