All Products
Document Center

Cloud Enterprise Network:ListTransitRouterCidr

Last Updated:Apr 03, 2024

Queries the CIDR blocks of a transit router.


OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

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

Request parameters


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. The token 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 may be different for each request.

The ID of the transit router.


The ID of the CIDR block.


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

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


Specifies whether only to precheck the API request. Valid values:

  • true: prechecks the request but does not query the CIDR block. The system checks the required parameters, the request format, and the service limits. If the request fails the check, an error message is returned. If the request passes the check, the DryRunOperation error code is returned.
  • false (default): sends the request. After the request passes the check, the operation is performed.

Response parameters


The response parameters.


The ID of the request.

CidrListsobject []

The information about the CIDR block.


The ID of the transit router CIDR block.


The type of the CIDR block.

The value is IPv4, which indicates that the CIDR block is of the IPv4 type.


The name of the CIDR block.


The description of the CIDR block.


The CIDR block of the transit router.

Indicates whether the system is allowed to automatically add a route to the route table of the transit router. Valid values:

  • true

    A value of true indicates 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 router 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


The transit router ID.



Sample success responses


  "RequestId": "0876E54E-3E36-5C31-89F0-9EE8A9266F9A",
  "CidrLists": [
      "TransitRouterCidrId": "cidr-0zv0q9crqpntzz****",
      "Family": "IPv4",
      "Name": "nametest",
      "Description": "desctest",
      "Cidr": "",
      "PublishCidrRoute": true,
      "TransitRouterId": "tr-p0w3x8c9em72a40nw****"

Error codes

HTTP status codeError codeError messageDescription
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
2023-01-04The internal configuration of the API is changed, but the call is not affectedsee changesets
Change itemChange content
The internal configuration of the API is changed, but the call is not affected.