All Products
Search
Document Center

Cloud Enterprise Network:ListTransitRouterPeerAttachments

Last Updated:Mar 25, 2024

Queries inter-region connections on an Enterprise Edition transit router.

Operation description

You can use the following methods to query inter-region connections on an Enterprise Edition transit router:

  • Query all inter-region connections on an Enterprise Edition transit router by specifying the ID of the Enterprise Edition transit router.
  • Query all inter-region connections on an Enterprise Edition transit router by specifying the ID of the Cloud Enterprise Network (CEN) instance and the ID of the region where the transit router is deployed.

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:ListTransitRouterPeerAttachmentsRead
  • CenInstance
    acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}
  • TransitRouterPeerAttachment
    acs:cen:*:{#accountId}:centransitrouterattachment/*
  • TransitRouterPeerAttachment
    acs:cen:*:{#accountId}:centransitrouterattachment/{#centransitrouterattachmentId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CenIdstringNo

The ID of the Cloud Enterprise Network (CEN) instance.

cen-j3jzhw1zpau2km****
RegionIdstringNo

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

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

cn-hangzhou
TransitRouterAttachmentIdstringNo

The ID of the inter-region connection.

tr-attach-5u4qbayfv2io5v****
TransitRouterIdstringNo

The ID of the Enterprise Edition transit router.

tr-bp1su1ytdxtataupl****
MaxResultsintegerNo

The number of entries returned per page. Default value: 20. Maximum value: 100.

20
NextTokenstringNo

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.
  • You must specify the token that is obtained from the previous query as the value of NextToken.
1
Tagobject []No

The information about the tag.

You can specify at most 20 tags in each call.

KeystringNo

The tag key.

The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot start with acs: or aliyun. It cannot contain http:// or https://.

You can specify at most 20 tag keys.

tagtest
ValuestringNo

The tag value.

The tag value can be 0 to 128 characters in length, and cannot start with aliyun or acs:. It cannot contain http:// or https://.

Each tag key must have a unique tag value. You can specify at most 20 tag values in each call.

tagtest

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

NextTokenstring

The returned value of NextToken is a pagination token, which can be used in the next request to retrieve a new page of results. Valid values:

  • If the NextToken parameter is empty, no next page exists.
  • If NextToken was returned in the previous query, specify the value to obtain the next set of results.
dd20****
RequestIdstring

The request ID.

AA97AFA3-8E48-4BD7-9F3E-A9F6176018A0
TotalCountinteger

The total number of entries returned.

1
MaxResultsinteger

The number of entries returned per page.

20
TransitRouterAttachmentsobject []

A list of inter-region connections.

CreationTimestring

The time when the inter-region connection was created.

The time follows the ISO8601 standard in the YYYY-MM-DDThh:mmZ format. The time is displayed in UTC.

2021-06-16T02:50Z
Statusstring

The status of the inter-region connection. Valid values:

  • Attached
  • Attaching
  • Detaching
  • Detached
Attached
TransitRouterAttachmentIdstring

The ID of the inter-region connection.

tr-attach-5u4qbayfv2io5v****
BandwidthTypestring

The bandwidth allocation method. Valid values:

  • BandwidthPackage: allocates bandwidth from a bandwidth plan.
  • DataTransfer: bandwidth is billed based on the pay-by-data-transfer metering method.
BandwidthPackage
CenBandwidthPackageIdstring

The ID of the bandwidth plan that is used to allocate bandwidth to the inter-region connection.

cenbwp-3xrxupouolw5ou****
TransitRouterAttachmentDescriptionstring

The description of the inter-region connection.

testdesc
RegionIdstring

The region ID of the Enterprise Edition transit router.

cn-hangzhou
PeerTransitRouterIdstring

The ID of the peer transit router.

tr-m5eq27g6bndum7e88****
TransitRouterIdstring

The ID of the Enterprise Edition transit router.

tr-bp1su1ytdxtataupl****
PeerTransitRouterRegionIdstring

The region ID of the peer transit router.

cn-qingdao
ResourceTypestring

The type of the resource to which the transit router is connected. Valid values:

  • VPC: virtual private cloud (VPC)
  • CCN: Cloud Connect Network (CCN) instance
  • VBR: virtual border router (VBR)
  • TR: transit router
TR
Bandwidthinteger

The bandwidth value of the inter-region connection. Unit: Mbit/s.

  • This parameter specifies the maximum bandwidth value for the inter-region connection if you set BandwidthType to BandwidthPackage.
  • This parameter specifies the bandwidth throttling threshold for the inter-region connection if you set BandwidthType to DataTransfer.
2
GeographicSpanIdstring

The areas that are connected by the bandwidth plan.

china_china
PeerTransitRouterOwnerIdlong

The ID of the Alibaba Cloud account to which the peer transit router belongs.

253460731706911258
AutoPublishRouteEnabledboolean

Indicates whether the local Enterprise Edition transit router automatically advertises routes of the cross-region connection to the peer transit router. Valid values:

  • false (default)
  • true
false
TransitRouterAttachmentNamestring

The name of the inter-region connection.

test
Tagsobject []

A list of tags.

Keystring

The tag key.

tag_A1
Valuestring

The tag value.

test
CenIdstring

The CEN instance ID.

cen-j3jzhw1zpau2km****
DefaultLinkTypestring

The default line type.

  • Gold (default)
  • Platinum
Gold

Examples

Sample success responses

JSONformat

{
  "NextToken": "dd20****",
  "RequestId": "AA97AFA3-8E48-4BD7-9F3E-A9F6176018A0",
  "TotalCount": 1,
  "MaxResults": 20,
  "TransitRouterAttachments": [
    {
      "CreationTime": "2021-06-16T02:50Z",
      "Status": "Attached",
      "TransitRouterAttachmentId": "tr-attach-5u4qbayfv2io5v****",
      "BandwidthType": "BandwidthPackage",
      "CenBandwidthPackageId": "cenbwp-3xrxupouolw5ou****",
      "TransitRouterAttachmentDescription": "testdesc",
      "RegionId": "cn-hangzhou",
      "PeerTransitRouterId": "tr-m5eq27g6bndum7e88****",
      "TransitRouterId": "tr-bp1su1ytdxtataupl****",
      "PeerTransitRouterRegionId": "cn-qingdao",
      "ResourceType": "TR",
      "Bandwidth": 2,
      "GeographicSpanId": "china_china",
      "PeerTransitRouterOwnerId": 253460731706911260,
      "AutoPublishRouteEnabled": false,
      "TransitRouterAttachmentName": "test",
      "Tags": [
        {
          "Key": "tag_A1",
          "Value": "test"
        }
      ],
      "CenId": "cen-j3jzhw1zpau2km****\n",
      "DefaultLinkType": "Gold"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400IllegalParam.NextTokenThe specified NextToken is invalid.The error message returned because the NextToken parameter is set to an invalid value.
400IllegalParam.TrInstanceThe specified TransitRouter is invalid.The error message returned because the TransitRouter parameter is set to an invalid value.
400IllegalParam.RegionThe specified Region is invalid.The error message returned because the specified region is invalid.
400IllegalParam.CenIdThe specified CenId is invalid.The error message returned because the ID of the CEN instance is invalid.
400IllegalParam.TransitRouterIdThe specified TransitRouterId is invalid.The error message returned because the specified transit router ID is invalid.
400IllegalParam.RegionIdOrTransitRouterIdThe specified TransitRouterId or RegionId is invalid.The error message returned because the specified transit router ID or region is invalid.
400IllegalParam.CenIdOrRegionIdThe specified CenId or RegionId is invalid.The error message returned because the specified CEN instance ID or region ID is invalid.
400IllegalParam.TagKeyThe tag keys are not valid.The error message returned because the specified tag key is invalid.
400IllegalParam.TagValueThe tag values are not valid.The error message returned because the specified tag value 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
2023-12-06The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.
2023-10-18The Error code has changed. The request parameters of the API has changed. The response structure 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.
    delete Input Parameters: DefaultLinkType
Output ParametersThe response structure of the API has changed.
2023-10-18The Error code has changed. The request parameters of the API has changed. The response structure 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: DefaultLinkType
Output ParametersThe response structure of the API has changed.
2023-03-01API Description Update. The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.