Use ListTransitRouterVbrAttachments to query VBR connections - Cloud Enterprise Network - Alibaba Cloud - Cloud Enterprise Network

Queries the connection information of virtual border routers (VBRs) under an Enterprise Edition transit router, including the total number of entries, connection status, connection IDs, and payers of network instances.

Operation description

You can query information about virtual border router (VBR) connections on an Enterprise Edition transit router in the following ways:

Query information about all VBR connections on an Enterprise Edition transit router by specifying the transit router instance ID.
Query information about all VBR connections on an Enterprise Edition transit router by specifying the Cloud Enterprise Network (CEN) instance ID and the region ID of the transit router instance.
Query information about a VBR connection by specifying only the TransitRouterAttachmentId parameter.

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 supports 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:ListTransitRouterVbrAttachments

list

CenInstance

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

TransitRouterVbrAttachment

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

TransitRouterVbrAttachment

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

None

Request parameters

Parameter	Type	Required	Description	Example
CenId	string	No	The CEN instance ID.	cen-j3jzhw1zpau2km****
RegionId	string	No	The region ID of the Enterprise Edition transit router instance. You can call DescribeRegions to query the region ID.	cn-hangzhou
TransitRouterAttachmentId	string	No	The ID of the VBR connection.	tr-attach-oyf70wfuorwx87****
TransitRouterId	string	No	The Enterprise Edition forward routing instance ID.	tr-bp1su1ytdxtataupl****
MaxResults	integer	No	The maximum number of entries to return per page. Default value: 20.	20
NextToken	string	No	The token that determines the start point of the query. Valid values: If this is the first query or no subsequent query is to be sent, you do not need to specify this parameter. If a subsequent query is to be sent, set the value to the NextToken value returned by the previous API call.	dd20****
Tag	array<object>	No	The tag information. You can specify up to 20 tags at a time.
	object	No
Key	string	No	The tag key of the resource. 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 at a time.	tagtest
Value	string	No	The tag value of the resource. The tag value can be an empty string or up to 128 characters in length. It cannot start with `aliyun` or `acs:` and cannot contain `http://` or `https://`. Each tag key corresponds to one tag value. You can specify up to 20 tag values at a time.	tagtest

Response elements

Element	Type	Description	Example
	object	The response parameters.
NextToken	string	The token that determines the start point of the query. Valid values: If this is the first query or no subsequent query is to be sent, you do not need to specify this parameter. If a subsequent query is to be sent, set the value to the NextToken value returned by the previous API call.	dd20****
RequestId	string	The request ID.	F42D9616-29EB-4E75-8CA8-9654D4E07501
TotalCount	integer	The total number of entries returned.	1
MaxResults	integer	The maximum number of entries returned per page.	20
TransitRouterAttachments	array<object>	The list of VBR connections.
	array<object>
CreationTime	string	The time when the VBR connection was created. The time is displayed in the ISO 8601 standard in UTC. Format: YYYY-MM-DDThh:mmZ.	2021-06-15T15:20Z
Status	string	The status of the VBR connection. Valid values: Attached: The VBR connection is attached. Attaching: The VBR connection is being attached. Detaching: The VBR connection is being detached.	Attached
TransitRouterAttachmentId	string	The ID of the VBR connection.	tr-attach-oyf70wfuorwx87****
TransitRouterId	string	The Enterprise Edition forward routing instance ID.	tr-bp1su1ytdxtataupl****
ResourceType	string	The type of resource to which the connection belongs. The value is VBR, which indicates a virtual border router instance.	VBR
VbrRegionId	string	The region ID of the VBR instance.	cn-hangzhou
TransitRouterAttachmentDescription	string	The description of the VBR connection.	testdesc
VbrOwnerId	integer	The ID of the account to which the VBR instance belongs.	1688111111111111
AutoPublishRouteEnabled	boolean	Indicates whether the Enterprise Edition forward routing automatically publishes route entries to the VBR instance. Valid values: false: The Enterprise Edition forward routing does not automatically publish route entries to the VBR instance. true: The Enterprise Edition forward routing automatically publishes route entries to the VBR instance.	false
VbrId	string	The VBR instance ID.	vbr-bp1svadp4lq38janc****
TransitRouterAttachmentName	string	The name of the VBR connection.	testa
Tags	array<object>	The list of tags.
	object
Key	string	The tag key.	test
Value	string	The tag value.	value_A1
CenId	string	The CEN instance ID.	cen-j3jzhw1zpau2km****
ManagedService	string	The cloud service that manages the VBR connection. This parameter is returned only when the VBR connection is managed by a cloud service. The standard code of the cloud service is returned. If the VBR connection is managed by you, this parameter is not returned.
OrderType	string	The payer of the network instance. Valid values: PayByCenOwner: The connection fee and data processing fee of the VBR instance are paid by the account to which the transit router instance belongs. PayByResourceOwner: The connection fee and data processing fee of the VBR instance are paid by the account to which the VBR instance belongs.	PayByCenOwner

Examples

Success response

JSON format

{
  "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",
      "ManagedService": "",
      "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.