Call ListTransitRouterRouteTableAssociations to query forwarding associations - Cloud Enterprise Network - Alibaba Cloud - Cloud Enterprise Network

Queries the route association relationships created for an Enterprise Edition transit router route table or a network instance connection.

Operation description

When you call the ListTransitRouterRouteTableAssociations operation, specify at least one of the request parameters TransitRouterRouteTableId and TransitRouterAttachmentId:

If you specify only the TransitRouterRouteTableId parameter, the system queries the network instance connections that have route association relationships with the specified Enterprise Edition transit router route table.
If you specify only the TransitRouterAttachmentId parameter, the system queries the Enterprise Edition transit router route tables that have route association relationships with the specified network instance connection.
If you specify both the TransitRouterRouteTableId and TransitRouterAttachmentId parameters, the system queries the route association relationship between the specified network instance connection and the specified Enterprise Edition transit router route table.
- If a route association relationship exists between the network instance connection and the Enterprise Edition transit router route table, the system returns the information about the route association relationship.
- If no route association relationship exists between the network instance connection and the Enterprise Edition transit router route table, the TransitRouterAssociations array is empty.

When you call the ListTransitRouterRouteTableAssociations operation, make sure that the parameter values you specify are correct. If you specify incorrect parameter values, the system still returns a RequestId but does not return the route association relationships created for the Enterprise Edition transit router route table or network instance connection.

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

get

TransitRouterPeerAttachment

acs:cen:*:{#accountId}:centransitrouterattachment/{#centransitrouterattachmentId}

TransitRouterRouteTable

acs:cen:*:{#accountId}:centransitrouterroutetable/{#TransitRouterRouteTableId}

None

Request parameters

Parameter	Type	Required	Description	Example
MaxResults	integer	No	The number of entries per page for a paged query. Default value: 50.	50
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 query exists. If a subsequent query exists, set the value to the NextToken value returned by the previous API call.	a415****
TransitRouterRouteTableId	string	No	The ID of the Enterprise Edition transit router route table.	vtb-bp1dudbh2d5na6b50****
TransitRouterAttachmentId	string	No	The ID of the network instance connection.	tr-attach-nls9fzkfat8934****
TransitRouterAttachmentResourceId	string	No	The ID of the next hop resource.	vpc-bp1h8vbrbcgohcju5****
TransitRouterAttachmentResourceType	string	No	The type of the next hop resource. Valid values: VPC: virtual private cloud (VPC) instance. VBR: virtual border router (VBR) instance. TR: transit router instance. VPN: VPN connection.	VPC
Status	string	No	The status of the route association. Valid values: Active: active. Associating: being associated. Dissociating: being dissociated.	Active

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 query exists. If NextToken is returned, the value indicates the token for the next query.	a415****
RequestId	string	The request ID.	F6B1D9AB-176D-4399-801D-8BC576F4EB0D
TotalCount	integer	The total number of entries returned.	1
MaxResults	integer	The number of entries per page for a paged query.	50
TransitRouterAssociations	array<object>	The list of route association relationships.
	object	The information about a route association relationship.
TransitRouterAttachmentId	string	The ID of the network instance connection.	tr-attach-nls9fzkfat8934****
Status	string	The status of the route association. Valid values: Active: active. Associating: being associated. Dissociating: being dissociated. Deleted: deleted.	Associating
ResourceType	string	The type of the next hop resource. Valid values: VPC: virtual private cloud (VPC) instance. VBR: virtual border router (VBR) instance. TR: transit router instance. VPN: VPN connection.	VPC
ResourceId	string	The ID of the next hop resource.	vpc-bp1h8vbrbcgohcju5****
TransitRouterRouteTableId	string	The ID of the Enterprise Edition transit router route table.	vtb-bp1dudbh2d5na6b50****

Examples

Success response

JSON format

{
  "NextToken": "a415****",
  "RequestId": "F6B1D9AB-176D-4399-801D-8BC576F4EB0D",
  "TotalCount": 1,
  "MaxResults": 50,
  "TransitRouterAssociations": [
    {
      "TransitRouterAttachmentId": "tr-attach-nls9fzkfat8934****",
      "Status": "Associating",
      "ResourceType": "VPC",
      "ResourceId": "vpc-bp1h8vbrbcgohcju5****",
      "TransitRouterRouteTableId": "vtb-bp1dudbh2d5na6b50****"
    }
  ]
}

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.MaxResults	The specified MaxResults is illegal.	MaxResults illegal.
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.