All Products
Search

This Product

    Cloud Enterprise Network:ModifyTransitRouterCidr

    Document Center

    Cloud Enterprise Network:ModifyTransitRouterCidr

    Last Updated:Oct 22, 2024

    Modifies the CIDR block of a transit router.

    Operation description

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

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • 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 Key: the condition key that is defined by the cloud service.
    • 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.
    OperationAccess levelResource typeCondition keyAssociated operation
    cen:ModifyTransitRouterCidrupdate
    • TransitRouter
      acs:cen:*:{#accountId}:centransitrouter/{#centransitrouterId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    ClientTokenstringNo

    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 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 may be different for each request.
    		123e4567-e89b-12d3-a456-426****
    TransitRouterIdstringYes

    The ID of the transit router.

    		tr-gw8ergozrv77rtbjd****
    TransitRouterCidrIdstringYes

    The ID of the CIDR block.

    You can call the ListTransitRouterCidr operation to query the ID of a CIDR block.

    		cidr-0zv0q9crqpntzz****
    RegionIdstringYes

    The ID of the region where the transit router is deployed.

    You can call the DescribeChildInstanceRegions operation to query the most recent region list.

    		cn-hangzhou
    NamestringNo

    The new name of the transit router CIDR block.

    The name must be 1 to 128 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.

    		nametest
    DescriptionstringNo

    The new description of the transit router CIDR block.

    The description must be 1 to 256 characters in length, and cannot start with http:// or https://. You can also leave this parameter empty.

    		desctest
    CidrstringNo

    The new CIDR block of the transit router.

    		192.168.10.0/24
    DryRunbooleanNo

    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: performs a dry run and sends the request.
    		false
    PublishCidrRoutebooleanNo

    Specifies whether to allow the system to automatically add a route that points to the CIDR block to the route table of the transit router. Valid values:

    • true

      If you specify true, create a private VPN connection, and enable route learning for the VPN connection, the system automatically adds the following route to the transit router route table that is in route learning relationship with the VPN connection: a blackhole route whose destination CIDR block is the CIDR block of the transit router. The CIDR block of the transit router refers to the CIDR block from which IP addresses of IPsec-VPN connections are allocated. The blackhole route is advertised only to the route tables of virtual border routers (VBRs) connected to the transit router.

    • false

    		true

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response.

    RequestIdstring

    The ID of the request.

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

    Examples

    Sample success responses

    JSONformat

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

    Error codes

    HTTP status codeError codeError messageDescription
    400IllegalParam.CidrCidr is illegal.The error message returned because the specified CIDR block is invalid.
    400OperationFailed.CidrBlockAllocatedCidr 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.
    400OperationFailed.CidrNotExistcidr is not exist.The error message returned because the specified CIDR block does not exist.
    400InvalidParameterInvalid parameter.The error message returned because the parameter is set to an invalid value.
    400UnauthorizedThe AccessKeyId is unauthorized.The error message returned because you do not have the permissions to perform this operation.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-01-19The Error code has changedView Change Details