DeregisterTransitRouterMulticastGroupMembers - Cloud Enterprise Network

Removes a multicast member from a multicast group.

Operation description

DeregisterTransitRouterMulticastGroupMembers 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 member.

If the multicast member is in the Deregistering state, the multicast member is being removed. In this case, you can query the multicast member but cannot perform other operations on the multicast member.
If a multicast member cannot be found, the multicast member is removed from the multicast group.``

Before you call the DeregisterTransitRouterMulticastGroupMembers operation, make sure that all request parameters are valid. If a request parameter is invalid, a request ID is returned but the multicast member is not removed.

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:DeregisterTransitRouterMulticastGroupMembers	delete	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 value, but you must make sure that it is unique among all requests. The token can contain only ASCII characters.	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.	239.XX.XX.2
NetworkInterfaceIds	array	No	The IDs of elastic network interfaces (ENIs).
	string	No	The ID of the ENI. You can specify multiple ENIs. Make sure that the total number of specified ENIs and multicast domains does not exceed five.	eni-p0weuda3lszwzjly****
PeerTransitRouterMulticastDomains	array	No	The ID of the multicast domain that is in a different region.
	string	No	The ID of the multicast domain that is in a different region. You can specify multiple multicast domains. Make sure that the total number of specified ENIs and multicast domains does not exceed five.	tr-mcast-domain-5mjb5gjb6dgu98****
DryRun	boolean	No	Specifies whether to perform a dry run, without performing the actual request. Valid 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.	false

Response parameters

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

Examples

Sample success responses

JSONformat

{
  "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	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
2024-01-19	The Error code has changed	View Change Details