IPsec サーバをクエリします。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
IPsec サーバが作成されたリージョンの ID です。 最新のリージョンリストをクエリするには、DescribeRegions 操作を呼び出してください。 |
cn-hangzhou |
| IpsecServerName |
string |
任意 |
IPsec サーバの名前です。 名前の長さは 1~100 文字である必要があります。 |
test |
| VpnGatewayId |
string |
任意 |
VPN ゲートウェイの ID です。 |
vpn-bp1q8bgx4xnkm2ogj**** |
| NextToken |
string |
任意 |
次のリクエストで新しい結果ページを取得するために使用されるページネーショントークンです。有効な値は以下のとおりです。
|
caeba0bbb2be03f84eb48b699f0a**** |
| MaxResults |
integer |
任意 |
各ページに返されるエントリ数です。有効な値:1~20。デフォルト値:10。 |
10 |
| IpsecServerId |
array |
任意 |
IPsec サーバの ID です。 |
iss-bp1bo3xuvcxo7ixll**** |
|
string |
任意 |
IPsec サーバの ID です。N の有効な値:1~20。 |
iss-bp1bo3xuvcxo7ixll**** |
|
| ResourceGroupId |
string |
任意 |
IPsec サーバが属するリソースグループの ID です。 IPsec サーバおよび関連付けられた VPN ゲートウェイは同じリソースグループに属します。DescribeVpnGateway を呼び出して、VPN ゲートウェイが属するリソースグループの ID をクエリできます。 |
rg-acfmzs372yg**** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| NextToken |
string |
ページネーショントークンです。次のリクエストで新しい結果ページを取得するために使用できます。有効な値は以下のとおりです。
|
caeba0bbb2be03f84eb48b699f0a**** |
| RequestId |
string |
リクエスト ID です。 |
54B48E3D-DF70-471B-AA93-08E683A1B457 |
| TotalCount |
integer |
返されたエントリの総数です。 |
10 |
| MaxResults |
integer |
ページごとに返されるエントリ数です。 |
1 |
| IpsecServers |
array<object> |
IPsec サーバのリストです。 |
|
|
array<object> |
|||
| CreationTime |
string |
IPsec サーバが作成された時刻です。 デリミタとして T が使用されます。Z は時刻が協定世界時 (UTC) であることを示します。 |
2018-12-03T10:11:55Z |
| OnlineClientCount |
integer |
IPsec サーバに接続されているクライアントの数です。 |
1 |
| InternetIp |
string |
VPN ゲートウェイのパブリック IP アドレスです。 |
47.22.XX.XX |
| IpsecServerName |
string |
IPsec サーバの名前です。 |
test |
| IDaaSInstanceId |
string |
IDaaS インスタンスの ID です。 |
idaas-cn-hangzhou-**** |
| EffectImmediately |
boolean |
現在の IPsec トンネルを削除してネゴシエーションを再開するかどうかを示します。有効な値は以下のとおりです。
|
false |
| VpnGatewayId |
string |
VPN ゲートウェイの ID です。 |
vpn-bp1q8bgx4xnkm2ogj**** |
| LocalSubnet |
string |
ローカル CIDR ブロックです。これは VPC 側の CIDR ブロックを指します。 |
192.168.0.0/16,172.17.0.0/16 |
| Psk |
string |
事前共有鍵です。 |
pgw6dy7d**** |
| RegionId |
string |
IPsec サーバが作成されたリージョンの ID です。 |
cn-hangzhou |
| PskEnabled |
boolean |
事前共有鍵認証が有効かどうかを示します。true のみが返される可能性があり、これは事前共有鍵認証が有効であることを示します。 |
true |
| IpsecServerId |
string |
IPsec サーバ ID です。 |
iss-bp1bo3xuvcxo7ixll**** |
| MultiFactorAuthEnabled |
boolean |
二要素認証が有効かどうかを示します。有効な値は以下のとおりです。
|
true |
| MaxConnections |
integer |
VPN ゲートウェイがサポートする SSL-VPN 接続数です。 説明
このパラメーターで指定された SSL-VPN 接続数には、SSL-VPN 接続および IPsec 接続の両方が含まれます。たとえば、5 つの SSL-VPN 接続があり、3 つの SSL クライアントが 3 つの SSL-VPN 接続を使用している場合、2 つのクライアントが IPsec サーバに接続できます。 |
5 |
| ClientIpPool |
string |
クライアント CIDR ブロックです。これはクライアントの仮想インターフェイスに割り当てられる CIDR ブロックを指します。 |
10.0.0.0/24 |
| IkeConfig |
object |
フェーズ 1 ネゴシエーションの構成です。 |
|
| RemoteId |
string |
カスタマーゲートウェイの識別子です。完全修飾ドメイン名 (FQDN) および IP アドレスの両方がサポートされています。デフォルトでは、このパラメーターは空です。 |
139.67.XX.XX |
| IkeLifetime |
integer |
IKE のライフタイムです。単位:秒。 |
86400 |
| IkeEncAlg |
string |
IKE 暗号化アルゴリズムです。 |
aes |
| LocalId |
string |
IPsec サーバの ID です。デフォルト値は VPN ゲートウェイのパブリック IP アドレスです。FQDN および IP アドレスの両方がサポートされています。 |
116.64.XX.XX |
| IkeMode |
string |
IKE ネゴシエーションモードです。有効な値: main:このモードはネゴシエーション中に高いセキュリティを提供します。 |
main |
| IkeVersion |
string |
IKE バージョンです。 |
ikev2 |
| IkePfs |
string |
Diffie-Hellman キー交換アルゴリズムです。 |
group2 |
| IkeAuthAlg |
string |
IKE 認証アルゴリズムです。 |
sha1 |
| IpsecConfig |
object |
フェーズ 2 ネゴシエーションの構成です。 |
|
| IpsecAuthAlg |
string |
IPsec 認証アルゴリズムです。 |
sha1 |
| IpsecLifetime |
integer |
IPsec のライフタイムです。単位:秒。 |
86400 |
| IpsecEncAlg |
string |
IPsec 暗号化アルゴリズムです。 |
aes |
| IpsecPfs |
string |
Diffie-Hellman キー交換アルゴリズムです。 |
group2 |
| ResourceGroupId |
string |
IPsec サーバが属するリソースグループの ID です。 ListResourceGroups 操作を呼び出して、リソースグループ情報をクエリできます。 |
rg-acfmzs372yg**** |
例
成功レスポンス
JSONJSON
{
"NextToken": "caeba0bbb2be03f84eb48b699f0a****",
"RequestId": "54B48E3D-DF70-471B-AA93-08E683A1B457",
"TotalCount": 10,
"MaxResults": 1,
"IpsecServers": [
{
"CreationTime": "2018-12-03T10:11:55Z",
"OnlineClientCount": 1,
"InternetIp": "47.22.XX.XX",
"IpsecServerName": "test",
"IDaaSInstanceId": "idaas-cn-hangzhou-****",
"EffectImmediately": false,
"VpnGatewayId": "vpn-bp1q8bgx4xnkm2ogj****",
"LocalSubnet": "192.168.0.0/16,172.17.0.0/16",
"Psk": "pgw6dy7d****",
"RegionId": "cn-hangzhou",
"PskEnabled": true,
"IpsecServerId": "iss-bp1bo3xuvcxo7ixll****",
"MultiFactorAuthEnabled": true,
"MaxConnections": 5,
"ClientIpPool": "10.0.0.0/24",
"IkeConfig": {
"RemoteId": "139.67.XX.XX",
"IkeLifetime": 86400,
"IkeEncAlg": "aes",
"LocalId": "116.64.XX.XX",
"IkeMode": "main",
"IkeVersion": "ikev2",
"IkePfs": "group2",
"IkeAuthAlg": "sha1"
},
"IpsecConfig": {
"IpsecAuthAlg": "sha1",
"IpsecLifetime": 86400,
"IpsecEncAlg": "aes",
"IpsecPfs": "group2"
},
"ResourceGroupId": "rg-acfmzs372yg****"
}
]
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | IllegalParam.NextToken | The specified NextToken is invalid. | |
| 403 | Forbidden | User not authorized to operate on the specified resource. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。