All Products
Search
Document Center

Cloud Enterprise Network:ListTransitRouterVbrAttachments

Last Updated:Oct 22, 2024

Queries the virtual border router (VBR) connections on an Enterprise Edition transit router.

Operation description

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

  • Specify the ID of the Enterprise Edition transit router.
  • Specify the ID of the relevant Cloud Enterprise Network (CEN) instance and the region ID of the 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:ListTransitRouterVbrAttachmentslist
  • CenInstance
    acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}
  • TransitRouterVbrAttachment
    acs:cen:*:{#accountId}:centransitrouterattachment/*
  • TransitRouterVbrAttachment
    acs:cen:*:{#accountId}:centransitrouterattachment/{#centransitrouterattachmentId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CenIdstringNo

The IDs of the CEN instances.

cen-j3jzhw1zpau2km****
RegionIdstringNo

The region ID of the Enterprise Edition transit router.

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

cn-hangzhou
TransitRouterAttachmentIdstringNo

The ID of the VBR connection.

tr-attach-oyf70wfuorwx87****
TransitRouterIdstringNo

The ID of the Enterprise Edition transit router.

tr-bp1su1ytdxtataupl****
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.

dd20****
Tagarray<object>No

The information about the tags.

You can specify at most 20 tags in each call.

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

dd20****
RequestIdstring

The request ID.

F42D9616-29EB-4E75-8CA8-9654D4E07501
TotalCountinteger

The total number of entries returned.

1
MaxResultsinteger

The number of entries returned per page.

20
TransitRouterAttachmentsarray<object>

A list of VBR connections.

TransitRouterAttachmentobject
CreationTimestring

The time when the VBR 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-15T15:20Z
Statusstring

The status of the VBR connection. Valid values:

  • Attached
  • Attaching
  • Detaching
  • Detached
Attached
TransitRouterAttachmentIdstring

The ID of the VBR connection.

tr-attach-oyf70wfuorwx87****
TransitRouterIdstring

The description of the Enterprise Edition transit router.

tr-bp1su1ytdxtataupl****
ResourceTypestring

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

  • VPC
  • CCN
  • VBR
  • TR
VBR
VbrRegionIdstring

The region ID of the VBR.

cn-hangzhou
TransitRouterAttachmentDescriptionstring

The description of the VBR connection.

testdesc
VbrOwnerIdlong

The ID of the Alibaba Cloud account to which the VBR belongs.

1688111111111111
AutoPublishRouteEnabledboolean

Indicates whether the Enterprise Edition transit router is allowed to automatically advertise routes to the VBR. Valid values:

  • false (default)
  • true
false
VbrIdstring

The VBR ID.

vbr-bp1svadp4lq38janc****
TransitRouterAttachmentNamestring

The name of the VBR connection.

testa
Tagsarray<object>

A list of tags.

Tagobject
Keystring

The tag key.

test
Valuestring

The tag value.

value_A1
CenIdstring

The ID of the CEN instance.

cen-j3jzhw1zpau2km****
OrderTypestring

The entity that pays the fees of the network instance. Valid values:

  • PayByCenOwner: the Alibaba Cloud account that owns the CEN instance.
  • PayByResourceOwner: the Alibaba Cloud account that owns the network instance.
PayByCenOwner

Examples

Sample success responses

JSONformat

{
  "NextToken": "dd20****",
  "RequestId": "F42D9616-29EB-4E75-8CA8-9654D4E07501",
  "TotalCount": 1,
  "MaxResults": 20,
  "TransitRouterAttachments": [
    {
      "CreationTime": "2021-06-15T15:20Z",
      "Status": "Attached",
      "TransitRouterAttachmentId": "tr-attach-oyf70wfuorwx87****",
      "TransitRouterId": "tr-bp1su1ytdxtataupl****",
      "ResourceType": "VBR",
      "VbrRegionId": "cn-hangzhou",
      "TransitRouterAttachmentDescription": "testdesc",
      "VbrOwnerId": 1688111111111111,
      "AutoPublishRouteEnabled": false,
      "VbrId": "vbr-bp1svadp4lq38janc****",
      "TransitRouterAttachmentName": "testa",
      "Tags": [
        {
          "Key": "test",
          "Value": "value_A1"
        }
      ],
      "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
2023-12-26The Error code has changed. The response structure of the API has changedView Change Details
2023-10-20The Error code has changedView Change Details
2023-08-04The Error code has changedView Change Details
2023-03-01API Description Update. The Error code has changed. The response structure of the API has changedView Change Details