All Products
Document Center

Cloud Enterprise Network:ModifyTransitRouterMulticastDomain

Last Updated:Apr 26, 2024

Modifies the name and description of a multicast domain.


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
  • TransitRouterMulticastDomain

Request parameters


The client token that is used to ensure the idempotence of the request.

You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters.


The ID of the multicast domain.


The new name of the multicast domain.

The name can be empty or 1 to 128 characters in length, and cannot start with http:// or https://.


The new description of the multicast domain.

This parameter is optional. If you enter a description, it must be 1 to 256 characters in length and cannot start with http:// or https://.


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.

Response parameters


The response parameters.


The request ID.



Sample success responses


  "RequestId": "26273D23-5CB0-5EFC-AF5F-78A5448084C9"

Error codes

HTTP status codeError codeError messageDescription
400Illegal.NameName is illegal.The error message returned because the name is invalid.
400Illegal.DescriptionDescription is illegal.The error message returned because the description is invalid.
400InvalidMulticastDomainId.NotFoundThe specified MulticastDomainId is not found.The error message returned because the specified multicast domain does not exist.
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
No change history