ListTransitRouterCidrAllocation - Cloud Enterprise Network

Queries how a CIDR block is allocated.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
cen:ListTransitRouterCidrAllocation	get	TransitRouter acs:cen:*:{#accountId}:centransitrouter/{#centransitrouterId}	none	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 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****
TransitRouterId	string	Yes	The ID of the transit router.	tr-p0w3x8c9em72a40nw****
RegionId	string	Yes	The region ID of the transit router. You can call the DescribeChildInstanceRegions operation to query the most recent region list.	cn-hangzhou
TransitRouterCidrId	string	No	The ID of the CIDR block. You can call the ListTransitRouterCidr operation to query the ID of a CIDR block.	cidr-0zv0q9crqpntzz****
CidrBlock	string	No	The CIDR blocks that have IP addresses allocated to network instances.	192.168.10.0/28
Cidr	string	No	The CIDR block of the transit router.	192.168.10.0/24
DedicatedOwnerId	string	No	The CIDR block that is for exclusive use. Set the value to VPN, which specifies the CIDR block that is reserved for VPN connections.	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 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 (default): performs a dry run and sends the request.	false
MaxResults	integer	No	The number of entries per page. If you do not specify a value for MaxResults, entries are returned in one response. After you send the request, the value of MaxResults includes all entries. If you specify a value for MaxResults, entries are returned in batches. Valid values: 1 to 100. We recommend that you set MaxResults to 20. The value of MaxResults in the response indicates that number of entries in the current batch.	20
NextToken	string	No	The token that determines the start point of the query. Valid values: If this is your first query or no subsequent query is to be sent, ignore this parameter. If a subsequent query is to be sent, set the value to the value of NextToken that is returned from the last call.	FFmyTO70tTpLG6I3FmYAXGKPd****

Response parameters

Parameter	Type	Description	Example
	object	The response.
NextToken	string	The token that determines the start point of the next query. Valid values: If NextToken was not returned, it indicates that no additional results exist. If NextToken was returned in the previous query, specify the value to obtain the next set of results.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	The ID of the request.	0876E54E-3E36-5C31-89F0-9EE8A9266F9A
TotalCount	integer	The total number of entries returned.	1
MaxResults	integer	The number of entries returned per page. If no value is specified for MaxResults, query results are returned in one batch. The value of MaxResults indicates the total number of entries. If a value is specified for MaxResults, query results are returned in batches. The value of MaxResults in the response indicates the number of entries in the current batch.	1
TransitRouterCidrAllocations	array<object>	The information about the CIDR blocks that have IP addresses allocated to network instances.
TransitRouterCidrAllocation	object	The information about the CIDR blocks that have IP addresses allocated to network instances.
TransitRouterCidrId	string	The ID of the CIDR block.	cidr-0zv0q9crqpntzz****
AllocatedCidrBlock	string	The CIDR blocks that have IP addresses allocated to network instances.	192.168.10.0/28
AttachmentId	string	The ID of the network instance connection.	tr-attach-2nalp6yksc805w****
Cidr	string	The CIDR block of the transit router.	192.168.10.0/24
AttachmentName	string	The name of the network instance connection.	nametest

Examples

Sample success responses

JSONformat

{
  "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.	-
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.

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

Change history

Change time	Summary of changes	Operation
2023-08-04	The Error code has changed	View Change Details