Modifies the name and description of a multicast domain.
Authorization information
The following table is the authorization information corresponding to the API, which can be found in the RAM permission policy statement.Action
Used in the element to grant the RAM user or RAM role permission to call this API. The specific instructions are as follows:
- 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 keyword: refers to the condition keyword defined by the cloud product itself.
- 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.
Operate | access level | Resource type | conditional keyword | Association operation |
---|---|---|---|---|
cen:ModifyTransitRouterMulticastDomain | Write |
|
|
without |
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:
Note
This parameter is not in use.
|
false |
Response parameters
Example
Normal return example
JSON
Format
{
"RequestId": "26273D23-5CB0-5EFC-AF5F-78A5448084C9"
}
Error codes
Http code | Error code | Error message |
---|---|---|
400 | Illegal.Name | Name is illegal. |
400 | Illegal.Description | Description is illegal. |
400 | InvalidMulticastDomainId.NotFound | The specified MulticastDomainId is not found. |
400 | DryRunOperation | Request validation has been passed with DryRun flag set. |
For a list of error codes, visit the API error center.