全部产品
Search

搜索本产品

    专有网络 VPC：DownloadVpnConnectionConfig - 获取IPsec连接的配置信息

    文档中心

    专有网络 VPC：DownloadVpnConnectionConfig - 获取IPsec连接的配置信息

    更新时间：Nov 27, 2024

    调用DownloadVpnConnectionConfig接口获取IPsec连接的配置信息。

    调试

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

    授权信息

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

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

    请求参数

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

    IPsec 连接所在的地域 ID。

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

    		cn-shanghai
    VpnConnectionIdstring是

    IPsec 连接的 ID。

    		vco-bp1bbi27hojx80nck****

    返回参数

    名称类型描述示例值
    object

    返回结果。

    RequestIdstring

    请求 ID。

    		0C68048B-0F70-40DA-B8AE-1B79B5CF62E3
    VpnConnectionConfigobject

    IPsec 连接对端网关设备的配置信息。

    Remotestring

    VPN 网关的标识。

    		116.62.XX.XX
    Localstring

    用户网关的标识。

    		139.196.XX.XX
    RemoteSubnetstring

    VPC 侧的网段。

    		192.168.0.0/16
    LocalSubnetstring

    本地 IDC 侧的网段。

    		10.0.0.0/8
    IkeConfigobject

    第一阶段协商的配置信息。

    RemoteIdstring

    VPN 网关的标识。支持 FQDN 和 IP 格式，默认为 VPN 网关的 IP 地址。

    		116.62.XX.XX
    IkeLifetimelong

    IKE 阶段生存时间。单位：秒。

    		86400
    IkeEncAlgstring

    IKE 阶段加密算法。

    		aes
    LocalIdstring

    用户网关的标识。支持 FQDN 和 IP 格式，默认为用户网关的 IP 地址。

    		139.196.XX.XX
    IkeModestring

    IKE 协商模式。

    • main：主模式，协商过程安全性高。
    • aggressive：野蛮模式，协商快速且协商成功率高。
    		main
    IkeVersionstring

    IKE 协议的版本。

    		ikev1
    IkePfsstring

    IKE 阶段 DH 分组。

    		group2
    Pskstring

    预共享密钥。

    		pgw6dy7d1i8i****
    IkeAuthAlgstring

    IKE 阶段认证算法。

    		sha1
    IpsecConfigobject

    第二阶段协商的配置信息。

    IpsecAuthAlgstring

    IPsec 阶段认证算法。

    		sha1
    IpsecEncAlgstring

    IPsec 阶段加密算法。

    		aes
    IpsecLifetimelong

    IPsec 阶段生存时间。单位：秒。

    		86400
    IpsecPfsstring

    IPsec 阶段 DH 分组。

    		group2
    TunnelsConfigarray<object>

    IPsec 连接对端网关设备的隧道配置信息。

    仅双隧道模式的 IPsec 连接会返回 TunnelsConfig 数组下的参数。

    TunnelConfigobject

    隧道的配置信息。

    TunnelIdstring

    隧道 ID。

    		tun-opsqc4d97wni27****
    Localstring

    本地 IDC 侧隧道的标识。

    		47.21.XX.XX
    Remotestring

    阿里云侧隧道的标识。

    		47.24.XX.XX
    IkeConfigobject

    第一阶段协商的配置信息。

    Pskstring

    预共享密钥。

    		pgw6dy7d1i8i****
    IkeVersionstring

    IKE 协议的版本。

    		ikev1
    IkeModestring

    IKE 协商模式。

    • main：主模式，协商过程安全性高。
    • aggressive：野蛮模式，协商快速且协商成功率高。
    		main
    IkeEncAlgstring

    IKE 阶段加密算法。

    		aes
    IkeAuthAlgstring

    IKE 阶段认证算法。

    		sha1
    IkePfsstring

    IKE 阶段 DH 分组。

    		group2
    IkeLifetimelong

    IKE 阶段生存时间。单位：秒。

    		86400
    LocalIdstring

    本地 IDC 侧隧道的标识。

    		47.21.XX.XX
    RemoteIdstring

    阿里云侧隧道的标识。

    		47.24.XX.XX
    IpsecConfigobject

    第二阶段协商的配置信息。

    IpsecAuthAlgstring

    IPsec 阶段认证算法。

    		sha1
    IpsecEncAlgstring

    IPsec 阶段加密算法。

    		aes
    IpsecPfsstring

    IPsec 阶段 DH 分组。

    		group2
    IpsecLifetimelong

    IPsec 阶段生存时间。单位：秒。

    		86400

    示例

    正常返回示例

    JSON格式

    {
  "RequestId": "0C68048B-0F70-40DA-B8AE-1B79B5CF62E3",
  "VpnConnectionConfig": {
    "Remote": "116.62.XX.XX",
    "Local": "139.196.XX.XX",
    "RemoteSubnet": "192.168.0.0/16",
    "LocalSubnet": "10.0.0.0/8",
    "IkeConfig": {
      "RemoteId": "116.62.XX.XX",
      "IkeLifetime": 86400,
      "IkeEncAlg": "aes",
      "LocalId": "139.196.XX.XX",
      "IkeMode": "main",
      "IkeVersion": "ikev1",
      "IkePfs": "group2",
      "Psk": "pgw6dy7d1i8i****",
      "IkeAuthAlg": "sha1"
    },
    "IpsecConfig": {
      "IpsecAuthAlg": "sha1",
      "IpsecEncAlg": "aes",
      "IpsecLifetime": 86400,
      "IpsecPfs": "group2"
    },
    "TunnelsConfig": {
      "TunnelConfig": [
        {
          "TunnelId": "tun-opsqc4d97wni27****",
          "Local": "47.21.XX.XX",
          "Remote": "47.24.XX.XX",
          "IkeConfig": {
            "Psk": "pgw6dy7d1i8i****",
            "IkeVersion": "ikev1",
            "IkeMode": "main",
            "IkeEncAlg": "aes",
            "IkeAuthAlg": "sha1",
            "IkePfs": "group2",
            "IkeLifetime": 86400,
            "LocalId": "47.21.XX.XX",
            "RemoteId": "47.24.XX.XX"
          },
          "IpsecConfig": {
            "IpsecAuthAlg": "sha1",
            "IpsecEncAlg": "aes",
            "IpsecPfs": "group2",
            "IpsecLifetime": 86400
          }
        }
      ]
    }
  }
}

    错误码

    HTTP status code错误码错误信息描述
    403Forbbiden.SubUserUser not authorized to operate on the specified resource as your account is created by another user.您没有权限操作该资源，请您申请操作权限后再试。
    403ForbiddenUser not authorized to operate on the specified resource.您没有权限操作指定资源，请申请权限后再操作。
    404InvalidVpnConnectionInstanceId.NotFoundThe specified vpn connection instance id does not exist.指定的VPN连接不存在，请您检查该VPN连接ID是否正确。

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

    变更历史

    变更时间变更内容概要操作
    2023-08-01OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情
    2023-06-13OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更查看变更详情