All Products
Search

This Product

    Cloud Enterprise Network:ModifyTransitRouterCidr

    Document Center

    Cloud Enterprise Network:ModifyTransitRouterCidr

    Last Updated:Jan 11, 2023

    Modifies the CIDR block of a transit router.

    Operation Description

    Usage notes

    • Before you modify the CIDR block of a transit router, we recommend that you read the limits on transit router CIDR blocks.

    • If IP addresses within the CIDR block have been allocated to network instances, you cannot modify the CIDR block.

    • When you call ModifyTransitRouterCidr, if no parameter of the PublishCidrRoute operation is modified, ModifyTransitRouterCidr is a synchronous operation. After you call the operation, the new settings are immediately applied.

    • If a parameter of the PublishCidrRoute operation is modified, ModifyTransitRouterCidr is an asynchronous operation. After you call the operation, the request ID (RequestId) is returned but the operation is still being performed in the system background. You can call ListTransitRouterCidr to query the status of the CIDR block of the transit router.

      • If the CIDR block of the transit router remains unchanged, the CIDR block is still being modified.
      • If the CIDR block of the transit router is changed to the one that you specify in the request, the CIDR block has been modified.

    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:ModifyTransitRouterCidr Read
    • CEN
      acs:cen:*:{#accountId}:centransitrouter/{#centransitrouterId}
      without
    		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.

    Note If you do not set this parameter, ClientToken is set to the value of RequestId. The value of RequestId for each API request may be different.
    		123e4567-e89b-12d3-a456-426****
    TransitRouterId string Yes

    The ID of the transit router.

    		 tr-gw8ergozrv77rtbjd****
    TransitRouterCidrId string Yes

    The ID of the transit router CIDR block.

    You can call ListTransitRouterCidr to query the ID of a transit route 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 most recent region list.

    		 ap-southeast-2
    Name string No

    The new name of the transit router CIDR block.

    The name must be 1 to 128 characters in length.

    		 nametest
    Description string No

    The new description of the transit router CIDR block.

    The description must be 1 to 256 characters in length.

    		 desctest
    Cidr string No

    The new CIDR block of the transit router.

    		 192.168.10.0/24
    DryRun boolean No

    Specifies whether only to precheck the request. Valid values:

    • true: checks the request but does not modify the CIDR block. The system checks the required parameters, the request format, and the service limits. If the request fails to pass the precheck, an error message is returned. If the request passes the precheck, the DryRunOperation error code is returned.
    • false: sends the request. If the request passes the precheck, the CIDR block of the transit router is modified.
    		 false
    PublishCidrRoute boolean No

    Specifies whether to allow the system to automatically add routes that point to the CIDR block to the route table of the transit router.

    • true: yes

      A value of true specifies that after you create a private VPN connection and enable route learning for the connection, the system automatically adds a blackhole route to the route table of the transit route to which the VPN connection is attached.

      The destination CIDR block of the blackhole route is the CIDR block of the transit router. The CIDR block of the transit router refers to the CIDR block from which gateway IP addresses are allocated to IPsec-VPN connections.

      The blackhole route is advertised only to the route table of the virtual border router (VBR) that is connected to the transit router.

    • false: no

    		 true

    Response parameters

    Parameter Type Description Example
    object
    RequestId string

    The ID of the request.

    		 0876E54E-3E36-5C31-89F0-9EE8A9266F9A

    Example

    Normal return example

    JSONFormat

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

    Error codes

    For a list of error codes, visit the API error center.