ListTransitRouterVpnAttachments - 查询VPN连接的信息 - 云企业网

调用ListTransitRouterVpnAttachment接口查询VPN连接的状态、IPsec连接ID、VPN连接的付费类型等信息。

接口说明

在您调用 ListTransitRouterVpnAttachments 接口的过程中支持以下三种查询方式：

支持单独输入 TransitRouterAttachmentId 查询则查询指定 VPN 连接的信息。
支持单独输入 TransitRouterId 查询当前转发路由器下关联的所有 VPN 连接的信息。
支持 CenId、RegionId 查询当前云企业网中指定地域下的 VPN 连接的信息。

在调用 ListTransitRouterVpnAttachments 接口过程时请确保输入的参数值无误。如果您输入的参数有误调用接口后仍然会返回 RequestId 等信息，但不会显示目标查询 VPN 连接的信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
cen:ListTransitRouterVpnAttachments	list	CenInstance acs:cen::{#accountId}:ceninstance/{#ceninstanceId} TransitRouterVpnAttachment acs:cen::{#accountId}:centransitrouterattachment/* TransitRouterVpnAttachment acs:cen:*:{#accountId}:centransitrouterattachment/{#centransitrouterattachmentId}	无	无

请求参数

名称	类型	必填	描述	示例值
CenId	string	否	云企业网实例 ID。	cen-rsgxs8ng2awen2****
RegionId	string	否	转发路由器实例所属的地域 ID。您可以通过调用 DescribeChildInstanceRegions 接口获取地域 ID。	cn-hangzhou
TransitRouterAttachmentId	string	否	VPN 连接 ID。	tr-attach-a6p8voaodog5c0****
TransitRouterId	string	否	转发路由器实例 ID。	tr-p0wm740vjnbaprv0m****
MaxResults	integer	否	分页查询时每页显示的条目数。默认值：20。	20
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。	FFmyTO70tTpLG6I3FmYAXGKPd****
Tag	array<object>	否	云企业网实例的标签信息。一次最多支持查询 20 个标签。
	object	否
Key	string	否	资源的标签键。一旦传入该值，则不允许为空字符串。最多支持 64 个字符，不能以`aliyun`或者`acs:`开头，不能包含`http://`或者`https://` 。一次最多支持输入 20 个标签的标签键。	tagtest
Value	string	否	资源的标签值。标签值可以为空或输入不超过 128 个字符的字符串，不能以`aliyun`或者`acs:`开头，不能包含`http://`或者`https://` 。每一个标签键对应一个标签值，一次最多支持输入 20 个标签键对应的标签值。	value_A1

返回参数

名称	类型	描述	示例值
	object	返回结果。
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	请求 ID。	3D5530D2-3BBB-524E-8E98-59AB06A250E4
TotalCount	integer	列表条目数。	1
MaxResults	integer	分页查询时每页显示的条目数。	20
TransitRouterAttachments	array<object>	VPN 连接信息列表。
TransitRouterAttachment	object	VPN 连接的信息。
CreationTime	string	创建 VPN 连接的时间。时间按照 ISO8601 标准表示，并使用 UTC 时间。格式为：YYYY-MM-DDThh:mmZ。	2022-07-08T08:45Z
Status	string	VPN 连接的状态。 Attached：已加载。 Attaching：加载中。 Detaching：卸载中。	Attached
TransitRouterAttachmentId	string	VPN 连接 ID。	tr-attach-a6p8voaodog5c0****
TransitRouterId	string	转发路由器实例 ID。	tr-p0wm740vjnbaprv0m****
ResourceType	string	VPN 连接所属的资源类型。仅取值：VPN，表示转发路由器连接了 IPsec 连接。	VPN
VpnOwnerId	long	IPsec 连接所属的阿里云账号（主账号）ID。	1210123456123456
VpnId	string	IPsec 连接 ID。	vco-p0wtu1xgd0l7fjo7k****
TransitRouterAttachmentDescription	string	VPN 连接的描述信息。	desctest
VpnRegionId	string	IPsec 连接所属的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou
AutoPublishRouteEnabled	boolean	是否允许转发路由器实例自动向 IPsec 连接发布路由条目。取值： true：允许。 false：不允许。	true
TransitRouterAttachmentName	string	VPN 连接的名称。	nametest
Zones	array<object>	部署 VPN 连接的可用区列表。
ZoneMapping	object	部署 VPN 连接的可用区。
ZoneId	string	可用区 ID。您可以通过调用 DescribeZones 接口查询可用区 ID 对应的可用区的信息。	cn-hangzhou-h
Tags	array<object>	标签列表。
Tag	object
Key	string	标签键。	test
Value	string	标签的值。	value_A1
ChargeType	string	VPN 连接的付费类型。仅取值：POSTPAY，表示按使用量后付费。	POSTPAY
CenId	string	云企业网实例 ID。	cen-j3jzhw1zpau2km****
OrderType	string	网络实例的付费方。取值： PayByCenOwner：表示网络实例产生的费用由云企业网实例所属的账号承担。 PayByResourceOwner：表示网络实例产生的费用由网络实例所属的账号承担。	PayByCenOwner

示例

正常返回示例

JSON格式

{
  "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"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalParam.NextToken	The specified NextToken is invalid.	NextToken是无效的。
400	IllegalParam.TrInstance	The specified TransitRouter is invalid.	TransitRouter是无效的。
400	IllegalParam.Region	The specified Region is invalid.	参数中指定的Region不合法。
400	IllegalParam.CenId	The specified CenId is invalid.	云企业网实例ID非法。
400	IllegalParam.CenIdOrRegionId	The specified CenId or RegionId is invalid.	指定的CenId或RegionId不合法。
400	IllegalParam.TransitRouterId	The specified TransitRouterId is illegal.	参数中指定的TransitRouterId不合法。
400	IllegalParam.MaxResults	The specified MaxResults is invalid.	参数MaxResults不合法。
400	InvalidParameter	Invalid parameter.	参数不合法。
400	Unauthorized	The AccessKeyId is unauthorized.	账号无权限操作。

访问错误中心查看更多错误码。

变更历史

变更时间	变更内容概要	操作
2023-03-01	OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2022-12-22	OpenAPI 错误码发生变更	查看变更详情
2022-09-15	OpenAPI 错误码发生变更	查看变更详情
2022-09-15	OpenAPI 错误码发生变更	查看变更详情