文档

DescribeSslVpnServers - 查询已创建的SSL-VPN服务端

更新时间:

调用DescribeSslVpnServers接口查询已创建的SSL-VPN服务端。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:DescribeSslVpnServersList
  • SslVpnServer
    acs:vpc:{#regionId}:{#accountId}:sslvpnserver/*
  • SslVpnServer
    acs:vpc:{#regionId}:{#accountId}:sslvpnserver/{#SslVpnServerId}

请求参数

名称类型必填描述示例值
RegionIdstring

SSL-VPN 服务端所在的地域 ID。

您可以通过调用 DescribeRegions 接口获取地域 ID。

cn-hangzhou
SslVpnServerIdstring

SSL-VPN 服务端的 ID。

vss-bp15j3du13gq1dgey****
VpnGatewayIdstring

VPN 网关的 ID。

vpn-bp1on0xae9d771ggi****
Namestring

SSL-VPN 服务端的名称。

长度为 1~100 个字符,不能以http://https://开头。

test
PageNumberinteger

列表的页码,默认值:1

1
PageSizeinteger

分页查询时每页的行数。最大值:50。默认值:10

10
ResourceGroupIdstring

SSL-VPN 服务端所属的资源组 ID。

SSL-VPN 服务端与其关联的 VPN 网关实例的资源组相同。您可以调用 DescribeVpnGateway 接口查询 VPN 网关实例所属的资源组 ID。

rg-acfmzs372yg****

返回参数

名称类型描述示例值
object

返回结果。

PageSizeinteger

分页查询时每页的行数。

10
RequestIdstring

请求 ID。

D350187B-EA41-4577-950B-95434C8302E1
PageNumberinteger

列表的页码。

1
TotalCountinteger

列表条目数。

1
SslVpnServersobject []

SSL-VPN 服务端的详细信息。

InternetIpstring

VPN 网关的公网 IP 地址。

47.5.XX.XX
IDaaSInstanceIdstring

IDaaS 实例 ID。

idaas-cn-hangzhou-****
CreateTimelong

创建 SSL-VPN 服务端的时间戳。

1613800884000
VpnGatewayIdstring

VPN 网关 ID。

vpn-bp1on0xae9d771ggi****
IDaaSRegionIdstring

IDaaS 实例所属地域 ID。

cn-hangzhou
Compressboolean

是否对通信进行压缩。

  • true:是。

  • false(默认值):否。

false
Portinteger

SSL-VPN 服务端所使用的端口。

1194
LocalSubnetstring

本端网段。

192.168.0.0/24
RegionIdstring

SSL-VPN 服务端的地域 ID。

cn-hangzhou
Cipherstring

使用的加密算法。

AES-128-CBC
Connectionsinteger

当前连接数。

0
SslVpnServerIdstring

SSL-VPN 服务端的 ID。

vss-bp15j3du13gq1dgey****
MaxConnectionsinteger

最大连接数。

5
Namestring

SSL-VPN 服务端名称。

test
EnableMultiFactorAuthboolean

是否开启了双因子认证。

  • true:已开启。

  • false(默认值):未开启。

true
ClientIpPoolstring

客户端网段。

10.10.1.0/24
Protostring

SSL-VPN 服务端所使用的协议。

UDP
ResourceGroupIdstring

SSL-VPN 服务端所属的资源组 ID。

您可以调用 ListResourceGroups 接口查询资源组信息。

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****"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
403Forbbiden.SubUserUser not authorized to operate on the specified resource as your account is created by another user.您没有权限操作该资源,请您申请操作权限后再试。
403ForbiddenUser not authorized to operate on the specified resource.您没有权限操作指定资源,请申请权限后再操作。
404InvalidRegionId.NotFoundThe specified region is not found during access authentication.接入认证时未找到指定区域。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-10-19OpenAPI 描述信息更新、OpenAPI 去除了 deprecated 标记、OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
API 弃用说明(deprecated)OpenAPI 去除了 deprecated 标记
错误码OpenAPI 错误码发生变更
    删除错误码:403
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:ResourceGroupId
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈