Query transit router CIDR block allocation details with ListTransitRouterCidrAllocation - Cloud Enterprise Network - Alibaba Cloud - Cloud Enterprise Network

Queries the allocation information of a CIDR block by calling the ListTransitRouterCidrAllocation 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:ListTransitRouterCidrAllocation

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 forward router instance ID.	tr-p0w3x8c9em72a40nw****
RegionId	string	Yes	The region ID of the transit router instance. You can call the DescribeChildInstanceRegions operation to query region IDs.	cn-hangzhou
TransitRouterCidrId	string	No	The ID of the transit router CIDR block. You can call the ListTransitRouterCidr operation to query the transit router CIDR block ID.	cidr-0zv0q9crqpntzz****
CidrBlock	string	No	The allocated CIDR block under the transit router CIDR block.	192.168.10.0/28
Cidr	string	No	The transit router CIDR block.	192.168.10.0/24
DedicatedOwnerId	string	No	The dedicated CIDR block. Set the value to VPN, which specifies that you want to query the CIDR block reserved by the system for creating VPN connections in the backend.	VPN
AttachmentId	string	No	The ID of the network instance connection.	tr-attach-2nalp6yksc805w****
AttachmentName	string	No	The name of the network instance connection.	nametest
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run. The system checks the required parameters, request syntax, and business restrictions. If the request fails the dry run, the corresponding error is returned. If the request passes the dry run, the error code `DryRunOperation` is returned. false (default): performs a dry run and sends the request. If the request passes the dry run, the transit router CIDR block allocation details are queried.	false
MaxResults	integer	No	The number of entries per page. If you do not specify a value for MaxResults, it indicates that you do not need to query results by page. The value of MaxResults in the response indicates the total number of entries. If you specify a value for MaxResults, it indicates that you need to query results by page. Valid values: 1 to 100. We recommend that you set MaxResults to 20. The value of MaxResults in the response indicates the number of entries on the current page.	20
NextToken	string	No	The pagination token that is used in the next request to retrieve a new page of results. Valid values: You do not need to specify this parameter for the first request or if no subsequent request exists. If a subsequent request exists, set the value to the NextToken value returned in the previous API call.	FFmyTO70tTpLG6I3FmYAXGKPd****

Response elements

Element	Type	Description	Example
	object	The response parameters.
NextToken	string	The pagination token that is used in the next request to retrieve a new page of results. Valid values: If NextToken is empty, no subsequent request exists. If NextToken is returned, the value indicates the token that is used for the next query.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	The request ID.	0876E54E-3E36-5C31-89F0-9EE8A9266F9A
TotalCount	integer	The total number of entries returned.	1
MaxResults	integer	The number of entries per page. If you did not specify the MaxResults request parameter, it indicates that you did not need to query results by page. The value of MaxResults in the response indicates the total number of entries. If you specified the MaxResults request parameter, it indicates that you needed to query results by page. The value of MaxResults in the response indicates the number of entries on the current page.	1
TransitRouterCidrAllocations	array<object>	The allocation details of the transit router CIDR block.
	object	The allocation details of the transit router CIDR block.
TransitRouterCidrId	string	The ID of the transit router CIDR block.	cidr-0zv0q9crqpntzz****
AllocatedCidrBlock	string	The allocated CIDR block under the transit router CIDR block.	192.168.10.0/28
AttachmentId	string	The ID of the network instance connection.	tr-attach-2nalp6yksc805w****
Cidr	string	The transit router CIDR block.	192.168.10.0/24
AttachmentName	string	The name of the network instance connection.	nametest

Examples

Success response

JSON format

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "0876E54E-3E36-5C31-89F0-9EE8A9266F9A",
  "TotalCount": 1,
  "MaxResults": 1,
  "TransitRouterCidrAllocations": [
    {
      "TransitRouterCidrId": "cidr-0zv0q9crqpntzz****",
      "AllocatedCidrBlock": "192.168.10.0/28",
      "AttachmentId": "tr-attach-2nalp6yksc805w****",
      "Cidr": "192.168.10.0/24",
      "AttachmentName": "nametest"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.NextToken	The parameter NextToken is invalid.	The error message returned because the NextToken parameter is set to an invalid value. Check the value and try again.
400	IllegalParam.TransitRouterId	The parameter TransitRouterId or RegionId is invalid.	The TransitRouterId or RegionId parameter is invalid.
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.