ListTransitRouterVpnAttachments - Cloud Enterprise Network

Queries the information about VPN attachments, such as the status and billing method of a VPN attachment, and the ID of an IPsec-VPN connection.

Operation description

You can use the following methods to call the ListTransitRouterVpnAttachments operation:

Specify only the TransitRouterAttachmentId parameter to query the information about a VPN attachment.
Specify only the TransitRouterId parameter to query the information about all VPN attachments on a transit router.
Specify the CenId and RegionId parameter to query the information about VPN attachments in a specified region.

Before you call the ListTransitRouterVpnAttachments operation, make sure that all request parameters are valid. If a request parameter is invalid, a request ID is returned, but the information about the VPN attachments is not returned.

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.

Debug

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.

Operation	Access level	Resource type	Condition key	Associated operation
cen:ListTransitRouterVpnAttachments	list	CenInstance acs:cen::{#accountId}:ceninstance/{#ceninstanceId} TransitRouterVpnAttachment acs:cen::{#accountId}:centransitrouterattachment/* TransitRouterVpnAttachment acs:cen:*:{#accountId}:centransitrouterattachment/{#centransitrouterattachmentId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
CenId	string	No	The ID of the Cloud Enterprise Network (CEN) instance.	cen-rsgxs8ng2awen2****
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 VPN attachment.	tr-attach-a6p8voaodog5c0****
TransitRouterId	string	No	The ID of the transit router.	tr-p0wm740vjnbaprv0m****
MaxResults	integer	No	The number of entries to return on each page. Default value: 20.	20
NextToken	string	No	The token that determines the start point of the next query. Valid values: If this is your first query and no subsequent queries are to be sent, ignore this parameter. If a subsequent query is to be sent, set the parameter to the value of NextToken that is returned from the last call.	FFmyTO70tTpLG6I3FmYAXGKPd****
Tag	array<object>	No	The information about the tags that are added to the CEN instance. You can query at most 20 tags in each call.
	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 `acs:` or `aliyun`. It cannot contain `http://` or `https://`. You can specify at most 20 tag keys.	tagtest
Value	string	No	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.	value_A1

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
NextToken	string	The token that determines the start point of the next query. Valid values: If NextToken is not returned, it indicates that no additional results exist. If NextToken was returned in the previous query, specify the value to obtain the next set of results.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	The ID of the request.	3D5530D2-3BBB-524E-8E98-59AB06A250E4
TotalCount	integer	The total number of entries returned.	1
MaxResults	integer	The number of entries returned per page.	20
TransitRouterAttachments	array<object>	The information about the VPN attachment.
TransitRouterAttachment	object	The information about the VPN attachment.
CreationTime	string	The time when the VPN connection was created. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2022-07-08T08:45Z
Status	string	The status of the VPN connection. Valid values: Attached Attaching Detaching	Attached
TransitRouterAttachmentId	string	The ID of the VPN attachment.	tr-attach-a6p8voaodog5c0****
TransitRouterId	string	The ID of the transit router.	tr-p0wm740vjnbaprv0m****
ResourceType	string	The type of resource attached to the transit router. Only VPN may be returned, which indicates that an IPsec-VPN connection is attached to the transit router.	VPN
VpnOwnerId	long	The ID of the Alibaba Cloud account to which the IPsec-VPN connection belongs.	1210123456123456
VpnId	string	The ID of the IPsec-VPN connection.	vco-p0wtu1xgd0l7fjo7k****
TransitRouterAttachmentDescription	string	The description of the IPsec-VPN connection.	desctest
VpnRegionId	string	The ID of the region to which the IPsec-VPN connection belongs. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
AutoPublishRouteEnabled	boolean	Indicates the transit router can automatically advertise routes to the IPsec connection. Valid values: true: yes false: no	true
TransitRouterAttachmentName	string	The name of the VPN attachment.	nametest
Zones	array<object>	The zones in which the VPN attachment is deployed.
ZoneMapping	object	The zone in which the VPN attachment is deployed.
ZoneId	string	The zone ID. You can call the DescribeZones operation to query the most recent zone list.	cn-hangzhou-h
Tags	array<object>	A list of tags.
Tag	object
Key	string	The tag key.	test
Value	string	The tag value.	value_A1
ChargeType	string	The billing method of the VPN attachment. Only POSTPAY may be returned, which is the default pay-as-you-go billing method.	POSTPAY
CenId	string	The ID of the Cloud Enterprise Network (CEN) instance.	cen-j3jzhw1zpau2km****
OrderType	string	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": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "3D5530D2-3BBB-524E-8E98-59AB06A250E4",
  "TotalCount": 1,
  "MaxResults": 20,
  "TransitRouterAttachments": [
    {
      "CreationTime": "2022-07-08T08:45Z",
      "Status": "Attached",
      "TransitRouterAttachmentId": "tr-attach-a6p8voaodog5c0****",
      "TransitRouterId": "tr-p0wm740vjnbaprv0m****",
      "ResourceType": "VPN",
      "VpnOwnerId": 1210123456123456,
      "VpnId": "vco-p0wtu1xgd0l7fjo7k****",
      "TransitRouterAttachmentDescription": "desctest",
      "VpnRegionId": "cn-hangzhou",
      "AutoPublishRouteEnabled": true,
      "TransitRouterAttachmentName": "nametest",
      "Zones": [
        {
          "ZoneId": "cn-hangzhou-h"
        }
      ],
      "Tags": [
        {
          "Key": "test",
          "Value": "value_A1"
        }
      ],
      "ChargeType": "POSTPAY",
      "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.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.TransitRouterId	The specified TransitRouterId is illegal.	The error message returned because the specified transit router ID 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.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-03-01	API Description Update. The Error code has changed. The response structure of the API has changed	View Change Details
2022-12-22	The Error code has changed	View Change Details
2022-09-15	The Error code has changed	View Change Details
2022-09-15	The Error code has changed	View Change Details