UpdateTransitRouter - Cloud Enterprise Network - Alibaba Cloud Documentation Center

Operation description

UpdateTransitRouter is an asynchronous operation. After you send a request, the system returns a RequestId. The TransitRouter instance is not immediately modified because the modification task runs in the background. You can call the ListTransitRouters operation to query the status of the TransitRouter instance.

If a TransitRouter instance is in the Modifying state, the instance is being modified. In this state, you can only query the instance. You cannot perform other operations.
If a TransitRouter instance is in the Active state, the modification is complete.

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 support 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. Generate a client token to make sure that the value is unique among different requests. The client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the request as the ClientToken. The RequestId of each request is unique.	02fb3da4-130e-11e9-8e44-001****
DryRun	boolean	No	Specifies whether to perform a dry run. A dry run checks permissions and the status of the instance. Valid values: false (default): Sends a normal request. After the request passes the check, the information about the TransitRouter instance is modified. true: Sends a check request. The system checks the request for required parameters and format correctness, but does not modify the TransitRouter instance. If the check fails, an error is returned. If the check passes, the request ID is returned.	false
RegionId	string	Yes	The ID of the region where the TransitRouter instance is deployed. Call the DescribeRegions operation to query region IDs.	cn-shanghai
TransitRouterId	string	Yes	The ID of the TransitRouter instance.	tr-uf654ttymmljlvh2x****
TransitRouterName	string	No	The new name for the TransitRouter instance. The name can be empty or 1 to 128 characters in length. The name cannot start with http:// or https://.	testname
TransitRouterDescription	string	No	The new description of the TransitRouter instance. The description can be empty or 1 to 256 characters in length. The description cannot start with http:// or https://.	testdesc

Response parameters

Parameter	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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.