赛尔校园公共服务平台 Logo
平台使用
阿里云
百度云
移动云
智算服务
教育生态
登录 →
赛尔校园公共服务平台 Logo
平台使用 阿里云 百度云 移动云 智算服务 教育生态
登录
  1. 首页
  2. 阿里云
  3. IPsec-VPN
  4. 开发参考
  5. API参考
  6. API目录
  7. 绑定转发路由器实例
  8. DescribeVpnAttachments - 查询已绑定转发路由器实例的IPsec连接的配置信息

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

  • 绑定转发路由器实例
  • 发布于 2025-04-22
  • 0 次阅读
文档编辑
文档编辑

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

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:DescribeVpnAttachmentslist
*VpnConnections
acs:vpc:{#regionId}:{#accountId}:vpnconnection/{#VpnConnectionId}
    无
无

请求参数

名称类型必填描述示例值
RegionIdstring是

IPsec 连接所属的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
PageNumberinteger否

列表的页码。默认值:1。

1
PageSizeinteger否

分页查询时每页的条目数。默认值:10。取值范围:1~50。

10
VpnConnectionIdstring否

IPsec 连接 ID。

说明 如果您不输入 IPsec 连接 ID,系统默认查询当前地域下所有已绑定转发路由器实例的 IPsec 连接的信息。
vco-p0w2jpkhi2eeop6q6****
AttachTypestring否

IPsec 连接绑定的资源类型。默认值:CEN。

仅取值:CEN,表示查询已绑定转发路由器实例的 IPsec 连接的信息。

CEN

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

9F0725BB-186A-3564-91C3-AAE48042F853
PageSizeinteger

分页查询时每页的条目数。

10
PageNumberinteger

列表的页码。

1
TotalCountinteger

列表条目数。

1
VpnAttachmentsarray<object>

已绑定转发路由器实例的 IPsec 连接的信息列表。

vpnAttachmentobject

已绑定转发路由器实例的 IPsec 连接的信息。

InstanceIdstring

IPsec 连接 ID。

vco-p0w2jpkhi2eeop6q6****
Namestring

IPsec 连接的名称。

nametest1
Descriptionstring

IPsec 连接的描述信息。

desctest
AttachTypestring

IPsec 连接绑定的资源类型。仅取值:CEN,表示当前 IPsec 连接绑定了转发路由器实例。

CEN
TransitRouterIdstring

IPsec 连接绑定的转发路由器实例 ID。

tr-p0wkh4yryb1dnanqw****
TransitRouterNamestring

转发路由器实例的名称。

nametest2
CrossAccountAuthorizedboolean

IPsec 连接是否绑定了跨账号的转发路由器实例。

  • true:是。
  • false:否。
false
Tagstring

IPsec 连接的系统标签。

通过系统标签您可以了解 IPsec 连接是否支持 BGP 功能,其余属性无需关注。

BGPSupport:表示 IPsec 连接否支持 BGP 功能。

  • true:支持。
  • false:不支持。
{\"description\":\"转发1.7.22\",\"VisuallySsl\":\"true\",\"PbrPriority\":\"true\",\"BGPSupport\":\"true\",\"IDaaSNewVersion\":\"true\"}
Tagsarray<object>

IPsec 连接绑定的标签列表。

Tagobject

标签信息。

Keystring

标签键。

TagKey
Valuestring

标签值。

TagValue

示例

正常返回示例

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

错误码

HTTP status code错误码错误信息描述
400Forbidden.TagKey.DuplicatedThe specified tag key already exists.标签资源重复
400SizeLimitExceeded.TagNumThe maximum number of tags is exceeded.标签数量超限
400InvalidParameter.TagValueThe specified parameter TagValue is invalid.指定的参数TagValue不合规范。
400InvalidParameter.TagKeyThe specified parameter TagKey is invalid.指定的参数TagKey不合规范。
400Duplicated.TagKeyThe specified parameter TagKey is duplicated.指定的参数TagKey重复。

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

变更历史

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

CreateVpnAttachment - 创建IPsec连接 2025-04-22 16:49

调用CreateVpnAttachment接口创建IPsec连接,用于绑定转发路由器实例。

CreateVcoRouteEntry - 为IPsec连接添加目的路由条目 2025-04-22 16:48

调用CreateVcoRouteEntry接口为IPsec连接添加目的路由条目。

DeleteVpnAttachment - 删除IPsec连接 2025-04-22 16:48

调用DeleteVpnAttachment接口删除IPsec连接。

DeleteVcoRouteEntry - 删除IPsec连接下的目的路由条目 2025-04-22 16:48

调用DeleteVcoRouteEntry接口删除IPsec连接下的目的路由条目。

ModifyVpnAttachmentAttribute - 修改IPsec连接的配置 2025-04-22 16:48

调用ModifyVpnAttachmentAttribute接口修改IPsec连接的配置。

ModifyVcoRouteEntryWeight - 修改IPsec连接下目的路由条目的权重值 2025-04-22 16:48

调用ModifyVcoRouteEntryWeight接口修改IPsec连接下目的路由条目的权重值。

目录
Copyright © 2025 your company All Rights Reserved. Powered by 赛尔网络.
京ICP备14022346号-15
gongan beian 京公网安备11010802041014号