Deletes a multicast source.

Usage notes

DeregisterTransitRouterMulticastGroupSources 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 source.

  • If a multicast source is in the Deregistering state, the multicast source is being deleted. You can query the multicast source but cannot perform other operations.
  • If a multicast source cannot be found, the multicast source is deleted.

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 DeregisterTransitRouterMulticastGroupSources

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

ClientToken String No 123e4567-e89b-12d3-a456-4266****

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 group to which the multicast source belongs.

GroupIpAddress String Yes 239.XX.XX.2

The IP address of the multicast group to which the multicast source belongs.

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

The ID of the multicast source.

You can create only one multicast source in a multicast group.

Note This parameter is required.
DryRun Boolean No false

Specifies whether only to check the request. Valid values:

  • true: only prechecks the API request. The multicast source is not deleted. 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 request. After the request passes the precheck, the multicast source is deleted.

Response parameters

Parameter Type Example Description
RequestId String 53E7E8BE-7F4E-5458-ACCA-9B5C1D6A642D

The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format 

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

<DeregisterTransitRouterMulticastGroupSourcesResponse>
    <RequestId>53E7E8BE-7F4E-5458-ACCA-9B5C1D6A642D</RequestId>
</DeregisterTransitRouterMulticastGroupSourcesResponse>

JSON format 

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

{
  "RequestId" : "53E7E8BE-7F4E-5458-ACCA-9B5C1D6A642D"
}

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.