Removes multicast members from a multicast group.

Usage notes

RegisterTransitRouterMulticastGroupMembers is an asynchronous operation. After you send a request, the request ID is returned but the operation is still being performed in the system background. You can call ListTransitRouterMulticastGroups to query the status of a multicast member.

  • If a 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.
  • If a multicast member cannot be found, the multicast member is removed from the multicast group.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DeregisterTransitRouterMulticastGroupMembers

The operation that you want to perform. Set the value to DeregisterTransitRouterMulticastGroupMembers.

ClientToken String No 123e4567-e89b-12d3-a456-426655440000

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 different requests. ClientToken can contain only ASCII characters.

TransitRouterMulticastDomainId String Yes tr-mcast-domain-91wpg6wbhchjeq****

The ID of the multicast domain to which the multicast members belong.

GroupIpAddress String Yes 239.XX.XX.2

The IP address of the multicast group to which the multicast members belong.

NetworkInterfaceIds.N String No eni-p0weuda3lszwzjly****

The ID of the elastic network interface (ENI).

You can specify multiple ENIs. Make sure that the total number of specified ENIs and multicast domains does not exceed five.

PeerTransitRouterMulticastDomains.N String No tr-mcast-domain-5mjb5gjb6dgu98****

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.

DryRun Boolean No false

Specifies whether only to precheck the request. Valid values:

  • true: only prechecks the request but does not remove the multicast members. The system checks the required parameters, the request format, and the service limits. If the request fails to pass the precheck, an error message is returned. If the request passes the precheck, the DryRunOperation error code is returned.
  • false (default): sends the API request. After the request passes the precheck, the multicast members are removed.

Response parameters

Parameter Type Example Description
RequestId String 61D0A553-5E4E-53B5-9DA3-01CBA076A286

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DeregisterTransitRouterMulticastGroupMembers
&ClientToken=123e4567-e89b-12d3-a456-426655440000
&TransitRouterMulticastDomainId=tr-mcast-domain-91wpg6wbhchjeq****
&GroupIpAddress=239.XX.XX.2
&NetworkInterfaceIds=["eni-p0weuda3lszwzjly****"]
&PeerTransitRouterMulticastDomains=["tr-mcast-domain-5mjb5gjb6dgu98****"]
&DryRun=false
&Common request parameters

Sample success responses

XML format 

HTTP/1.1 200 OK
Content-Type:application/xml

<DeregisterTransitRouterMulticastGroupMembersResponse>
    <RequestId>61D0A553-5E4E-53B5-9DA3-01CBA076A286</RequestId>
</DeregisterTransitRouterMulticastGroupMembersResponse>

JSON format 

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HttpCode Error code Error message Description
400 DryRunOperation Request validation has been passed with DryRun flag set. The error message returned because the dry run request passed the precheck.

For a list of error codes, visit the API Error Center.