Use UpdateTransitRouter to modify the name and description of a TransitRouter - Cloud Enterprise Network - Alibaba Cloud - Cloud Enterprise Network

Modifies the name and description of a transit router instance.

Operation description

UpdateTransitRouter is an asynchronous operation. After you send a request, the system returns a RequestId, but the modification of the transit router instance is not yet complete. The modification task continues to run in the background. You can call the ListTransitRouters operation to query the status of the transit router instance.

If the transit router instance is in the Modifying state, the transit router instance is being modified. In this state, you can only query the transit router instance but cannot perform other operations on it.
If the transit router instance is in the Active state, the transit router instance has been modified.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cen:UpdateTransitRouter

update

*TransitRouter

acs:cen:*:{#accountId}:centransitrouter/{#centransitrouterId}

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 ClientToken value can contain only ASCII characters. Note If you do not specify this parameter, the system uses the RequestId as the ClientToken. The RequestId may be different for each API request.	02fb3da4-130e-11e9-8e44-001****
DryRun	boolean	No	Specifies whether to perform a dry run for this modification request, including permission and instance status checks. Valid values: false (default): Sends a normal request. After the request passes the check, the transit router instance information is directly modified. true: Sends a check request. Only the check is performed, and the transit router instance information is not modified. The check items include whether required parameters are specified and the request format. If the check fails, the corresponding error is returned. If the check passes, the corresponding request ID is returned.	false
RegionId	string	Yes	The region ID of the transit router instance. You can call the DescribeRegions operation to query the region ID.	cn-shanghai
TransitRouterId	string	Yes	The ID of the transit router instance.	tr-uf654ttymmljlvh2x****
TransitRouterName	string	No	The new name of the transit router instance. The name can be empty or 1 to 128 characters in length, and cannot start with http:// or https://.	testname
TransitRouterDescription	string	No	The new description of the transit router instance. The description can be empty or 1 to 256 characters in length, and cannot start with http:// or https://.	testdesc

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	E9963DD7-998B-4F92-892D-8293CB49EE81

Examples

Success response

JSON format

{
  "RequestId": "E9963DD7-998B-4F92-892D-8293CB49EE81"
}

Error codes

HTTP status code	Error code	Error message	Description
400	OperationUnsupported.RegionId	The specified region ID is not supported.	The specified region ID is not supported.
400	IncorrectStatus.TransitRouterInstance	The status of TransitRouter is incorrect.	The error message returned because the transit router is in an invalid state.
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.
400	OperationFailed.ZoneNotSupportJumbo	The following zones do not support Jumbo Frame: %s.	Failed to enable jumbo frames. Zone %s used by the current transit router does not support jumbo frames.
400	OperationFailed.TransitRouterNotSupportJumbo	This transit router does not support Jumbo Frame in available zones: %s. Please contact Alibaba Cloud support for assistance.	The transit router does not support jumbo frames in zone %s. Contact Alibaba Cloud for support.
400	ParamExclusive.SupportJumboFrameAndSupportMulticast	Transit Router can not support JumboFrame and Multicast at the same time.	Transit Router can not support JumboFrame and Multicast at the same time.
400	OperationUnsupported.MulticastAndJumboFrameAreExclusive	The operation is not supported because the multicast and jumbo frame are exclusive.	The forwarding router cannot enable the multicast and jumbo frame functions at the same time.
400	OperationUnsupported.SupportJumboFrame	JumboFrame is unsupported.	JumboFrame is unsupported.
400	OperationUnsupported.DisableJumboFrame	Disable JumboFrame is not supported.	Disable JumboFrame is not supported.
400	InvalidParameter.TransitRouterId	The specified parameter TransitRouterId is invalid.	The parameter TransitRouterId entered is illegal.
404	Instance.NotExist	The instance is not exist.	The error message returned because the specified instance does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.