调用DescribeVpnAttachments接口查询已绑定转发路由器实例的IPsec连接的配置信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
vpc:DescribeVpnAttachments |
list |
*VpnConnections
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
IPsec 连接所属的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 |
cn-hangzhou |
| PageNumber |
integer |
否 |
列表的页码。默认值：1。 |
1 |
| PageSize |
integer |
否 |
分页查询时每页的条目数。默认值：10。取值范围：1~50。 |
10 |
| VpnConnectionId |
string |
否 |
IPsec 连接 ID。 说明
如果您不输入 IPsec 连接 ID，系统默认查询当前地域下所有已绑定转发路由器实例的 IPsec 连接的信息。 |
vco-p0w2jpkhi2eeop6q6**** |
| AttachType |
string |
否 |
IPsec 连接绑定的资源类型。默认值：CEN。 仅取值：CEN，表示查询已绑定转发路由器实例的 IPsec 连接的信息。 |
CEN |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回结果。 |
||
| RequestId |
string |
请求 ID。 |
9F0725BB-186A-3564-91C3-AAE48042F853 |
| PageSize |
integer |
分页查询时每页的条目数。 |
10 |
| PageNumber |
integer |
列表的页码。 |
1 |
| TotalCount |
integer |
列表条目数。 |
1 |
| VpnAttachments |
array<object> |
已绑定转发路由器实例的 IPsec 连接的信息列表。 |
|
|
array<object> |
已绑定转发路由器实例的 IPsec 连接的信息。 |
||
| InstanceId |
string |
IPsec 连接 ID。 |
vco-p0w2jpkhi2eeop6q6**** |
| Name |
string |
IPsec 连接的名称。 |
nametest1 |
| Description |
string |
IPsec 连接的描述信息。 |
desctest |
| AttachType |
string |
IPsec 连接绑定的资源类型。仅取值：CEN，表示当前 IPsec 连接绑定了转发路由器实例。 |
CEN |
| TransitRouterId |
string |
IPsec 连接绑定的转发路由器实例 ID。 |
tr-p0wkh4yryb1dnanqw**** |
| TransitRouterName |
string |
转发路由器实例的名称。 |
nametest2 |
| CrossAccountAuthorized |
boolean |
IPsec 连接是否绑定了跨账号的转发路由器实例。
|
false |
| Tag |
string |
IPsec 连接的系统标签。 通过系统标签您可以了解 IPsec 连接是否支持 BGP 功能，其余属性无需关注。 BGPSupport：表示 IPsec 连接否支持 BGP 功能。
|
{\"description\":\"转发1.7.22\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"BGPSupport\":\"true\",\"IDaaSNewVersion\":\"true\"} |
| Tags |
array<object> |
IPsec 连接绑定的标签列表。 |
|
|
object |
标签信息。 |
||
| Key |
string |
标签键。 |
TagKey |
| Value |
string |
标签值。 |
TagValue |
| TunnelBandwidth |
string |
用于说明 VPN 单条隧道的带宽规格，取值： Standard（默认值）：标准型，默认带宽 1Gbps Large（大型）：大型，默认带宽 3Gbps |
Standard |
示例
正常返回示例
JSON格式
{
"RequestId": "9F0725BB-186A-3564-91C3-AAE48042F853",
"PageSize": 10,
"PageNumber": 1,
"TotalCount": 1,
"VpnAttachments": [
{
"InstanceId": "vco-p0w2jpkhi2eeop6q6****",
"Name": "nametest1",
"Description": "desctest",
"AttachType": "CEN",
"TransitRouterId": "tr-p0wkh4yryb1dnanqw****",
"TransitRouterName": "nametest2",
"CrossAccountAuthorized": false,
"Tag": "{\\\"description\\\":\\\"转发1.7.22\\\",\\\"VisuallySsl\\\":\\\"true\\\",\\\"PbrPriority\\\":\\\"true\\\",\\\"BGPSupport\\\":\\\"true\\\",\\\"IDaaSNewVersion\\\":\\\"true\\\"}",
"Tags": [
{
"Key": "TagKey",
"Value": "TagValue"
}
],
"TunnelBandwidth": "Standard"
}
]
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | Forbidden.TagKey.Duplicated | The specified tag key already exists. | 标签资源重复 |
| 400 | SizeLimitExceeded.TagNum | The maximum number of tags is exceeded. | 标签数量超限 |
| 400 | InvalidParameter.TagValue | The specified parameter TagValue is invalid. | 指定的参数TagValue不合规范。 |
| 400 | InvalidParameter.TagKey | The specified parameter TagKey is invalid. | 指定的参数TagKey不合规范。 |
| 400 | Duplicated.TagKey | The specified parameter TagKey is duplicated. | 指定的参数TagKey重复。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。