ListTransitRouterPeerAttachments - Cloud Enterprise Network

Call the ListTransitRouterPeerAttachments operation to query details about the inter-region connections of an Enterprise Edition transit router.

Operation description

You can query information about the inter-region connections of an Enterprise Edition transit router in one of the following ways:

Query by the ID of the Enterprise Edition transit router instance.
Query by the ID of the Cloud Enterprise Network (CEN) instance and the region ID of the transit router instance.

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 support 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:ListTransitRouterPeerAttachments

get

*CenInstance

acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}

TransitRouterPeerAttachment

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

TransitRouterPeerAttachment

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

None

Request parameters

Parameter	Type	Required	Description	Example
CenId	string	No	The ID of the CEN instance.	cen-j3jzhw1zpau2km****
RegionId	string	No	The ID of the region where the Enterprise Edition transit router is deployed. For more information, see DescribeRegions.	cn-hangzhou
TransitRouterAttachmentId	string	No	The ID of the inter-region connection.	tr-attach-5u4qbayfv2io5v****
TransitRouterId	string	No	The ID of the Enterprise Edition transit router.	tr-bp1su1ytdxtataupl****
MaxResults	integer	No	The number of entries to return on each page. Default value: 20. Maximum value: 100.	20
NextToken	string	No	The token for the next query. Valid values: If this is your first query or no next query is to be sent, do not specify this parameter. If a next query is to be sent, set the value to the NextToken value returned from the last API call.	1
Tag	array<object>	No	The tags. You can specify up to 20 tags.
	object	No
Key	string	No	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 `aliyun` or `acs:`. It cannot contain `http://` or `https://`. You can specify up to 20 tag keys.	tagtest
Value	string	No	The tag value. The tag value can be an empty string or a string of up to 128 characters. It cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`. Each tag key must have a unique tag value. You can specify up to 20 tag values.	tagtest

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
NextToken	string	The token that is used for the next query. Valid values: If this parameter is empty, no more data is returned. If a value is returned for this parameter, the value is the token that is used for the next query.	dd20****
RequestId	string	The request ID.	AA97AFA3-8E48-4BD7-9F3E-A9F6176018A0
TotalCount	integer	The total number of entries returned.	1
MaxResults	integer	The number of entries returned per page.	20
TransitRouterAttachments	array<object>	A list of inter-region connections.
	object	The details of the inter-region connection.
CreationTime	string	The time when the inter-region connection was created. The time is displayed in the ISO 8601 standard in the `YYYY-MM-DDThh:mmZ` format. The time is displayed in UTC.	2021-06-16T02:50Z
Status	string	The status of the inter-region connection. Attached: The connection is attached. Attaching: The connection is being attached. Detaching: The connection is being detached. Detached: The connection is detached.	Attached
TransitRouterAttachmentId	string	The ID of the inter-region connection.	tr-attach-5u4qbayfv2io5v****
BandwidthType	string	The bandwidth allocation method. Valid values: BandwidthPackage: Bandwidth is allocated from a bandwidth plan. DataTransfer: The inter-region connection is not allocated a specific bandwidth and is billed on a pay-by-traffic basis.	BandwidthPackage
CenBandwidthPackageId	string	The ID of the bandwidth plan that is associated with the inter-region connection.	cenbwp-3xrxupouolw5ou****
TransitRouterAttachmentDescription	string	The description of the inter-region connection.	testdesc
RegionId	string	The ID of the region where the Enterprise Edition transit router is deployed.	cn-hangzhou
PeerTransitRouterId	string	The ID of the peer transit router.	tr-m5eq27g6bndum7e88****
TransitRouterId	string	The ID of the Enterprise Edition transit router.	tr-bp1su1ytdxtataupl****
PeerTransitRouterRegionId	string	The ID of the region where the peer transit router is deployed.	cn-qingdao
ResourceType	string	The type of resource that is associated with the connection. VPC: virtual private cloud (VPC). CCN: Cloud Connect Network (CCN) instance. VBR: virtual border router (VBR). TR: transit router.	TR
Bandwidth	integer	The bandwidth of the inter-region connection. Unit: Mbit/s. If BandwidthType is set to BandwidthPackage, this parameter indicates the bandwidth that is allocated to the inter-region connection. If BandwidthType is set to DataTransfer, this parameter indicates the maximum bandwidth of the inter-region connection.	2
GeographicSpanId	string	The connected areas of the bandwidth plan.	china_china
PeerTransitRouterOwnerId	integer	The ID of the Alibaba Cloud account to which the peer transit router belongs.	253460731706911258
AutoPublishRouteEnabled	boolean	Indicates whether the Enterprise Edition transit router automatically advertises routes to the peer region. false (default): No. true: Yes.	false
TransitRouterAttachmentName	string	The name of the inter-region connection.	test
Tags	array<object>	The list of tags.
	object
Key	string	The tag key.	tag_A1
Value	string	The tag value.	test
CenId	string	The ID of the CEN instance.	cen-j3jzhw1zpau2km****
DefaultLinkType	string	The default link type. Gold (default): Gold. Platinum: Platinum.	Gold

Examples

Success response

JSON format

{
  "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 code	Error code	Error message	Description
400	IllegalParam.NextToken	The specified NextToken is invalid.	The error message returned because the NextToken parameter is set to an invalid value.
400	IllegalParam.TrInstance	The specified TransitRouter is invalid.	The error message returned because the TransitRouter parameter is set to an invalid value.
400	IllegalParam.Region	The specified Region is invalid.	The error message returned because the specified region is invalid.
400	IllegalParam.CenId	The specified CenId is invalid.	The error message returned because the ID of the CEN instance is invalid.
400	IllegalParam.TransitRouterId	The specified TransitRouterId is invalid.	The error message returned because the specified transit router ID is invalid.
400	IllegalParam.RegionIdOrTransitRouterId	The specified TransitRouterId or RegionId is invalid.	The error message returned because the specified transit router ID or region is invalid.
400	IllegalParam.CenIdOrRegionId	The specified CenId or RegionId is invalid.	The error message returned because the specified CEN instance ID or region ID is invalid.
400	IllegalParam.TagKey	The tag keys are not valid.	The error message returned because the specified tag key is invalid.
400	IllegalParam.TagValue	The tag values are not valid.	The error message returned because the specified tag value is invalid.
400	IllegalParam.MaxResults	The specified MaxResults 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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.