All Products
Search

This Product

    Cloud Enterprise Network:DeregisterTransitRouterMulticastGroupSources

    Document Center

    Cloud Enterprise Network:DeregisterTransitRouterMulticastGroupSources

    Last Updated:Mar 25, 2024

    Deletes a multicast source from a multicast group.

    Operation description

    DeregisterTransitRouterMulticastGroupSources is an asynchronous operation. After a request a 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 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.

    Before you call DeregisterTransitRouterMulticastGroupSources, make sure that all the request parameters are valid. If a request parameter is invalid, a request ID is returned but the multicast source is not deleted.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    cen:DeregisterTransitRouterMulticastGroupSourcesWrite
    • TransitRouterMulticastDomain
      acs:cen:*:{#accountId}:centransitroutermulticast/{#centransitroutermulticastId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ClientTokenstringNo

    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-4266****
    TransitRouterMulticastDomainIdstringYes

    The ID of the multicast domain to which the multicast source belongs.

    		tr-mcast-domain-91wpg6wbhchjeq****
    GroupIpAddressstringYes

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

    		239.XX.XX.2
    NetworkInterfaceIdsarrayNo

    A list of multicast source IDs.

    stringNo

    The multicast source ID.

    You can delete at most five multicast sources from a multicast group in each call.

    Note This parameter is required.
    		eni-p0weuda3lszwzjly****
    DryRunbooleanNo

    Specifies whether to perform a dry run, without sending 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 message 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

    ParameterTypeDescriptionExample
    object

    The response.

    RequestIdstring

    The ID of the request.

    		53E7E8BE-7F4E-5458-ACCA-9B5C1D6A642D

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400InvalidTransitRouterMulticastDomainId.NotFoundThe 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.
    400InvalidOperation.MulticastDomainStatusOperation 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.
    400IncorrectStatus.MulticastGroupThe 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.
    400DryRunOperationRequest validation has been passed with DryRun flag set.The error message returned because the dry run request passed the precheck.
    400InvalidParameterInvalid parameter.The error message returned because the parameter is set to an invalid value.
    400UnauthorizedThe 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 timeSummary of changesOperation
    2024-01-19The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400