ModifyTransitRouterCidr - Cloud Enterprise Network - Alibaba Cloud Documentation Center

You can call the ModifyTransitRouterCidr operation to modify a CIDR block of a transit router.

Operation description

Before you modify a CIDR block of a transit router, review the Limits on transit router CIDR blocks.
You cannot modify a CIDR block if IP addresses have already been allocated from it.
The ModifyTransitRouterCidr operation is synchronous if you do not change the PublishCidrRoute parameter. The modification takes effect immediately.
The ModifyTransitRouterCidr operation is asynchronous if you change the PublishCidrRoute parameter. The system returns a RequestId, but the CIDR block is not immediately modified. The modification task runs in the background. You can call the ListTransitRouterCidr operation to query the status of the modification.
- If the CIDR block information has not changed, the modification is in progress.
- If the CIDR block information is updated, 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 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: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. Generate a client token to make sure that the token is unique for each request. The token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the request ID as the client token. The request ID is different for each 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 CIDR block. Call the ListTransitRouterCidr operation to query the ID of the CIDR block.	cidr-0zv0q9crqpntzz****
RegionId	string	Yes	The ID of the region where the Transit Router instance is deployed. Call the DescribeChildInstanceRegions operation to query region IDs.	cn-hangzhou
Name	string	No	The new name of the CIDR block. The name can be empty or 1 to 128 characters in length. It cannot start with http:// or https://.	nametest
Description	string	No	The new description of the CIDR block. The description can be empty or 1 to 256 characters in length. It cannot start with http:// or https://.	desctest
Cidr	string	No	The new CIDR block.	192.168.10.0/24
DryRun	boolean	No	Specifies whether to perform a dry run. The valid values are: true: Sends a check request but does not modify the CIDR block. The system checks the required parameters, request format, and service limits. If the request fails the check, the corresponding error is returned. If the request passes the check, the `DryRunOperation` error code is returned. false (default): Sends a normal request. The CIDR block is modified after the request passes the check.	false
PublishCidrRoute	boolean	No	Specifies whether to automatically add a route that points to the CIDR block to the route table of the transit router. true: Yes. This blackhole route is advertised only to the route tables of virtual border routers (VBRs) that are attached to the transit router. false: No.	true

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.