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

ModifySslVpnServerオペレーションを呼び出して、SSL-VPNサーバーの設定を変更します。

操作説明

SSLサーバーで二要素認証を有効にする場合は、まずVPNゲートウェイインスタンスがこの機能をサポートしていることを確認してください。VPNゲートウェイインスタンスのアップグレードが必要な場合があります。詳細については、SSL-VPN 二要素認証がIDaaS EIAM 2.0をサポートを参照してください。
SSL-VPNサーバーのNameのみを変更する場合、このオペレーションは同期です。Name 以外の設定も変更する場合、このオペレーションは非同期です。
ModifySslVpnServerオペレーションが非同期の場合、システムはまずリクエストIDを返しますが、SSL-VPNサーバーの設定はまだ変更されておらず、変更タスクはバックグラウンドで進行中です。 DescribeVpnGateway オペレーションを呼び出して、SSL-VPNサーバーに関連付けられたVPNゲートウェイインスタンスのステータスを照会し、SSL-VPNサーバー設定の変更ステータスを確認できます：
- VPNゲートウェイインスタンスがupdating 状態の場合、SSL-VPNサーバーの設定は変更中です。
- VPNゲートウェイインスタンスがactive 状態の場合、SSL-VPNサーバーの設定は正常に変更されています。
ModifySslVpnServerオペレーションは、同じVPNゲートウェイ下のSSL-VPNサーバー設定の同時変更をサポートしていません。

今すぐお試しください

この 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:ModifySslVpnServer

update

*SslVpnServer

acs:vpc:{#regionId}:{#accountId}:sslvpnserver/{#SslVpnServerId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。異なるリクエスト間で一意性を確保するために、クライアントからパラメーター値を生成してください。ClientTokenはASCII 文字のみをサポートしています。説明このパラメーターを指定しない場合、システムはAPIリクエストのRequestIdをClientTokenとして自動的に使用します。各 APIリクエストのRequestIdは異なります。	02fb3da4-130e-11e9-8e44-0016e04115b
RegionId	string	必須	VPNゲートウェイのリージョンID。 DescribeRegions オペレーションを呼び出して、リージョンIDを照会できます。	cn-hangzhou
SslVpnServerId	string	必須	SSL-VPNサーバーインスタンスのID。	vss-bp18q7hzj6largv4v****
Name	string	任意	SSL-VPNサーバーの名前。名前は1〜100 文字で、`http://`または`https://`で始めることはできません。	test
ClientIpPool	string	任意	クライアントCIDRブロック。これはクライアントの仮想ネットワークインターフェースにIPアドレスを割り当てるために使用されるCIDRブロックであり、クライアントの既存の内部 CIDRブロックではありません。クライアントがSSL-VPN 接続を介してローカルエンドにアクセスすると、VPNゲートウェイは指定されたクライアントCIDRブロックからクライアントにIPアドレスを割り当てます。クライアントは割り当てられたIPアドレスを使用してクラウドリソースにアクセスします。クライアントCIDRブロックを指定する場合、クライアントCIDRブロック内のIPアドレスの数が、現在のVPNゲートウェイのSSL 接続数の少なくとも4 倍であることを確認してください。理由を表示するにはクリックしてください。たとえば、指定するクライアントCIDRブロックが192.168.0.0/24の場合、システムがクライアントにIPアドレスを割り当てるとき、まず192.168.0.0/24 CIDRブロックから30ビットのサブネットマスクを持つサブネット（192.168.0.4/30など）を分割し、次に192.168.0.4/30から1つのIPアドレスをクライアントの使用のために割り当てます。残りの3つのIPアドレスは、ネットワーク通信を確保するためにシステムが使用します。この場合、1つのクライアントは4つのIPアドレスを消費します。したがって、すべてのクライアントにIPアドレスを割り当てられるようにするには、指定するクライアントCIDRブロック内のIPアドレスの数がVPNゲートウェイのSSL 接続数の少なくとも4 倍であることを確認してください。サポートされていないCIDRブロックを表示するにはクリックしてください。 100.64.0.0~100.127.255.255 127.0.0.0~127.255.255.255 169.254.0.0~169.254.255.255 224.0.0.0~239.255.255.255 255.0.0.0~255.255.255.255 SSL 接続数ごとの推奨クライアントCIDRブロックを表示するにはクリックしてください。 SSL 接続数が5の場合、クライアントCIDRブロックのサブネットマスクは27ビット以下である必要があります。例：10.0.0.0/27または10.0.0.0/26。 SSL 接続数が10の場合、クライアントCIDRブロックのサブネットマスクは26ビット以下である必要があります。例：10.0.0.0/26または10.0.0.0/25。 SSL 接続数が20の場合、クライアントCIDRブロックのサブネットマスクは25ビット以下である必要があります。例：10.0.0.0/25または10.0.0.0/24。 SSL 接続数が50の場合、クライアントCIDRブロックのサブネットマスクは24ビット以下である必要があります。例：10.0.0.0/24または10.0.0.0/23。 SSL 接続数が100の場合、クライアントCIDRブロックのサブネットマスクは23ビット以下である必要があります。例：10.0.0.0/23または10.0.0.0/22。 SSL 接続数が200の場合、クライアントCIDRブロックのサブネットマスクは22ビット以下である必要があります。例：10.0.0.0/22または10.0.0.0/21。 SSL 接続数が500の場合、クライアントCIDRブロックのサブネットマスクは21ビット以下である必要があります。例：10.0.0.0/21または10.0.0.0/20。 SSL 接続数が1000の場合、クライアントCIDRブロックのサブネットマスクは20ビット以下である必要があります。例：10.0.0.0/20または10.0.0.0/19。説明クライアントCIDRブロックのサブネットマスクは16〜29ビットの範囲である必要があります。クライアントCIDRブロックがローカルサブネット、VPC CIDRブロック、またはクライアント端末に関連するルートCIDRブロックと重複しないことを確認してください。クライアントCIDRブロックを指定する場合、10.0.0.0/8、172.16.0.0/12、および192.168.0.0/16のCIDRブロックとそのサブネットを使用してください。パブリックCIDRブロックをクライアントCIDRブロックとして指定する必要がある場合は、VPCがパブリックCIDRブロックにアクセスできるように、パブリックCIDRブロックをVPCのユーザーCIDRブロックとして設定する必要があります。ユーザーCIDRブロックの詳細については、VPC FAQを参照してください。 SSLサーバーの作成後、システムはクライアントCIDRブロックのルートをVPCインスタンスのルートテーブルに自動的に追加します。VPCインスタンスのルートテーブルにクライアントCIDRブロックのルートを手動で追加しないでください。追加した場合、SSL-VPN 接続のトラフィック送信が異常になります。	10.30.30.0/24
LocalSubnet	string	任意	ローカルサブネット。クライアントがSSL-VPN 接続を介してアクセスする必要があるCIDRブロック。ローカルサブネットには、VPCのCIDRブロック、vSwitch、Express Connectを介してVPCと相互接続されたIDC、またはObject Storage Service（OSS）などのクラウドサービスを指定できます。ローカルサブネットのサブネットマスクは8〜32ビットの範囲である必要があります。以下のCIDRブロックはローカルサブネットとして指定できません： 127.0.0.0~127.255.255.255 169.254.0.0~169.254.255.255 224.0.0.0~239.255.255.255 255.0.0.0~255.255.255.255。	10.20.20.0/24
Proto	string	任意	SSL-VPNサーバーが使用するプロトコル。有効な値： TCP（デフォルト）：TCPプロトコル。 UDP：UDPプロトコル。	UDP
Cipher	string	任意	SSL-VPNで使用する暗号化アルゴリズム。有効な値： AES-128-CBC（デフォルト）：AES-128-CBCアルゴリズム。 AES-192-CBC：AES-192-CBCアルゴリズム。 AES-256-CBC：AES-256-CBCアルゴリズム。 none：暗号化アルゴリズムを使用しません。	AES-128-CBC
Port	integer	任意	SSL-VPNサーバーが使用するポート。有効な値：1〜65535。デフォルト値：1194。次のポートはサポートされていません：22、2222、22222、9000、9001、9002、7505、80、443、53、68、123、4510、4560、500、および4500。	1194
Compress	boolean	任意	通信を圧縮するかどうかを指定します。有効な値： true（デフォルト）：通信を圧縮します。 false：通信を圧縮しません。	true
EnableMultiFactorAuth	boolean	任意	二要素認証を有効にするかどうかを指定します。二要素認証を有効にする場合は、IDaaSInstanceId、IDaaSRegionId、およびIDaaSApplicationIdも設定する必要があります。有効な値： true：有効。 false：無効。説明二要素認証機能を初めて使用する場合は、SSLサーバーを作成する前に権限付与を完了してください。 UAE（ドバイ）リージョンでSSLサーバーを作成する場合は、クロスリージョンレイテンシーを削減するために、シンガポールリージョンのIDaaS EIAM 2.0インスタンスをバインドしてください。 IDaaS EIAM 1.0インスタンスは購入できなくなりました。Alibaba Cloudアカウントに既存のIDaaS EIAM 1.0インスタンスがある場合は、二要素認証を有効にした後もバインドできます。Alibaba CloudアカウントにIDaaS EIAM 1.0インスタンスがない場合は、二要素認証を有効にした後、IDaaS EIAM 2.0インスタンスのみをバインドできます。	false
IDaaSInstanceId	string	任意	IDaaS EIAMインスタンスのID。	idaas-cn-hangzhou-****
IDaaSRegionId	string	任意	IDaaS EIAMインスタンスのリージョンID。	cn-hangzhou
IDaaSApplicationId	string	任意	IDaaSアプリケーションのID。 IDaaS EIAM 2.0インスタンスをバインドする場合は、IDaaSアプリケーションIDを入力する必要があります。 IDaaS EIAM 1.0インスタンスをバインドする場合は、IDaaSアプリケーションIDを入力する必要はありません。	app_my6g4qmvnwxzj2f****
DryRun	boolean	任意	設定を実際に変更せずにドライランのみを実行するかどうかを指定します。有効な値： true：SSLサーバーの設定を変更せずにチェックリクエストを送信します。チェック項目には、すべての必須パラメーターが指定されているか、リクエストのフォーマット、およびサービス制限が含まれます。チェックに失敗した場合、対応するエラーが返されます。チェックに合格した場合、エラーコード`DryRunOperation`が返されます。 false（デフォルト）：通常のリクエストを送信します。チェックに合格した後、HTTP 2xxステータスコードが返され、オペレーションが実行されます。	false

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
InternetIp	string	パブリックIPアドレス。	47.98.XX.XX
IDaaSInstanceId	string	IDaaS EIAMインスタンスのID。	idaas-cn-hangzhou-****
CreateTime	integer	SSL-VPNサーバーの作成時刻。	1492753580000
VpnGatewayId	string	VPNゲートウェイインスタンスのID。	vpn-bp1q8bgx4xnkm2ogj****
Compress	boolean	通信が圧縮されているかどうかを示します。	false
Port	integer	SSL-VPNサーバーのポート。	1194
LocalSubnet	string	ローカルサブネット。	10.20.20.0/24
RegionId	string	SSL-VPNサーバーのリージョンID。	cn-hangzhou
Cipher	string	使用される暗号化アルゴリズム。	AES-128-CBC
RequestId	string	リクエストID。	DF11D6F6-E35A-41C3-9B20-6FC8A901FE65
Connections	integer	現在の接続数。	0
SslVpnServerId	string	SSL-VPNサーバーのID。	vss-bp18q7hzj6largv4v****
MaxConnections	integer	最大接続数。	5
Name	string	SSL-VPNサーバーの名前。	test
EnableMultiFactorAuth	boolean	二要素認証が有効かどうかを示します。 true：有効。 false（デフォルト）：無効。	false
ClientIpPool	string	クライアントCIDRブロック。	10.30.30.0/24
Proto	string	SSL-VPNサーバーが使用するプロトコル。	UDP
ResourceGroupId	string	SSL-VPNサーバーが属するリソースグループのID。 SSL-VPNサーバーのリソースグループは、関連付けられたVPNゲートウェイインスタンスのリソースグループと同じです。 ListResourceGroups オペレーションを呼び出して、リソースグループ情報を照会できます。	rg-acfmzs372yg****
IDaaSApplicationId	string	IDaaSアプリケーションのID。	app_my6g4qmvnwxzj2f****
IDaaSInstanceVersion	string	IDaaS EIAMインスタンスのバージョン。このパラメーターは、SSLサーバーがIDaaS EIAM 2.0インスタンスにバインドされている場合にのみ返されます。唯一の有効な値はEIAM 2.0です。 SSLサーバーがIDaaS EIAM 1.0インスタンスにバインドされている場合、このパラメーターは返されません。	EIAM 2.0

例

成功レスポンス

JSONJSON

{
  "InternetIp": "47.98.XX.XX",
  "IDaaSInstanceId": "idaas-cn-hangzhou-****",
  "CreateTime": 1492753580000,
  "VpnGatewayId": "vpn-bp1q8bgx4xnkm2ogj****",
  "Compress": false,
  "Port": 1194,
  "LocalSubnet": "10.20.20.0/24",
  "RegionId": "cn-hangzhou",
  "Cipher": "AES-128-CBC",
  "RequestId": "DF11D6F6-E35A-41C3-9B20-6FC8A901FE65",
  "Connections": 0,
  "SslVpnServerId": "vss-bp18q7hzj6largv4v****",
  "MaxConnections": 5,
  "Name": "test",
  "EnableMultiFactorAuth": false,
  "ClientIpPool": "10.30.30.0/24",
  "Proto": "UDP",
  "ResourceGroupId": "rg-acfmzs372yg****",
  "IDaaSApplicationId": "app_my6g4qmvnwxzj2f****",
  "IDaaSInstanceVersion": "EIAM 2.0"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidName	The name is not valid
400	VpnGateway.Configuring	The specified service is configuring.
400	VpnGateway.FinancialLocked	The specified service is financial locked.
400	IpConflict	Client IP pool conflict with local IP range.
400	SslVpnServer.AddRouteError	Add route error whose destination is client IP pool, please check vpc route entry and relevant quota.
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	ClientIpPool.SubnetInvalid	The specified client IP pool cannot be used.
400	MissingParameter.IDaaSInstanceId	The input parameter IDaaSInstanceId is mandatory when enable multi-factor authentication.
400	OperationFailed.GetIDaaSInfo	Failed to get secret key from your IDaaS instance.
400	OperationFailed.NoRamPermission	Vpn Service has no permission to operate your IDaaS instances.
400	OperationUnsupported.NotSupportMultiFactorAuth	Current version of the VPN does not support multi-factor authentication.
400	SystemBusy	The system is busy. Please try again later.
400	SslVpnServerPort.Illegal	The server port is not in the range of [1-65535].
400	EnableHaCheck.SslVpnServerClientCidrContainsVpcRouteDest	Ssl vpn client cidr contains vpc route prefix. The vpc route prefix is %s.
400	InvalidInstanceId.NotFound	InstanceId is not found.
400	VpnRouteEntry.Conflict	The specified route entry has conflict.
400	IllegalParam.IDaaSApplicationId	The specified IDaaS application Id is not illegal, the application instance needs to be created based on the dedicated SSL VPN template.
400	MissingParam.IDaaSApplicationId	The input parameter IDaaSApplicationId is mandatory when enable multi-factor authentication.
400	SslVpnIDaaS2.NotSupport	Current version of the VPN does not support IDaaS2.0.
400	MissingParam.IDaaSRegionId	The input parameter IDaaSRegionId is mandatory when enable multi-factor authentication.
400	DryRunOperation	Request validation has been passed with DryRun flag set.
400	IllegalParam.LocalSubnet	The specified "LocalSubnet" (%s) is invalid.
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.
404	InvalidRegionId.NotFound	The specified region is not found during access authentication.
404	InvalidIDaaSInstanceId.NotFound	The specified IDaaS instance ID does not exist.
404	InvalidIDaaSApplicationId.NotFound	The specified IDaaS application Id does not exist.

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

変更履歴

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