Use ModifyTransitRouterCidr to modify a CIDR block of a transit router - Cloud Enterprise Network - Alibaba Cloud - Cloud Enterprise Network

Calls the ModifyTransitRouterCidr operation to modify a CIDR block of a transit router.

Operation description

Before you modify a transit router CIDR block, we recommend that you familiarize yourself with the usage limits of transit router CIDR blocks.
A transit router CIDR block from which IP addresses have been allocated cannot be modified.
If you call the ModifyTransitRouterCidr operation without modifying the PublishCidrRoute parameter, this operation is synchronous and the modification takes effect immediately.
If you call the ModifyTransitRouterCidr operation and modify the PublishCidrRoute parameter, this operation is asynchronous. After you send a request, the system returns a RequestId but the transit router CIDR block is not modified. The modification task runs in the background. You can call the ListTransitRouterCidr operation to query the modification status of the transit router CIDR block.
- If the transit router CIDR block still shows the information before the modification, the modification is in progress.
- If the transit router CIDR block shows the updated information, the modification is successful.

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:ModifyTransitRouterCidr

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 client token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	123e4567-e89b-12d3-a456-426****
TransitRouterId	string	Yes	The ID of the transit router instance.	tr-gw8ergozrv77rtbjd****
TransitRouterCidrId	string	Yes	The ID of the transit router CIDR block. You can call the ListTransitRouterCidr operation to query the ID of the transit router CIDR block.	cidr-0zv0q9crqpntzz****
RegionId	string	Yes	The ID of the region where the transit router is deployed. You can call the DescribeChildInstanceRegions operation to query the region ID.	cn-hangzhou
Name	string	No	The new name of the transit router CIDR block. The name can be empty or 1 to 128 characters in length, and cannot start with http:// or https://.	nametest
Description	string	No	The new description of the transit router CIDR block. The description can be empty or 1 to 256 characters in length, and cannot start with http:// or https://.	desctest
Cidr	string	No	The new CIDR block of the transit router.	192.168.10.0/24
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run. The system checks the required parameters, request syntax, and limits. If the request fails the dry run, an error message is returned. If the request passes the dry run, the `DryRunOperation` error code is returned. false (default): performs a dry run and sends the request. If the request passes the dry run, the transit router CIDR block is modified.	false
PublishCidrRoute	boolean	No	Specifies whether to allow the system to automatically add a route for the transit router CIDR block to the transit router route table. true: allowed. If you select allowed, after you create a VPN connection of the private gateway type and create a route learning relationship for the VPN connection, the system automatically adds a route entry to the transit router route table that has a route learning relationship with the VPN connection. The route entry is a blackhole route whose destination CIDR block is the transit router CIDR block from which IP addresses are allocated to the IPsec connection. The blackhole route is propagated only to the route tables of VBR instances attached to the transit router. false: not allowed.	true

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	0876E54E-3E36-5C31-89F0-9EE8A9266F9A

Examples

Success response

JSON format

{
  "RequestId": "0876E54E-3E36-5C31-89F0-9EE8A9266F9A"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.Cidr	Cidr is illegal.	The error message returned because the specified CIDR block is invalid.
400	OperationFailed.CidrBlockAllocated	Cidr blocks are allocated from the cidr, which should be released first.	The error message returned because the specified CIDR block is already occupied. Release the resources that occupy the CIDR block and try again.
400	OperationFailed.CidrNotExist	cidr is not exist.	The error message returned because the specified CIDR block does not exist.
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	InvalidParameter.TransitRouterCidrId	The specified parameter TransitRouterCidrId is invalid.	The parameter TransitRouterCidrId entered is illegal.
400	InvalidParameter.TransitRouterId	The specified parameter TransitRouterId is invalid.	The parameter TransitRouterId entered is illegal.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.