All Products
Search
Document Center

Cloud Enterprise Network:ListTransitRouterRouteTableAssociations

Last Updated:Mar 01, 2024

Queries the associated forwarding correlations that are created for a route table of an Enterprise Edition transit router or a network instance connection.

Operation description

When you call ListTransitRouterRouteTableAssociations, you must set at least one of TransitRouterRouteTableId and TransitRouterAttachmentId.

  • If you set only TransitRouterRouteTableId, the network instance connections that are in associated forwarding correlation with a route table of an Enterprise Edition transit router are queried.

  • If you set only TransitRouterAttachmentId, the route table of an Enterprise Edition transit router that is in associated forwarding correlation with a network instance connection is queried.

  • If you set both TransitRouterRouteTableId and TransitRouterAttachmentId, the associated forwarding correlations between a specified network instance connection and a specified route table of an Enterprise Edition transit router are queried.

    • If an associated forwarding correlation is created between the network instance connection and the route table of the Enterprise Edition transit router, the information about the associated forwarding correlation is returned.
    • If no associated forwarding correlation is created between the network instance connection and the route table of the Enterprise Edition transit router, TransitRouterAssociations in the response is empty.

Debugging

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
cen:ListTransitRouterRouteTableAssociationsRead
  • TransitRouterPeerAttachment
    acs:cen:*:{#accountId}:centransitrouterattachment/{#centransitrouterattachmentId}
  • TransitRouterRouteTable
    acs:cen:*:{#accountId}:centransitrouterroutetable/{#TransitRouterRouteTableId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
MaxResultsintegerNo

The number of entries to return on each page. Default value: 50.

50
NextTokenstringNo

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 next query is to be sent, set the value to the value of NextToken that is returned from the last call.
a415****
TransitRouterRouteTableIdstringNo

The ID of the route table of the Enterprise Edition transit router.

vtb-bp1dudbh2d5na6b50****
TransitRouterAttachmentIdstringNo

The ID of the network instance connection.

tr-attach-nls9fzkfat8934****
TransitRouterAttachmentResourceIdstringNo

The ID of the next hop.

vpc-bp1h8vbrbcgohcju5****
TransitRouterAttachmentResourceTypestringNo

The type of next hop. Valid values:

  • VPC: virtual private cloud (VPC)
  • VBR: virtual border router (VBR)
  • TR: transit router
  • VPN: VPN attachment
VPC
StatusstringNo

The status of the associated forwarding correlation. Valid values:

  • Active: The associated forwarding correlation is available.
  • Associating: The associated forwarding correlation is being created.
  • Dissociating: The associated forwarding correlation is being deleted.
Active

Response parameters

ParameterTypeDescriptionExample
object

The response.

NextTokenstring

The token that determines the start point of the 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.
a415****
RequestIdstring

The ID of the request.

F6B1D9AB-176D-4399-801D-8BC576F4EB0D
TotalCountinteger

The total number of entries returned.

1
MaxResultsinteger

The number of entries returned per page.

50
TransitRouterAssociationsobject []

A list of associated forwarding correlations.

TransitRouterAttachmentIdstring

The ID of the network instance connection.

tr-attach-nls9fzkfat8934****
Statusstring

The status of the associated forwarding correlation. Valid values:

  • Active: The associated forwarding correlation is available.
  • Associating: The associated forwarding correlation is being created.
  • Dissociating: The associated forwarding correlation is being deleted.
  • Deleted: The associated forwarding correlation is deleted.
Associating
ResourceTypestring

The type of next hop. Valid values:

  • VPC: VPC
  • VBR: VBR
  • TR: transit router
  • VPN :VPN attachment
VPC
ResourceIdstring

The ID of the next hop.

vpc-bp1h8vbrbcgohcju5****
TransitRouterRouteTableIdstring

The ID of the route table of the Enterprise Edition transit router.

vtb-bp1dudbh2d5na6b50****

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
400IllegalParam.NextTokenThe parameter NextToken is invalid.The error message returned because the NextToken parameter is set to an invalid value. Check the value and try again.
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-08-04The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    Error Codes 400 change
2023-01-06The Error code has changed. The request parameters of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: TransitRouterAttachmentResourceId
    Added Input Parameters: TransitRouterAttachmentResourceType
    Added Input Parameters: Status
2022-10-27The Error code has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400