All Products
Search
Document Center

:ListTransitRouterEcrAttachments

Last Updated:Aug 12, 2024

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.

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:ListTransitRouterEcrAttachmentslist
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CenIdstringNo

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

cen-7qthudw0ll6jmc****
RegionIdstringNo

The region ID of the transit router.

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

cn-hangzhou
TransitRouterAttachmentIdstringNo

The ID of the ECR connection.

tr-attach-nls9fzkfat8934****
TransitRouterIdstringNo

The ID of the transit router.

tr-6ehx7q2jze8ch5ji0****
MaxResultsintegerNo

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

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.
FFmyTO70tTpLG6I3FmYAXGKPd****
Tagarray<object>No

The tags.

You can specify at most 20 tags.

objectNo
KeystringNo

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
ValuestringNo

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

ParameterTypeDescriptionExample
object
NextTokenstring

A pagination token. It can be used in the next request to retrieve a new page of results.

FFmyTO70tTpLG6I3FmYAXGKPd****
RequestIdstring

The request ID.

461EC1B5-04A8-4706-8764-8F5BCEF48A6F
TotalCountinteger

The total number of entries returned.

4
MaxResultsinteger

The number of entries per page.

20
TransitRouterAttachmentsarray<object>

The information about the ECR connections.

object
CreationTimestring

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
Statusstring

The status of the ECR connection. Valid values:

  • Attached
  • Attaching
  • Detaching
Attached
TransitRouterAttachmentIdstring

The ID of the ECR connection.

tr-attach-nls9fzkfat8934****
TransitRouterIdstring

The ID of the Enterprise Edition transit router.

tr-bp1su1ytdxtataupl****
ResourceTypestring

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

The value is ECR, which indicates ECR connections.

ECR
TransitRouterRegionIdstring

The region ID of the transit router.

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

cn-shanghai
TransitRouterAttachmentDescriptionstring

The description of the ECR connection.

desctest
EcrOwnerIdlong

The ID of the Alibaba Cloud account to which the ECR connection belongs.

1688111111111111
AutoPublishRouteEnabledboolean

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
EcrIdstring

The ID of the ECR with which the ECR connection is associated.

ecr-n78omt2qsko06y****
TransitRouterAttachmentNamestring

The name of the ECR connection.

testname
Tagsarray<object>

The tags.

object
Keystring

The tag key.

test
Valuestring

The tag value.

test
CenIdstring

The ID of the CEN instance.

cen-j3jzhw1zpau2km****
OrderTypestring

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

Sample success responses

JSONformat

{
  "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 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.CenIdOrRegionIdThe specified CenId or RegionId is invalid.The error message returned because the specified CEN instance ID or region ID is invalid.
400IllegalParam.MaxResultsThe specified MaxResults is illegal.MaxResults illegal.
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
No change history