IPsec サーバの構成を変更します。
操作説明
-
IPsec サーバの IpsecServerName のみを変更する場合、この操作は同期操作です。IpsecServerName 以外のパラメーターを変更する場合、この操作は非同期操作です。
-
UpdateIpsecServer が非同期操作の場合、リクエスト送信後、システムはリクエスト ID を返し、バックグラウンドでタスクを実行します。タスクのステータスを確認するには、DescribeVpnGateway 操作を呼び出してください。
VPN ゲートウェイのステータスが updating の場合、IPsec サーバは変更中です。
VPN ゲートウェイのステータスが active の場合、IPsec サーバの変更は完了しています。
-
指定された時間内に UpdateIpsecServer を繰り返し呼び出すことはできません。
今すぐお試しください
テスト
RAM 認証
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
IPsec サーバを作成するリージョンの ID です。 最新のリージョンリストを取得するには、DescribeRegions 操作を呼び出してください。 |
cn-shanghai |
| IpsecServerId |
string |
必須 |
IPsec サーバ ID です。 |
iss-bp1bo3xuvcxo7ixll**** |
| LocalSubnet |
string |
任意 |
ローカル CIDR ブロック。クライアントがアクセスする仮想プライベートクラウド (VPC) の CIDR ブロックです。 複数の CIDR ブロックを指定する場合は、カンマ (,) で区切ります。例:192.168.1.0/24,192.168.2.0/24 |
192.168.0.0/24,172.17.0.0/16 |
| ClientIpPool |
string |
任意 |
クライアントの仮想 NIC に IP アドレスを割り当てるためのクライアント CIDR ブロックです。 説明
クライアント CIDR ブロックは、VPC の CIDR ブロックと重複してはいけません。 |
10.0.0.0/24 |
| IpsecServerName |
string |
任意 |
IPsec サーバの名前です。 長さは 1~100 文字である必要があります。 |
test |
| EffectImmediately |
boolean |
任意 |
ネゴシエーション済みの IPsec トンネルを削除して再ネゴシエーションを開始するかどうかを指定します。有効値:
|
false |
| IkeConfig |
string |
任意 |
フェーズ 1 ネゴシエーションの構成です。有効値:
|
{"IkeVersion":"ikev2","IkeMode":"main","IkeEncAlg":"aes","IkeAuthAlg":"sha1","IkePfs":"group2","IkeLifetime":86400} |
| IpsecConfig |
string |
任意 |
フェーズ 2 ネゴシエーションの構成です。有効な値は以下のとおりです。
|
{"IpsecEncAlg":"aes","IpsecAuthAlg":"sha1","IpsecPfs":"group2","IpsecLifetime":86400} |
| PskEnabled |
boolean |
任意 |
事前共有鍵認証を有効にするかどうかを指定します。値を true に設定すると、事前共有鍵認証が有効になります。 |
true |
| Psk |
string |
任意 |
事前共有鍵です。 IPsec サーバとクライアント間の認証に使用される事前共有鍵です。鍵の長さは 1~100 文字である必要があります。 システムが生成したキーを確認するには、ListIpsecServers を呼び出してください。 説明
IPsec サーバの事前共有鍵は、クライアントのものと一致している必要があります。一致しない場合、IPsec サーバとクライアント間の接続は確立できません。 |
Cfd123**** |
| ClientToken |
string |
任意 |
リクエストのべき等性を保証するために使用されるクライアントトークンです。 クライアント側で値を生成できますが、各リクエストに一意のトークン値を指定する必要があります。クライアントトークンには ASCII 文字のみを使用できます。 説明
このパラメーターを指定しない場合、システムは自動的に RequestId の値を ClientToken の値として使用します。リクエスト ID はリクエストごとに異なる場合があります。 |
e4567-e89b-12d3-a456-42665544**** |
| DryRun |
string |
任意 |
このリクエストを事前チェックのみ行うかどうかを指定します。有効値:
|
false |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
返された結果です。 |
||
| RequestId |
string |
リクエスト ID です。 |
B61C08E5-403A-46A2-96C1-F7B1216DB10C |
例
成功レスポンス
JSONJSON
{
"RequestId": "B61C08E5-403A-46A2-96C1-F7B1216DB10C"
}
エラーコード
|
HTTP ステータスコード |
エラーコード |
エラーメッセージ |
説明 |
|---|---|---|---|
| 400 | VpnGateway.Configuring | The specified service is configuring. | |
| 400 | VpnGateway.FinancialLocked | The specified service is financial locked. | |
| 400 | OperationUnsupported.IpsecPfs | The specified IPsec Pfs is unsupported. | |
| 400 | IllegalParam.AuthMethod | One authentication method (Psk or IDaaS) should be specified at least. | |
| 400 | IllegalParam.LocalSubnet | The specified "LocalSubnet" (%s) is invalid. | |
| 400 | IllegalParam.ClientIpPool | The specified "ClientIpPool" (%s) is invalid. | |
| 400 | MissingParam.IDaaSInstanceId | The input parameter IDaaSInstanceId is mandatory when enable multi-factor authentication. | |
| 400 | OperationFailed.NoRamPermission | Vpn Service has no permission to operate your IDaaS instances. | |
| 400 | OperationFailed.AddVpcRoute | It's failed to add VPC route after this operation. | |
| 400 | ClientIpPool.NetmaskInvalid | The netmask length of client IP pool must be greater than or equal to 16 and less than or equal to 29. | |
| 400 | VpnRouteEntry.Conflict | The specified client IP pool conflicts with VPN connection or SSL server. | |
| 400 | ClientIpPool.SubnetInvalid | The specified client IP pool cannot be used. | |
| 400 | InvalidClientIpPool.Conflict | The specified client IP pool conflicts with other resources in the same VPC. | |
| 400 | SystemBusy | The system is busy. Please try again later. | |
| 403 | Forbidden | User not authorized to operate on the specified resource. | |
| 404 | InvalidIpsecServerId.NotFound | The specified IPsec server ID (%s) does not exist. | |
| 404 | InvalidIDaaSInstanceId.NotFound | The specified IDaaS instance ID does not exist. | |
| 409 | OperationConflict | The operation against this instance is too frequent, please try again later. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。