调用ListTransitRouterVpnAttachment接口查询VPN连接的信息。
接口说明
在您调用ListTransitRouterVpnAttachments接口的过程中：
- 如果仅指定了CenId、RegionId参数的值，则系统自动查询当前地域下所有VPN连接的信息。
- 如果指定了CenId、RegionId、TransitRouterAttachmentId的值，则系统仅查询指定VPN连接的信息。
- 如果您指定了CenId、RegionId参数的值，则无需指定TransitRouterId参数的值。如果指定了TransitRouterId参数的值，则无需指定CenId、RegionId参数的值。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试授权信息
当前API暂无授权信息透出。
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| CenId | string | 否 | 云企业网实例ID。 | cen-rsgxs8ng2awen2**** |
| RegionId | string | 否 | 转发路由器实例所属的地域ID。 您可以通过调用DescribeChildInstanceRegions接口获取地域ID。 | ap-southeast-2 |
| TransitRouterAttachmentId | string | 否 | VPN连接ID。 | tr-attach-a6p8voaodog5c0**** |
| TransitRouterId | string | 否 | 转发路由器实例ID。 | tr-p0wm740vjnbaprv0m**** |
| MaxResults | integer | 否 | 分页查询时每页显示的条目数。默认值：20。 | 20 |
| NextToken | string | 否 | 是否拥有下一次查询的令牌（Token）。取值：
| FFmyTO70tTpLG6I3FmYAXGKPd**** |
| Tag | array | 否 | 云企业网实例的标签信息。 一次最多支持查询20个标签。 | |
| object | 否 | |||
| Key | string | 否 | 资源的标签键。 一旦传入该值，则不允许为空字符串。最多支持64个字符，不能以 一次最多支持输入20个标签的标签键。 | tagtest |
| Value | string | 否 | 资源的标签值。 标签值可以为空或输入不超过128个字符的字符串，不能以 每一个标签键对应一个标签值，一次最多支持输入20个标签键对应的标签值。 | value_A1 |
返回参数
示例
正常返回示例
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": "ap-southeast-2",
"AutoPublishRouteEnabled": true,
"TransitRouterAttachmentName": "nametest",
"Zones": [
{
"ZoneId": "ap-southeast-2a"
}
],
"Tags": [
{
"Key": "test",
"Value": "value_A1"
}
],
"ChargeType": "POSTPAY",
"CenId": "cen-j3jzhw1zpau2km****\n"
}
]
}错误码
| 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 | 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 错误码发生变更 | |||||||||
|