UpdateIpsecServer - VPN Gateway - Alibaba Cloud ドキュメントセンター

IPsec サーバーの構成を更新します。

操作説明

IPsec サーバーの IpsecServerName のみを変更する場合、この操作は同期です。IpsecServerName 以外の構成を変更する場合、この操作は非同期です。
UpdateIpsecServer が非同期操作の場合、システムは最初にリクエスト ID を返しますが、変更タスクがバックグラウンドで実行中のため、IPsec サーバーの構成はまだ変更されていません。 DescribeVpnGateway を呼び出して VPN ゲートウェイインスタンスのステータスをクエリし、IPsec サーバー構成の変更ステータスを確認できます。
- VPN ゲートウェイインスタンスが updating 状態の場合、IPsec サーバーの構成は変更中です。
- VPN ゲートウェイインスタンスが アクティブな 状態の場合、IPsec サーバーの構成は変更済みです。
UpdateIpsecServer 操作は、同じ VPN ゲートウェイ配下の IPsec サーバー構成の同時変更をサポートしていません。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

vpc:UpdateIpsecServer

update

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	IPsec サーバーのリージョン ID。 DescribeRegions 操作を呼び出してリージョン ID をクエリできます。	cn-shanghai
IpsecServerId	string	必須	IPsec サーバーの ID。	iss-bp1bo3xuvcxo7ixll****
LocalSubnet	string	任意	ローカル CIDR ブロック。クライアント 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	任意	クライアント CIDR ブロック。クライアントの仮想ネットワークインターフェースコントローラー (NIC) に IP アドレスを割り当てる CIDR ブロックです。説明クライアント CIDR ブロックは VPC CIDR ブロックと競合できません。	10.0.0.0/24
IpsecServerName	string	任意	IPsec サーバーの名前。名前の長さは 1～100 文字である必要があります。	test
EffectImmediately	boolean	任意	現在ネゴシエーション済みの IPsec トンネルを削除してネゴシエーションを再開するかどうかを指定します。有効な値: true: 構成完了後、直ちにネゴシエーションを開始します。 false: インバウンドトラフィックが検出されたときにネゴシエーションを開始します。	false
IkeConfig	string	任意	位相 1 ネゴシエーションパラメーターの構成。有効な値: IkeVersion: インターネットキー交換プロトコルのバージョン。有効な値: ikev1 または ikev2。 IkeMode: IKE バージョンのネゴシエーションモード。デフォルト値: main。 IkeEncAlg: 位相 1 ネゴシエーションで使用される暗号化アルゴリズム。デフォルト値: aes。 IkeAuthAlg: 位相 1 ネゴシエーションで使用される認証アルゴリズム。デフォルト値: sha1。 IkePfs: 位相 1 ネゴシエーションで使用される Diffie-Hellman キー交換アルゴリズム。デフォルト値: group2。 IkeLifetime: 位相 1 ネゴシエーションで確立されるセキュリティ関連付け (SA) の有効期間。単位: 秒。有効な値: 0 ～ 86400。デフォルト値: 86400。 LocalId: IPsec サーバーの識別子。FQDN および IP アドレスフォーマットがサポートされています。 RemoteId: ピアの識別子。FQDN および IP アドレスフォーマットがサポートされています。	{"IkeVersion":"ikev2","IkeMode":"main","IkeEncAlg":"aes","IkeAuthAlg":"sha1","IkePfs":"group2","IkeLifetime":86400}
IpsecConfig	string	任意	位相 2 ネゴシエーションのパラメータ設定。有効な値: IpsecEncAlg: 位相 2 ネゴシエーションで使用される暗号化アルゴリズム。デフォルト値: aes。 IpsecAuthAlg: 位相 2 ネゴシエーションで使用される認証アルゴリズム。デフォルト値: sha1。 IpsecPfs: すべてのプロトコルパケットを転送します。位相 2 ネゴシエーションで使用される Diffie-Hellman キー交換アルゴリズム。デフォルト値: group2。 IpsecLifetime: 位相 2 ネゴシエーションで生成される SA のエポック。単位: 秒。有効な値: 0 ～ 86400。デフォルト値: 86400。	{"IpsecEncAlg":"aes","IpsecAuthAlg":"sha1","IpsecPfs":"group2","IpsecLifetime":86400}
PskEnabled	boolean	任意	事前共有鍵認証を有効にするかどうかを指定します。有効な値: true (事前共有鍵認証が有効であることを示します)。	true
Psk	string	任意	事前共有鍵。事前共有鍵は、IPsec サーバーとクライアント間の身分認証に使用されます。キーの長さは 1～100 文字である必要があります。 ListIpsecServers 操作を呼び出して、システムによって生成されたキーをクエリできます。説明 IPsec サーバーの事前共有鍵は、クライアントの認証キーと同じである必要があります。そうでない場合、IPsec サーバーとクライアント間で接続を確立できません。	Cfd123****
ClientToken	string	任意	リクエストのべき等性を確保するために使用されるクライアントトークン。クライアントを使用してトークンを生成できますが、異なるリクエスト間でトークンが一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができます。説明このパラメーターを指定しない場合、システムは API リクエストの RequestId を ClientToken として自動的に使用します。RequestId は API 呼び出しごとに異なる場合があります。	e4567-e89b-12d3-a456-42665544****
DryRun	string	任意	ドライランを実行するかどうかを指定します。有効な値: true: IPsec サーバーの構成を更新せずにドライランを実行します。システムは、必須パラメーターが指定されているか、リクエストフォーマットが有効か、およびビジネス制限を満たしているかを確認します。チェックに失敗した場合、対応するエラーメッセージが返されます。チェックに成功した場合、`DryRunOperation` が返されます。 false (デフォルト): ドライランを実行し、リクエストを送信します。チェックに成功した後、IPsec サーバーの構成が更新されます。	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.	指定された IPsec PFS はサポートされていません。
400	IllegalParam.AuthMethod	One authentication method (Psk or IDaaS) should be specified at least.	少なくとも 1 つの認証方式 (Psk または IDaaS) を指定する必要があります。
400	IllegalParam.LocalSubnet	The specified "LocalSubnet" (%s) is invalid.	ローカル CIDR ブロック (%s) が無効です。
400	IllegalParam.ClientIpPool	The specified "ClientIpPool" (%s) is invalid.
400	MissingParam.IDaaSInstanceId	The input parameter IDaaSInstanceId is mandatory when enable multi-factor authentication.	2 要素認証が有効な場合は、IDaaS インスタンス ID が必須です。
400	OperationFailed.NoRamPermission	Vpn Service has no permission to operate your IDaaS instances.	VPN サービスにお客様の IDaaS インスタンスを操作する権限がありません。
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.	クライアント IP プールのネットワークマスク長は 16 以上 29 以下である必要があります。
400	VpnRouteEntry.Conflict	The specified client IP pool conflicts with VPN connection or SSL server.	指定されたクライアント IP プールが VPN 接続または SSL サーバーと競合しています。
400	ClientIpPool.SubnetInvalid	The specified client IP pool cannot be used.	指定されたクライアント CIDR ブロックは利用できません。
400	InvalidClientIpPool.Conflict	The specified client IP pool conflicts with other resources in the same VPC.	クライアント CIDR ブロックが VPC 内の他のリソースと競合しています。
400	SystemBusy	The system is busy. Please try again later.
403	Forbidden	User not authorized to operate on the specified resource.	EIP が現在の呼び出し元に属していません。この EIP を操作する権限があるかどうかを確認してください。
404	InvalidIpsecServerId.NotFound	The specified IPsec server ID (%s) does not exist.
404	InvalidIDaaSInstanceId.NotFound	The specified IDaaS instance ID does not exist.	指定された IDaaS インスタンスの ID が存在しません。
409	OperationConflict	The operation against this instance is too frequent, please try again later.	リクエストの競合が発生しました。後でもう一度お試しください。

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。