All Products
Search
Document Center

Cloud Enterprise Network:ListTransitRouterPrefixListAssociation

Last Updated:Oct 22, 2024

Queries the prefix lists that are associated with an Enterprise Edition transit router.

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.

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:ListTransitRouterPrefixListAssociationget
  • TransitRouterRouteTable
    acs:cen:*:{#accountId}:centransitrouterroutetable/{#centransitrouterroutetableId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The ID of the region where the transit router is deployed.

You can call the DescribeChildInstanceRegions operation to query the most recent region list.

cn-hangzhou
TransitRouterIdstringYes

The ID of the transit router.

tr-6ehx7q2jze8ch5ji0****
TransitRouterTableIdstringNo

The ID of the route table of the transit router.

vtb-6ehgc262hr170qgyc****
PrefixListIdstringNo

The ID of the prefix list.

pl-6ehtn5kqxgeyy08fi****
OwnerUidlongNo

The ID of the Alibaba Cloud account to which the prefix list belongs.

1210123456123456
PageNumberintegerNo

The number of the page to return. Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page. Maximum value: 100. Default value: 10.

10
NextHopstringNo

The ID of the next hop.

Note Set the value to BlackHole if you want to query the prefix list that generates blackhole routes.
tr-attach-flbq507rg2ckrj****
NextHopTypestringNo

The type of the next hop. Valid values:

  • BlackHole: The prefix list that generates blackhole routes.
  • VPC: The prefix list whose next hop is a virtual private cloud (VPC) connection.
  • VBR: The prefix list whose next hop is a virtual border router (VBR) connection.
  • TR: The prefix list whose next hop is an inter-region connection on the transit router.
VPC
NextHopInstanceIdstringNo

The ID of the network instance associated with the next hop connection.

vpc-6eh7fp9hdqa2wv85t****
StatusstringNo

The status of the prefix list. Valid values:

  • Active
  • Updating
Active

Response parameters

ParameterTypeDescriptionExample
object

The response.

RequestIdstring

The ID of the request.

6005CA94-676E-1FEE-985E-7602EFAADD6A
TotalCountinteger

The total number of entries returned.

1
PageSizeinteger

The number of entries returned per page.

10
PageNumberinteger

The page number of the returned page.

1
PrefixListsarray<object>

A list of prefix lists.

PrefixListobject

The information about the prefix list.

PrefixListIdstring

The ID of the prefix list.

pl-6ehtn5kqxgeyy08fi****
OwnerUidlong

The ID of the Alibaba Cloud account to which the prefix list belongs.

1210123456123456
Statusstring

The status of the prefix list. Valid values:

  • Active: The prefix list is effective.
  • Updating: The prefix list is being updated.
Active
NextHopstring

The ID of the next hop.

Note A value of BlackHole indicates that all the CIDR blocks in the prefix list are blackhole routes. Packets destined for the CIDR blocks are dropped.
tr-attach-flbq507rg2ckrj****
NextHopInstanceIdstring

The ID of the network instance associated with the next hop connection.

vpc-6eh7fp9hdqa2wv85t****
NextHopTypestring

The type of the next hop. Valid values:

  • BlackHole: All the CIDR blocks in the prefix list are blackhole routes. Packets destined for the CIDR blocks are dropped.
  • VPC: The next hop of the CIDR blocks in the prefix list is a VPC connection.
  • VBR: The next hop of the CIDR blocks in the prefix list is a VBR connection.
  • TR: The next hop of the CIDR blocks in the prefix list is an inter-region connection.
VPC
TransitRouterTableIdstring

The ID of the route table of the transit router.

vtb-6ehgc262hr170qgyc****
TransitRouterIdstring

The ID of the transit router.

tr-6ehx7q2jze8ch5ji0****

Examples

Sample success responses

JSONformat

{
  "RequestId": "6005CA94-676E-1FEE-985E-7602EFAADD6A",
  "TotalCount": 1,
  "PageSize": 10,
  "PageNumber": 1,
  "PrefixLists": [
    {
      "PrefixListId": "pl-6ehtn5kqxgeyy08fi****",
      "OwnerUid": 1210123456123456,
      "Status": "Active",
      "NextHop": "tr-attach-flbq507rg2ckrj****",
      "NextHopInstanceId": "vpc-6eh7fp9hdqa2wv85t****",
      "NextHopType": "VPC",
      "TransitRouterTableId": "vtb-6ehgc262hr170qgyc****",
      "TransitRouterId": "tr-6ehx7q2jze8ch5ji0****"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalParam.RegionThe specified Region is invalid.The error message returned because the specified region is invalid.
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
2022-10-27The Error code has changed. The request parameters of the API has changedView Change Details
2022-09-23The Error code has changed. The response structure of the API has changedView Change Details