ModifyTransitRouterMulticastDomain - Cloud Enterprise Network - Alibaba Cloud ドキュメントセンター

You can call the ModifyTransitRouterMulticastDomain operation to modify the name, description, and feature options of a multicast domain.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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:ModifyTransitRouterMulticastDomain	update	TransitRouterMulticastDomain `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 token, but you must make sure that the token is unique among different requests. The token 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 can be empty or 1 to 128 characters in length, and cannot start with http:// or https://.	nametest
TransitRouterMulticastDomainDescription	string	No	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://.	desctest
DryRun	boolean	No	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.	false
Options	object	No	Multicast domain feature.
Igmpv2Support	string	No	Indicates whether the IGMP feature is enabled for the multicast domain. Once enabled, hosts can dynamically join or leave multicast groups by using the IGMP protocol. Default value: enable. Note The IGMP feature is in beta testing. To use it, contact your account manager. The IGMP feature cannot be disabled after it is enabled.	enable

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	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.
400	IllegalParam.Igmpv2Support	The specified Igmpv2Support is illegal. Valid values are [enable, disable].	The parameter Igmpv2Support is invalid. Value range: enable, disable.
400	OperationUnsupported.Igmpv2Support	The current UID does not allow the creation of a igmpv2 multicast domain. Please submit a ticket.	The current UID does not allow the creation of a multicast domain of the igmpv2 type. Please submit a ticket.
400	OperationUnsupported.NotAllowedDisableIgmpv2Support	The operation is not permitted because Igmpv2Support is not currently available to be disabled.	The operation is not permitted because Igmpv2Support is not currently available to be disabled.
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
2025-01-06	The Error code has changed. The request parameters of the API has changed	View Change Details
2024-11-21	API Description Update. The Error code has changed	View Change Details
2024-09-25	The Error code has changed	View Change Details