DownloadVpnConnectionConfig - VPN Gateway

呼叫 DownloadVpnConnectionConfig 介面取得 IPsec 連線的設定資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:DownloadVpnConnectionConfig

get

*VpnConnection

acs:vpc:{#regionId}:{#accountId}:vpnconnection/{#VpnConnectionId}

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	IPsec 連線所在的地域 ID。您可以透過呼叫 DescribeRegions 介面取得地域 ID。	cn-shanghai
VpnConnectionId	string	是	IPsec 連線的 ID。	vco-bp1bbi27hojx80nck****

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
RequestId	string	請求 ID。	0C68048B-0F70-40DA-B8AE-1B79B5CF62E3
VpnConnectionConfig	object	IPsec 連線對端閘道器裝置的設定資訊。
Remote	string	VPN 閘道器的識別碼。	116.62.XX.XX
Local	string	使用者閘道器的識別碼。	139.196.XX.XX
RemoteSubnet	string	VPC 側的網段。	192.168.0.0/16
LocalSubnet	string	本機 IDC 側的網段。	10.0.0.0/8
IkeConfig	object	第一階段協商的設定資訊。
RemoteId	string	VPN 閘道器的識別碼。支援 FQDN 和 IP 格式，預設為 VPN 閘道器的 IP 位址。	116.62.XX.XX
IkeLifetime	integer	IKE 階段存留時間。單位：秒。	86400
IkeEncAlg	string	IKE 階段加密演算法。	aes
LocalId	string	使用者閘道器的識別碼。支援 FQDN 和 IP 格式，預設為使用者閘道器的 IP 位址。	139.196.XX.XX
IkeMode	string	IKE 協商模式。 main：主模式，協商過程安全性高。 aggressive：野蠻模式，協商快速且協商成功率高。	main
IkeVersion	string	IKE 通訊協定的版本。	ikev2
IkePfs	string	IKE 階段 DH 群組。	group2
Psk	string	預先共用金鑰。	pgw6dy7d1i8i****
IkeAuthAlg	string	IKE 階段驗證演算法。	sha1
IpsecConfig	object	第二階段協商的設定資訊。
IpsecAuthAlg	string	IPsec 階段驗證演算法。	sha1
IpsecEncAlg	string	IPsec 階段加密演算法。	aes
IpsecLifetime	integer	IPsec 階段存留時間。單位：秒。	86400
IpsecPfs	string	IPsec 階段 DH 群組。	group2
TunnelsConfig	object
TunnelConfig	array<object>	IPsec 連線對端閘道器裝置的通道設定資訊。僅雙通道模式的 IPsec 連線會返回 TunnelsConfig 陣列下的參數。
	array<object>	通道的設定資訊。
TunnelId	string	通道 ID。	tun-opsqc4d97wni27****
Local	string	本機 IDC 側通道的識別碼。	47.21.XX.XX
Remote	string	阿里雲側通道的識別碼。	47.24.XX.XX
IkeConfig	object	第一階段協商的設定資訊。
Psk	string	預先共用金鑰。	pgw6dy7d1i8i****
IkeVersion	string	IKE 通訊協定的版本。	ikev2
IkeMode	string	IKE 協商模式。 main：主模式，協商過程安全性高。 aggressive：野蠻模式，協商快速且協商成功率高。	main
IkeEncAlg	string	IKE 階段加密演算法。	aes
IkeAuthAlg	string	IKE 階段驗證演算法。	sha1
IkePfs	string	IKE 階段 DH 群組。	group2
IkeLifetime	integer	IKE 階段存留時間。單位：秒。	86400
LocalId	string	本機 IDC 側通道的識別碼。	47.21.XX.XX
RemoteId	string	阿里雲側通道的識別碼。	47.24.XX.XX
IpsecConfig	object	第二階段協商的設定資訊。
IpsecAuthAlg	string	IPsec 階段驗證演算法。	sha1
IpsecEncAlg	string	IPsec 階段加密演算法。	aes
IpsecPfs	string	IPsec 階段 DH 群組。	group2
IpsecLifetime	integer	IPsec 階段存留時間。單位：秒。	86400
BgpConfigs	object
BgpConfig	array<object>	BGP 的設定資訊。
	object	BGP 的設定資訊。
LocalAsn	string	本機 IDC 自治系統號碼。	1219002
LocalBgpIp	string	本機 IDC 側的 BGP 位址。	169.254.20.2
PeerAsn	string	阿里雲側自治系統號碼。	1219001
PeerBgpIp	string	阿里雲側的 BGP 位址。	169.254.20.1
TunnelCidr	string	通道的 BGP 網段。	169.254.20.0/30
TunnelId	string	通道 ID。	tun-900ghtunmhp75r14wh

樣本

正常返回樣本

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": "ikev2",
      "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": "ikev2",
            "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
          }
        }
      ]
    },
    "BgpConfigs": {
      "BgpConfig": [
        {
          "LocalAsn": "1219002",
          "LocalBgpIp": "169.254.20.2",
          "PeerAsn": "1219001",
          "PeerBgpIp": "169.254.20.1",
          "TunnelCidr": "169.254.20.0/30",
          "TunnelId": "tun-900ghtunmhp75r14wh"
        }
      ]
    }
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊	描述
403	Forbbiden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.
403	Forbidden	User not authorized to operate on the specified resource.	EIP 不屬於目前呼叫者，請您檢查該 EIP 是否可被您呼叫。
404	InvalidVpnConnectionInstanceId.NotFound	The specified vpn connection instance id does not exist.	指定的 VPN 連線不存在，請您檢查該 VPN 連線 ID 是否正確。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。