調用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 個字符，不能以 | test |
| ClientIpPool | string | 否 | 客戶端 IP 地址池。 | 10.30.30.0/24 |
| LocalSubnet | string | 否 | 本地客戶端的網段。 | 10.20.20.0/24 |
| Proto | string | 否 | SSL-VPN 服務端所使用的協議，取值：
| UDP |
| Cipher | string | 否 | SSL-VPN 使用的加密算法，取值：
| 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 |
| EnableMultiFactorAuth | boolean | 否 | 是否開啟雙因子認證。如果您選擇開啟雙因子認證功能，您還需要輸入 IDaaS EIAM 實例 ID 和 IDaaS 應用 ID。取值：
說明
| false |
| IDaaSInstanceId | string | 否 | IDaaS EIAM 實例 ID。 | idaas-cn-hangzhou-**** |
| IDaaSRegionId | string | 否 | IDaaS EIAM 實例所屬地域 ID。 | cn-hangzhou |
| IDaaSApplicationId | string | 否 | IDaaS 應用 ID。
| app_my6g4qmvnwxzj2f**** |
返回參數
示例
正常返回示例
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 | IpConflict | Client IP pool conflict with other SSL VPN server in the same VPC. | 客戶端IP池與同一VPC中的其他SSL VPN服務器沖突。 |
| 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. | 路由條目存在沖突。 |
| 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參數。 |
| 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. | 指定的IDaaS實例ID不存在 |
| 404 | InvalidIDaaSApplicationId.NotFound | The specified IDaaS application Id does not exist. | 指定的IDaaS應用實例ID不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-05-10 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2024-01-04 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |
| 2023-10-19 | OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 標記、OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
| 2023-05-30 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |