Query transit router CIDR blocks using ListTransitRouterCidr - Cloud Enterprise Network - Alibaba Cloud - Cloud Enterprise Network

Queries information about CIDR blocks of a transit router by calling the ListTransitRouterCidr operation.

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

get

*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-p0w3x8c9em72a40nw****
TransitRouterCidrId	string	No	The ID of the transit router CIDR block.	cidr-0zv0q9crqpntzz****
RegionId	string	Yes	The ID of the region where the transit router instance is deployed. You can call the DescribeChildInstanceRegions operation to query region IDs.	cn-hangzhou
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run without querying the CIDR blocks added to the transit router. The system checks the required parameters, request syntax, and business restrictions. If the check fails, the corresponding error is returned. If the check succeeds, the error code `DryRunOperation` is returned. false (default): performs a dry run and sends the request. After the request passes the dry run, the CIDR blocks added to the transit router are queried.	false

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	0876E54E-3E36-5C31-89F0-9EE8A9266F9A
CidrLists	array<object>	The list of transit router CIDR blocks.
	object	The information about the transit router CIDR block.
TransitRouterCidrId	string	The ID of the transit router CIDR block.	cidr-0zv0q9crqpntzz****
Family	string	The type of the transit router CIDR block. The value is IPv4 only, which indicates that the transit router CIDR block is of the IPv4 type.	IPv4
Name	string	The name of the transit router CIDR block.	nametest
Description	string	The description of the transit router CIDR block.	desctest
Cidr	string	The transit router CIDR block.	192.168.10.0/24
PublishCidrRoute	boolean	Indicates whether the system is allowed to automatically add a route for the transit router CIDR block to the transit router route table. true: allowed. If the value of this parameter is true, 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 gateway IP addresses have been allocated to the IPsec connection. The blackhole route is propagated only to the route tables of VBR instances associated with the transit router. false: not allowed.	true
TransitRouterId	string	The ID of the transit router instance.	tr-p0w3x8c9em72a40nw****

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
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.