ModifyTransitRouterMulticastDomain - Cloud Enterprise Network

Modifies the name and description of a multicast domain.

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	Association operation
cen:ModifyTransitRouterMulticastDomain	Write	CEN acs:cen:*:{#accountId}:centransitroutermulticast/{#TransitRouterMulticastDomainId}	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 it is unique among different requests. ClientToken can contain only ASCII characters.	123e4567-e89b-12d3-a456-4266****
TransitRouterMulticastDomainId	string	Yes	The ID of the multicast domain.	tr-mcast-domain-40cwj0rgzgdtam****
TransitRouterMulticastDomainName	string	No	The new name of the multicast domain. The name must be 0 to 128 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).	nametest
TransitRouterMulticastDomainDescription	string	No	The new description of the multicast domain. The description must be 0 to 256 characters in length, and can contain letters, digits, commas (,), periods (.), semicolons (;), forward slashes (/), at signs (@), underscores (_), and hyphens (-).	desctest
DryRun	boolean	No	Specifies whether only to precheck the request. Valid values: true: prechecks the request but does not modify the name or description of the multicast domain. The system checks the required parameters, the request format, and the service limits. If the request fails the precheck, an error message is returned. If the request passes the precheck, the `DryRunOperation` error code is returned. false (default): sends the request. If the request passes the precheck, the name and description of the multicast domain are modified. NoteThis parameter is not in use.	false

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	26273D23-5CB0-5EFC-AF5F-78A5448084C9

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message	Description
400	Illegal.Name	Name is illegal.	The error message returned because the name is invalid.
400	Illegal.Description	Description is illegal.	The error message returned because the description is invalid.
400	InvalidMulticastDomainId.NotFound	The specified MulticastDomainId is not found.	The error message returned because the specified multicast domain does not exist.
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 Service error codes.