DescribeSslVpnServers - VPN Gateway

呼叫 DescribeSslVpnServers 介面查詢已建立的 SSL-VPN 伺服器端。

調試

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

調試

授權資訊

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

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

操作

存取層級

資源類型

條件關鍵字

關聯操作

vpc:DescribeSslVpnServers

list

SslVpnServer

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

SslVpnServer

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

無

請求參數

名稱	類型	必填	描述	樣本值
RegionId	string	是	SSL-VPN 伺服器端所在的地域 ID。您可以透過呼叫 DescribeRegions 介面取得地域 ID。	cn-hangzhou
SslVpnServerId	string	否	SSL-VPN 伺服器端的 ID。	vss-bp15j3du13gq1dgey****
VpnGatewayId	string	否	VPN 閘道的 ID。	vpn-bp1on0xae9d771ggi****
Name	string	否	SSL-VPN 伺服器端的名稱。長度為 1～100 個字元，不能以 `http://` 或 `https://` 開頭。	test
PageNumber	integer	否	列表的頁碼，預設值：1。	1
PageSize	integer	否	分頁查詢時每頁的行數。最大值：50。預設值：10。	10
ResourceGroupId	string	否	SSL-VPN 伺服器端所屬的資源群組 ID。 SSL-VPN 伺服器端與其關聯的 VPN 閘道執行個體的資源群組相同。您可以呼叫 DescribeVpnGateway 介面查詢 VPN 閘道執行個體所屬的資源群組 ID。	rg-acfmzs372yg****

返回參數

名稱	類型	描述	樣本值
	object	返回結果。
PageSize	integer	分頁查詢時每頁的行數。	10
RequestId	string	請求 ID。	D350187B-EA41-4577-950B-95434C8302E1
PageNumber	integer	列表的頁碼。	1
TotalCount	integer	列表條目數。	1
SslVpnServers	object
SslVpnServer	array<object>	SSL-VPN 伺服器端的詳細資訊。
	object
InternetIp	string	VPN 閘道的公網 IP 位址。	47.5.XX.XX
IDaaSInstanceId	string	IDaaS EIAM 執行個體 ID。	idaas-cn-hangzhou-****
CreateTime	integer	建立 SSL-VPN 服務端的時間戳記。	1613800884000
VpnGatewayId	string	VPN 閘道 ID。	vpn-bp1on0xae9d771ggi****
IDaaSRegionId	string	IDaaS EIAM 執行個體所屬地區 ID。	cn-hangzhou
Compress	boolean	是否對通訊進行壓縮。 true：是。 false（預設值）：否。	false
Port	integer	SSL-VPN 服務端所使用的連接埠。	1194
LocalSubnet	string	本端網段。	192.168.0.0/24
RegionId	string	SSL-VPN 服務端的地區 ID。	cn-hangzhou
Cipher	string	使用的密碼編譯演算法。	AES-128-CBC
Connections	integer	當前串連數。	0
SslVpnServerId	string	SSL-VPN 服務端的 ID。	vss-bp15j3du13gq1dgey****
MaxConnections	integer	最大串連數。	5
Name	string	SSL-VPN 服務端名稱。	test
EnableMultiFactorAuth	boolean	是否開啟了雙因子認證。 true：已開啟。 false（預設值）：未開啟。	true
ClientIpPool	string	用戶端網段。	10.10.1.0/24
Proto	string	SSL-VPN 服務端所使用的協議。	UDP
ResourceGroupId	string	SSL-VPN 服務端所屬的資源群組 ID。您可以調用 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
DnsServers	string

樣本

正常返回樣本

JSON格式

{
  "PageSize": 10,
  "RequestId": "D350187B-EA41-4577-950B-95434C8302E1",
  "PageNumber": 1,
  "TotalCount": 1,
  "SslVpnServers": {
    "SslVpnServer": [
      {
        "InternetIp": "47.5.XX.XX",
        "IDaaSInstanceId": "idaas-cn-hangzhou-****",
        "CreateTime": 1613800884000,
        "VpnGatewayId": "vpn-bp1on0xae9d771ggi****",
        "IDaaSRegionId": "cn-hangzhou",
        "Compress": false,
        "Port": 1194,
        "LocalSubnet": "192.168.0.0/24",
        "RegionId": "cn-hangzhou",
        "Cipher": "AES-128-CBC",
        "Connections": 0,
        "SslVpnServerId": "vss-bp15j3du13gq1dgey****",
        "MaxConnections": 5,
        "Name": "test",
        "EnableMultiFactorAuth": true,
        "ClientIpPool": "10.10.1.0/24",
        "Proto": "UDP",
        "ResourceGroupId": "rg-acfmzs372yg****",
        "IDaaSApplicationId": "app_my6g4qmvnwxzj2f****",
        "IDaaSInstanceVersion": "EIAM 2.0",
        "DnsServers": ""
      }
    ]
  }
}

錯誤碼

HTTP status code	錯誤碼	錯誤資訊
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.

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

變更歷史

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