ModifySslVpnServer - VPN Gateway

呼叫 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 服務端的設定資訊。

調試

您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

操作：是指具體的許可權點。
存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用全部資源表示。
條件關鍵字：是指雲產品自身定義的條件關鍵字。
關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:ModifySslVpnServer

update

*SslVpnServer

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

無

請求參數

名稱	類型	必填	描述	樣本值
ClientToken	string	否	用戶端 Token，用於保證請求的冪等性。從您的用戶端產生一個參數值，確保不同請求間該參數值唯一。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	否	用戶端網段。是給用戶端虛擬網路卡分配存取位址的位址段，不是指用戶端已有的內網網段。當用戶端透過 SSL-VPN 連線存取本端時，VPN 閘道器會從指定的用戶端網段中分配一個 IP 位址給用戶端使用，用戶端將會使用分配的 IP 位址存取雲端資源。在您指定用戶端網段時需保證用戶端網段所包含的 IP 位址個數是當前 VPN 閘道器 SSL 連線數的 4 倍及以上。按一下查看原因。例如您指定的用戶端網段為 192.168.0.0/24，系統在為用戶端分配 IP 位址時，會先從 192.168.0.0/24 網段中劃分出一個子網路遮罩為 30 的子網段，例如 192.168.0.4/30，然後從 192.168.0.4/30 中分配一個 IP 位址供用戶端使用，剩餘三個 IP 位址會被系統佔用以保證網路通訊，此時一個用戶端會耗費 4 個 IP 位址。因此，為保證您的用戶端均能分配到 IP 位址，請確保您指定的用戶端網段所包含的 IP 位址個數是 VPN 閘道器 SSL 連線數的 4 倍及以上。按一下查看不支援設定的網段。 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 連線數建議的用戶端網段。若 SSL 連線數為 5，則用戶端網段的子網路遮罩位數建議小於或等於 27。例如：10.0.0.0/27、10.0.0.0/26。若 SSL 連線數為 10，則用戶端網段的子網路遮罩位數建議小於或等於 26。例如：10.0.0.0/26、10.0.0.0/25。若 SSL 連線數為 20，則用戶端網段的子網路遮罩位數建議小於或等於 25。例如：10.0.0.0/25、10.0.0.0/24。若 SSL 連線數為 50，則用戶端網段的子網路遮罩位數建議小於或等於 24。例如：10.0.0.0/24、10.0.0.0/23。若 SSL 連線數為 100，則用戶端網段的子網路遮罩位數建議小於或等於 23。例如：10.0.0.0/23、10.0.0.0/22。若 SSL 連線數為 200，則用戶端網段的子網路遮罩位數建議小於或等於 22。例如：10.0.0.0/22、10.0.0.0/21。若 SSL 連線數為 500，則用戶端網段的子網路遮罩位數建議小於或等於 21。例如：10.0.0.0/21、10.0.0.0/20。若 SSL 連線數為 1000，則用戶端網段的子網路遮罩位數建議小於或等於 20。例如：10.0.0.0/20、10.0.0.0/19。說明用戶端網段的子網路遮罩位數在 16 至 29 位元之間。請確保用戶端網段與本端網段、VPC 網段以及與用戶端終端機關聯的任何路由網段均沒有重疊。在指定用戶端網段時，建議您使用 10.0.0.0/8、172.16.0.0/12 和 192.168.0.0/16 網段及其子網段。如果您的用戶端網段需要指定為公網網段，您需要將公網網段設定為 VPC 的使用者網段，以確保 VPC 可以存取到該公網網段。關於使用者網段的更多資訊，請參見專有網路 FAQ。建立 SSL 服務端後，系統背景會自動將用戶端網段的路由新增在 VPC 執行個體的路由表中，請勿再手動將用戶端網段的路由新增到 VPC 執行個體的路由表，否則會導致 SSL-VPN 連線流量傳輸異常。	10.30.30.0/24
LocalSubnet	string	否	本端網段。是用戶端透過 SSL-VPN 連線要存取的位址段。本端網段可以是 VPC 的網段、交換器的網段、透過專線和 VPC 互連的 IDC 的網段、雲端服務如物件儲存服務 OSS（Object Storage Service）等的網段。本端網段的子網路遮罩位數在 8 至 32 位元之間。以下網段不支援指定為本端網段： 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 服務端。在阿拉伯聯合大公國（杜拜）地域建立 SSL 服務端時，推薦您綁定新加坡地域的 IDaaS EIAM 2.0 執行個體，以減少跨地域延遲。 IDaaS EIAM 1.0 執行個體不再支援新購。如果您的阿里雲帳號下存在 IDaaS EIAM 1.0 執行個體，開啟雙因子驗證功能後，依舊支援綁定 IDaaS EIAM 1.0 執行個體。如果您的阿里雲帳號下不存在 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
DnsServers	string	否

返回參數

名稱	類型	描述	樣本值
	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	用戶端網段。	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

樣本

正常返回樣本

JSON格式

{
  "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 status code	錯誤碼	錯誤資訊	描述
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.	用戶端 IP 集區與本機 IP 範圍衝突。
400	SslVpnServer.AddRouteError	Add route error whose destination is client IP pool, please check vpc route entry and relevant quota.	新增指向用戶端網段的路由失敗，請檢視 VPC 路由項目及相關配額。
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	ClientIpPool.SubnetInvalid	The specified client IP pool cannot be used.	目前用戶端網段不可用。
400	MissingParameter.IDaaSInstanceId	The input parameter IDaaSInstanceId is mandatory when enable multi-factor authentication.	啟動雙因子驗證時請輸入 IDaaSInstanceId 參數。
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.	VPN 服務沒有權限操作您的 IDaaS 執行個體。
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].	SSL VPN 伺服器連接埠號碼必須介於 [1-65535] 之間。
400	EnableHaCheck.SslVpnServerClientCidrContainsVpcRouteDest	Ssl vpn client cidr contains vpc route prefix. The vpc route prefix is %s.	VPC 路由表中存在路由的前綴 %s 被包含在 SSL VPN 用戶端 CIDR 中。
400	InvalidInstanceId.NotFound	InstanceId is not found.	指定的執行個體 ID 不存在。
400	VpnRouteEntry.Conflict	The specified route entry has conflict.	指定的用戶端 IP 集區與 VPN 連線或 SSL 伺服器衝突。
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.	指定的 IDaaS 應用程式執行個體 ID 不合法，應用程式執行個體需要基於專屬 SSL VPN 的範本建立。
400	MissingParam.IDaaSApplicationId	The input parameter IDaaSApplicationId is mandatory when enable multi-factor authentication.	啟用雙因素驗證時請輸入 IDaaSApplicationId 參數。
400	SslVpnIDaaS2.NotSupport	Current version of the VPN does not support IDaaS2.0.	目前 VPN 執行個體版本不支援使用 IDaaS2.0。
400	MissingParam.IDaaSRegionId	The input parameter IDaaSRegionId is mandatory when enable multi-factor authentication.	啟用雙因素驗證時請輸入 IDaaSRegionId 參數。
400	DryRunOperation	Request validation has been passed with DryRun flag set.	DryRun 驗證通過。
400	IllegalParam.LocalSubnet	The specified "LocalSubnet" (%s) is invalid.	本端網段 (%s) 不合法。
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.	EIP 不屬於目前呼叫者，請您檢查該 EIP 是否可被您呼叫。
404	InvalidRegionId.NotFound	The specified region is not found during access authentication.	參數錯誤。
404	InvalidIDaaSInstanceId.NotFound	The specified IDaaS instance ID does not exist.	指定的 IDaaS 執行個體 ID 不存在。
404	InvalidIDaaSApplicationId.NotFound	The specified IDaaS application Id does not exist.	指定的 IDaaS 應用程式執行個體 ID 不存在。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。