IPsec-VPN接続の情報を照会します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
vpc:DescribeVpnConnections |
list |
VpnConnection
VpnConnection
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
IPsec-VPN 接続のリージョンID。 DescribeRegions 操作を呼び出して、リージョンIDを照会できます。 |
cn-hangzhou |
| VpnGatewayId |
string |
任意 |
VPNゲートウェイのインスタンスID。 |
vpn-bp1q8bgx4xnkx**** |
| CustomerGatewayId |
string |
任意 |
カスタマーゲートウェイのID。 |
cgw-bp1mvj4g9kogw**** |
| PageNumber |
integer |
任意 |
ページ番号。デフォルト値:1。 |
1 |
| PageSize |
integer |
任意 |
ページングクエリの1ページあたりのエントリ数。デフォルト値:10。有効な値:1~50。 |
10 |
| VpnConnectionId |
string |
任意 |
IPsec-VPN 接続のID。 |
vco-bp10lz7aejumd**** |
| Tag |
array<object> |
任意 |
IPsec-VPN 接続にバインドされたタグのリスト。 一度に最大 20 個のタグを指定できます。 |
|
|
object |
任意 |
タグ情報。 |
||
| Key |
string |
任意 |
タグキー。このパラメータを指定する場合、値を空の文字列にすることはできません。 タグキーは最大 64 文字で、 一度に最大 20 個のタグキーを指定できます。 |
TagKey |
| Value |
string |
任意 |
タグ値。 タグ値は最大 128 文字で、空の文字列にすることができます。 各タグキーは1つのタグ値に対応します。一度に最大 20 個のタグ値を指定できます。 |
TagValue |
| ResourceGroupId |
string |
任意 |
IPsec-VPN 接続が属するリソースグループのID。 ListResourceGroups 操作を呼び出して、リソースグループIDを照会できます。 |
rg-acfmzs372yg**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
レスポンスパラメータ。 |
||
| PageSize |
integer |
ページングクエリの1ページあたりのエントリ数。 |
10 |
| RequestId |
string |
リクエストID。 |
238752DC-0693-49BE-9C85-711D5691D3E5 |
| PageNumber |
integer |
ページ番号。 |
1 |
| TotalCount |
integer |
返されたエントリの合計数。 |
2 |
| VpnConnections |
object |
||
| VpnConnection |
array<object> |
IPsec-VPN 接続設定のリスト。 |
|
|
array<object> |
IPsec-VPN 接続の設定。 |
||
| Status |
string |
IPsec 接続のステータスです。
|
ipsec_sa_established |
| EnableNatTraversal |
boolean |
IPsec 接続に対して NAT 越えが有効かどうかを示します。
|
true |
| RemoteCaCertificate |
string |
ピアの CA 証明書です。 |
-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE----- |
| CreateTime |
integer |
IPsec 接続が作成された時刻を示す UNIX タイムスタンプです。単位はミリ秒です。 このタイムスタンプは UNIX 時間形式に従い、1970 年 1 月 1 日 00:00:00 協定世界時 (UTC) から IPsec 接続の作成時刻までの経過時間をミリ秒単位で表します。 |
1492753817000 |
| EffectImmediately |
boolean |
IPsec 接続の構成が即時に有効になるかどうかを示します。
|
true |
| VpnGatewayId |
string |
VPN ゲートウェイのインスタンス ID です。 |
vpn-bp1q8bgx4xnkm**** |
| LocalSubnet |
string |
IPsec 接続の Alibaba Cloud 側の CIDR ブロックです。 複数の CIDR ブロックが存在する場合、カンマ (,) で区切ります。 |
192.168.0.0/16,172.17.0.0/16 |
| VpnConnectionId |
string |
IPsec 接続の ID です。 |
vco-bp10lz7aejumd**** |
| RemoteSubnet |
string |
データセンター側の CIDR ブロックです。 複数の CIDR ブロックを指定する場合、カンマ (,) で区切ります。 |
10.0.0.0/8,172.16.0.0/16 |
| CustomerGatewayId |
string |
IPsec 接続に関連付けられたカスタマーゲートウェイのインスタンス ID です。 |
cgw-bp1mvj4g9kogw**** |
| Name |
string |
IPsec 接続の名前です。 |
nametest |
| EnableDpd |
boolean |
IPsec 接続に対してピア生存確認 (DPD) 機能が有効かどうかを示します。
|
true |
| IkeConfig |
object |
フェーズ 1 のネゴシエーションの構成です。 |
|
| RemoteId |
string |
IPsec 接続の Alibaba Cloud 側の ID です。 |
139.17.XX.XX |
| IkeLifetime |
integer |
IKE フェーズのライフタイムです。単位は秒です。 |
86400 |
| IkeEncAlg |
string |
IKE フェーズの暗号化アルゴリズムです。 |
aes |
| LocalId |
string |
IPsec 接続ピアのローカルデータセンター側の ID です。 |
116.64.XX.XX |
| IkeMode |
string |
IKE フェーズのネゴシエーションモードです。
|
main |
| IkeVersion |
string |
IKE プロトコルバージョンです。
IKEv1 と比較して、IKEv2 は SA ネゴシエーションプロシージャを簡素化し、複数セグメントを含むシナリオへの対応を強化しています。 |
ikev1 |
| IkePfs |
string |
IKE フェーズ 1 で使用される Diffie-Hellman (DH) グループです。 |
group2 |
| Psk |
string |
事前共有鍵です。 |
pgw6dy7**** |
| IkeAuthAlg |
string |
IKE フェーズの認証アルゴリズムです。 |
sha1 |
| IpsecConfig |
object |
フェーズ 2 のネゴシエーションの構成です。 |
|
| IpsecAuthAlg |
string |
IPsec 認証アルゴリズムです。 |
sha1 |
| IpsecLifetime |
integer |
IPsec ライフタイムです。単位は秒です。 |
86400 |
| IpsecEncAlg |
string |
IPsec 暗号化アルゴリズムです。 |
aes |
| IpsecPfs |
string |
IPsec フェーズで使用される Diffie-Hellman (DH) グループです。 |
group2 |
| VcoHealthCheck |
object |
IPsec 接続のヘルスチェック構成。 |
|
| Status |
string |
ヘルスチェックステータスです。
|
success |
| Dip |
string |
宛先 IP アドレスです。 |
192.168.0.1 |
| Interval |
integer |
ヘルスチェックの時間間隔です。単位は秒です。 |
2 |
| Retry |
integer |
ヘルスチェックのリトライパケット数です。 |
3 |
| Sip |
string |
送信元 IP アドレスです。 |
192.168.0.50 |
| Enable |
string |
ヘルスチェックの有効化ステータスです。
|
true |
| Policy |
string |
ヘルスチェックが失敗した場合に公開済みのルートを取り消すかどうかを示します。
|
revoke_route |
| VpnBgpConfig |
object |
IPsec 接続のボーダーゲートウェイプロトコル (BGP) ルーティング可能プロトコルの構成です。 |
|
| Status |
string |
BGP ルーティング可能プロトコルのネゴシエーションステータスです。
|
success |
| PeerBgpIp |
string |
ピア BGP IP アドレスです。 |
169.254.10.1 |
| TunnelCidr |
string |
IPsec 接続の BGP CIDR ブロックです。この CIDR ブロックは 169.254.0.0/16 内のサブネットであり、サブネットマスク長は 30 です。 |
169.254.10.0/30 |
| LocalBgpIp |
string |
Alibaba Cloud 側の BGP IP アドレスです。 |
169.254.10.2 |
| PeerAsn |
integer |
ピア自律システム番号です。 |
65530 |
| LocalAsn |
integer |
Alibaba Cloud 側の自律システム番号 (ASN) です。 |
65531 |
| AuthKey |
string |
BGP ルーティング可能プロトコルの認証キーです。 |
AuthKey**** |
| AttachType |
string |
IPsec 接続がアタッチされているリソースタイプです。
|
CEN |
| NetworkType |
string |
IPsec 接続のネットワークタイプです。
|
public |
| AttachInstanceId |
string |
トランジットルーターインスタンスが属する Cloud Enterprise Network (CEN) インスタンスのインスタンス ID です。 |
cen-lxxpbpalc776qz**** |
| Spec |
string |
IPsec 接続の帯域幅仕様です。単位は Mbps です。 |
1000M |
| State |
string |
IPsec 接続がトランジットルーターインスタンスにバインドされている状態です。
|
attached |
| TransitRouterId |
string |
IPsec 接続がアタッチされているトランジットルーターのインスタンス ID です。 |
tr-p0we2edef9qr44a85**** |
| TransitRouterName |
string |
トランジットルーターインスタンスの名前です。 |
nametest |
| CrossAccountAuthorized |
boolean |
IPsec 接続が別のアカウント下のトランジットルーターインスタンスにアタッチされているかどうかを示します。
|
false |
| InternetIp |
string |
IPsec 接続のゲートウェイ IP アドレスです。 説明
このパラメーターは、IPsec 接続がトランジットルーターインスタンスにアタッチされている場合にのみ返されます。 |
10.XX.XX.10 |
| Tag |
object |
||
| Tag |
array<object> |
IPsec 接続にアタッチされているタグのリストです。 |
|
|
object |
タグ情報です。 |
||
| Key |
string |
タグキーです。 |
TagKey |
| Value |
string |
タグ値です。 |
TagValue |
| TunnelOptionsSpecification |
object |
||
| TunnelOptions |
array<object> |
IPsec 接続のトンネル構成情報です。 TunnelOptionsSpecification 配列下のパラメーターは、デュアルトンネルモードの IPsec 接続をクエリする場合にのみ返されます。 |
|
|
array<object> |
トンネルの構成情報です。 |
||
| TunnelId |
string |
トンネル ID です。 |
tun-opsqc4d97wni27**** |
| CustomerGatewayId |
string |
トンネルに関連付けられているカスタマーゲートウェイの ID です。 |
cgw-p0wy363lucf1uyae8**** |
| EnableDpd |
string |
トンネルに対してピア生存確認 (DPD) 機能が有効かどうかを示します。
|
true |
| EnableNatTraversal |
string |
トンネルに対して NAT 越えが有効かどうかを示します。
|
true |
| InternetIp |
string |
トンネルの IP アドレスです。 |
47.21.XX.XX |
| RemoteCaCertificate |
string |
トンネルのリモート側の CA 証明書です。 このパラメーターは、VPN ゲートウェイインスタンスのタイプが SM (ステート暗号化) の場合にのみ返されます。 |
-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE----- |
| Role |
string |
トンネルのロールです。
|
master |
| TunnelIndex |
integer |
トンネルの作成順序です。
説明
このパラメーターは、IPsec 接続がトランジットルーターにアタッチされている場合にのみ返されます。 |
1 |
| State |
string |
トンネルのステータスです。
|
active |
| Status |
string |
IPsec 接続のステータスです。
|
ipsec_sa_established |
| TunnelBgpConfig |
object |
トンネルのボーダーゲートウェイプロトコル (BGP) 構成情報です。 |
|
| BgpStatus |
string |
ボーダーゲートウェイプロトコル (BGP) のネゴシエーションステータスです。
|
success |
| LocalAsn |
string |
トンネルのローカル側 (Alibaba Cloud 側) の自律システム番号 (ASN) です。 |
65530 |
| LocalBgpIp |
string |
トンネルのローカル側 (Alibaba Cloud 側) の BGP IP アドレスです。 |
169.254.10.1 |
| PeerAsn |
string |
トンネルピアの自律システム番号です。 |
65531 |
| PeerBgpIp |
string |
トンネルピアの BGP IP アドレスです。 |
169.254.10.2 |
| TunnelCidr |
string |
トンネルの BGP セグメントです。 |
169.254.10.0/30 |
| TunnelIkeConfig |
object |
フェーズ 1 のネゴシエーションの構成です。 |
|
| IkeAuthAlg |
string |
IKE 認証アルゴリズムです。 |
sha1 |
| IkeEncAlg |
string |
IKE 暗号化アルゴリズムです。 |
aes |
| IkeLifetime |
string |
IKE フェーズのライフタイムです。単位は秒です。 |
86400 |
| IkeMode |
string |
IKE ネゴシエーションモードです。
|
main |
| IkePfs |
string |
IKE フェーズ 1 で使用される Diffie-Hellman (DH) グループです。 |
group2 |
| IkeVersion |
string |
IKE プロトコルバージョンです。 |
ikev1 |
| LocalId |
string |
トンネルのローカル側 (Alibaba Cloud 側) の ID です。 |
47.21.XX.XX |
| Psk |
string |
事前共有鍵です。 |
123456**** |
| RemoteId |
string |
トンネルピアの ID です。 |
47.42.XX.XX |
| TunnelIpsecConfig |
object |
フェーズ 2 のネゴシエーションの構成です。 |
|
| IpsecAuthAlg |
string |
IPsec フェーズの認証アルゴリズムです。 |
sha1 |
| IpsecEncAlg |
string |
IPsec フェーズの暗号化アルゴリズムです。 |
aes |
| IpsecLifetime |
string |
IPsec フェーズのライフタイムです。単位は秒です。 |
86400 |
| IpsecPfs |
string |
IPsec フェーズの Diffie-Hellman (DH) グループです。 |
group2 |
| ZoneNo |
string |
トンネルがデプロイされているゾーンです。 |
ap-southeast-5a |
| EnableTunnelsBgp |
boolean |
トンネル BGP の有効化ステータスです。
|
true |
| ResourceGroupId |
string |
IPsec 接続が属するリソースグループの ID です。 ListResourceGroups API を呼び出して、リソースグループ情報をクエリできます。 |
rg-acfmzs372yg**** |
| TunnelBandwidth |
string |
単一の VPN トンネルの帯域幅仕様を指定します。有効値: |
Standard |
例
成功レスポンス
JSONJSON
{
"PageSize": 10,
"RequestId": "238752DC-0693-49BE-9C85-711D5691D3E5",
"PageNumber": 1,
"TotalCount": 2,
"VpnConnections": {
"VpnConnection": [
{
"Status": "ipsec_sa_established",
"EnableNatTraversal": true,
"RemoteCaCertificate": "-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----",
"CreateTime": 1492753817000,
"EffectImmediately": true,
"VpnGatewayId": "vpn-bp1q8bgx4xnkm****",
"LocalSubnet": "192.168.0.0/16,172.17.0.0/16",
"VpnConnectionId": "vco-bp10lz7aejumd****",
"RemoteSubnet": "10.0.0.0/8,172.16.0.0/16",
"CustomerGatewayId": "cgw-bp1mvj4g9kogw****",
"Name": "nametest",
"EnableDpd": true,
"IkeConfig": {
"RemoteId": "139.17.XX.XX",
"IkeLifetime": 86400,
"IkeEncAlg": "aes",
"LocalId": "116.64.XX.XX",
"IkeMode": "main",
"IkeVersion": "ikev1",
"IkePfs": "group2",
"Psk": "pgw6dy7****",
"IkeAuthAlg": "sha1"
},
"IpsecConfig": {
"IpsecAuthAlg": "sha1",
"IpsecLifetime": 86400,
"IpsecEncAlg": "aes",
"IpsecPfs": "group2"
},
"VcoHealthCheck": {
"Status": "success",
"Dip": "192.168.0.1",
"Interval": 2,
"Retry": 3,
"Sip": "192.168.0.50",
"Enable": "true",
"Policy": "revoke_route"
},
"VpnBgpConfig": {
"Status": "success",
"PeerBgpIp": "169.254.10.1",
"TunnelCidr": "169.254.10.0/30",
"LocalBgpIp": "169.254.10.2",
"PeerAsn": 65530,
"LocalAsn": 65531,
"AuthKey": "AuthKey****"
},
"AttachType": "CEN",
"NetworkType": "public",
"AttachInstanceId": "cen-lxxpbpalc776qz****",
"Spec": "1000M",
"State": "attached",
"TransitRouterId": "tr-p0we2edef9qr44a85****",
"TransitRouterName": "nametest",
"CrossAccountAuthorized": false,
"InternetIp": "10.XX.XX.10",
"Tag": {
"Tag": [
{
"Key": "TagKey",
"Value": "TagValue"
}
]
},
"TunnelOptionsSpecification": {
"TunnelOptions": [
{
"TunnelId": "tun-opsqc4d97wni27****",
"CustomerGatewayId": "cgw-p0wy363lucf1uyae8****",
"EnableDpd": "true",
"EnableNatTraversal": "true",
"InternetIp": "47.21.XX.XX",
"RemoteCaCertificate": "-----BEGIN CERTIFICATE----- MIIB7zCCAZW**** -----END CERTIFICATE-----",
"Role": "master",
"TunnelIndex": 1,
"State": "active",
"Status": "ipsec_sa_established",
"TunnelBgpConfig": {
"BgpStatus": "success",
"LocalAsn": "65530",
"LocalBgpIp": "169.254.10.1",
"PeerAsn": "65531",
"PeerBgpIp": "169.254.10.2",
"TunnelCidr": "169.254.10.0/30"
},
"TunnelIkeConfig": {
"IkeAuthAlg": "sha1",
"IkeEncAlg": "aes",
"IkeLifetime": "86400",
"IkeMode": "main",
"IkePfs": "group2",
"IkeVersion": "ikev1",
"LocalId": "47.21.XX.XX",
"Psk": "123456****",
"RemoteId": "47.42.XX.XX"
},
"TunnelIpsecConfig": {
"IpsecAuthAlg": "sha1",
"IpsecEncAlg": "aes",
"IpsecLifetime": "86400",
"IpsecPfs": "group2"
},
"ZoneNo": "ap-southeast-5a"
}
]
},
"EnableTunnelsBgp": true,
"ResourceGroupId": "rg-acfmzs372yg****",
"TunnelBandwidth": "Standard"
}
]
}
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 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. | |
| 400 | InvalidParameter.TagKey | The specified parameter TagKey is invalid. | |
| 400 | Duplicated.TagKey | The specified parameter TagKey is duplicated. | |
| 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. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。