調用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 個字符,不能以 | test |
PageNumber | integer | 否 | 列表的頁碼,默認值:1。 | 1 |
PageSize | integer | 否 | 分頁查詢時每頁的行數。最大值:50。默認值:10。 | 10 |
ResourceGroupId | string | 否 | SSL-VPN 服務端所屬的資源組 ID。 SSL-VPN 服務端與其關聯的 VPN 網關實例的資源組相同。您可以調用 DescribeVpnGateway 接口查詢 VPN 網關實例所屬的資源組 ID。 | rg-acfmzs372yg**** |
返回參數
示例
正常返回示例
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"
}
]
}
}
錯誤碼
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. | 接入認證時未找到指定區域。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-05-10 | OpenAPI 錯誤碼發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |
2023-10-19 | OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 標記、OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |