DescribeVpnAttachments - 查询已绑定转发路由器实例的IPsec连接的配置信息 - VPN网关

调用DescribeVpnAttachments接口查询已绑定转发路由器实例的IPsec连接的配置信息。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
vpc:DescribeVpnAttachments	list	*VpnConnections `acs:vpc:{#regionId}:{#accountId}:vpnconnection/{#VpnConnectionId}`	无	无

请求参数

名称	类型	必填	描述	示例值
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 连接的信息列表。
vpnAttachment	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 连接是否绑定了跨账号的转发路由器实例。 true：是。 false：否。	false

示例

正常返回示例

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": "",
      "Tags": [
        {
          "Key": "",
          "Value": ""
        }
      ]
    }
  ]
}

错误码

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重复。

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

变更历史

变更时间	变更内容概要	操作
2024-11-25	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情
2024-11-05	OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更	查看变更详情