调用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 返回结构发生变更 | 查看变更详情 |