ListTransitRouterEcrAttachments - Cloud Enterprise Network

Queries the information about Express Connect Router (ECR) connections on an Enterprise Edition transit router, such as the connection status, connection ID, and the payer of instance fees.

Operation description

You can use the following methods to query ECR connection information:

Specify the ID of an Enterprise Edition transit router.
Specify the ID of an Enterprise Edition transit router and the ID of the region in which the Enterprise Edition transit router is deployed.
Configure the TransitRouterAttachmentId parameter to specify the ECR connection that you want to query.

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 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 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. For more information, see Common condition keys.
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:ListTransitRouterEcrAttachments

list

*CenInstance

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

*TransitRouterEcrAttachment

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

TransitRouterEcrAttachment

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

None

Request parameters

Parameter	Type	Required	Description	Example
CenId	string	No	The ID of the Cloud Enterprise Network (CEN) instance.	cen-7qthudw0ll6jmc****
RegionId	string	No	The region ID of the transit router. You can call the DescribeChildInstanceRegions operation to query the most recent region list.	cn-hangzhou
TransitRouterAttachmentId	string	No	The ID of the ECR connection.	tr-attach-nls9fzkfat8934****
TransitRouterId	string	No	The ID of the transit router.	tr-6ehx7q2jze8ch5ji0****
MaxResults	integer	No	The number of entries to return on each page. Default value: 20.	20
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. You must specify the token that is obtained from the previous query as the value of NextToken.	FFmyTO70tTpLG6I3FmYAXGKPd****
Tag	array	No	The tags. You can specify at most 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. It cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`. You can specify at most 20 tag keys in each call.	TagKey
Value	string	No	The tag value. The tag value can be an empty string. The tag value can be up to 128 characters in length. It cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`. Each key-value must be unique. You can specify at most 20 tag values in each call.	TagValue

Response parameters

Parameter	Type	Description	Example
	object
NextToken	string	A pagination token. It can be used in the next request to retrieve a new page of results.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	The request ID.	461EC1B5-04A8-4706-8764-8F5BCEF48A6F
TotalCount	integer	The total number of entries returned.	4
MaxResults	integer	The number of entries per page.	20
TransitRouterAttachments	array	The information about the ECR connections.
	object
CreationTime	string	The time when the ECR connection was created. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2021-06-15T02:14Z
Status	string	The status of the ECR connection. Valid values: Attached Attaching Detaching	Attached
TransitRouterAttachmentId	string	The ID of the ECR connection.	tr-attach-nls9fzkfat8934****
TransitRouterId	string	The ID of the Enterprise Edition transit router.	tr-bp1su1ytdxtataupl****
ResourceType	string	The type of resource to which the transit router is connected. Valid values: The value is ECR, which indicates ECR connections.	ECR
TransitRouterRegionId	string	The region ID of the transit router. You can call the DescribeChildInstanceRegions operation to query the most recent region list.	cn-shanghai
TransitRouterAttachmentDescription	string	The description of the ECR connection.	desctest
EcrOwnerId	integer	The ID of the Alibaba Cloud account to which the ECR connection belongs.	1688111111111111
AutoPublishRouteEnabled	boolean	Indicates whether the Enterprise Edition transit router can automatically advertise routes to ECRs. The value is true, which indicates that the Enterprise Edition transit router can automatically advertise routes to ECRs.	true
EcrId	string	The ID of the ECR with which the ECR connection is associated.	ecr-n78omt2qsko06y****
TransitRouterAttachmentName	string	The name of the ECR connection.	testname
Tags	array	The tags.
	object
Key	string	The tag key.	test
Value	string	The tag value.	test
CenId	string	The ID of the CEN instance.	cen-j3jzhw1zpau2km****
OrderType	string	The entity that pays the fees of the network instance. Valid values: Valid values: PayByCenOwner: The Alibaba Cloud account to which the transit router belongs pays the connection and data forwarding fees of the ECR. PayByResourceOwner: The Alibaba Cloud account to which the ECR belongs pays the connection and data forwarding fees of the ECR.	PayByCenOwner

Examples

Success response

JSON format

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "461EC1B5-04A8-4706-8764-8F5BCEF48A6F",
  "TotalCount": 4,
  "MaxResults": 20,
  "TransitRouterAttachments": [
    {
      "CreationTime": "2021-06-15T02:14Z",
      "Status": "Attached",
      "TransitRouterAttachmentId": "tr-attach-nls9fzkfat8934****",
      "TransitRouterId": "tr-bp1su1ytdxtataupl****",
      "ResourceType": "ECR",
      "TransitRouterRegionId": "cn-shanghai",
      "TransitRouterAttachmentDescription": "desctest",
      "EcrOwnerId": 1688111111111111,
      "AutoPublishRouteEnabled": true,
      "EcrId": "ecr-n78omt2qsko06y****",
      "TransitRouterAttachmentName": "testname",
      "Tags": [
        {
          "Key": "test",
          "Value": "test"
        }
      ],
      "CenId": "cen-j3jzhw1zpau2km****\n",
      "OrderType": "PayByCenOwner"
    }
  ]
}

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.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.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.