DeleteTransitRouterMulticastDomain - Cloud Enterprise Network

Deletes a multicast domain.

Operation description

Before you delete a multicast domain, make sure that the following requirements are met:

The multicast domain is disassociated from all vSwitches. For more information, see DisassociateTransitRouterMulticastDomain .
All multicast sources and members are removed from the multicast domain. For more information, see DeregisterTransitRouterMulticastGroupSources and DeregisterTransitRouterMulticastGroupMembers .
The multicast domain is not added to other multicast domains as a multicast member. If the multicast domain is added to another multicast domain as a multicast member, you must remove the multicast domain from the other multicast domain. For more information, see DeregisterTransitRouterMulticastGroupMembers .
Make sure all the request parameters are valid. If a request parameter is invalid, a request ID is returned after you call the operation, but the multicast domain is not deleted.

Debugging

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

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:DeleteTransitRouterMulticastDomain	Write	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 the value is unique among different requests. The client token can contain only ASCII characters.	123e4567-e89b-12d3-a456-4266****
TransitRouterMulticastDomainId	string	Yes	The ID of the multicast domain.	tr-mcast-domain-40cwj0rgzgdtam****
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run. The system checks the required parameters, request syntax, and 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 sends the request.	false

Response parameters

Parameter	Type	Description	Example
	object	The response.
RequestId	string	The ID of the request.	40194E53-2484-5831-BB53-E11D123C1A32

Examples

Sample success responses

JSONformat

{
  "RequestId": "40194E53-2484-5831-BB53-E11D123C1A32"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectStatus.MulticastDomain	The status of MulticastDomain is incorrect.	The error message returned because the status of the specified multicast domain does not support this operation. Try again later.
400	InstanceNotExist	The instance is not exist.	The error message returned because the specified instance does not exist.
400	IncorrectStatus.Cen	The status of Cen is incorrect.	The error message returned because the status of the specified CEN instance does not support this operation. Try again later.
400	IncorrectStatus.TransitRouter	The status of TransitRouter is incorrect.	The error message returned because the status of the transit router does not support this operation. Try again later.
400	InvalidOperation.MulticastDomainAssociationExist	Operation is invalid because multicast domain associations exist.	The error message returned because this operation is not supported when the multicast domain is associated with a resource.
400	InvalidOperation.MulticastGroupExist	Operation is invalid because multicast groups exist.	The error message returned because this operation is not supported when a multicast domain group exists.
400	InvalidOperation.MulticastDomainInGroup	Operation is invalid because multicast domain has registered as multicast group member.	The error message returned because the specified multicast domain is added to a multicast group as a multicast member.
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

No change history