有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: vpc.tencentcloudapi.com 。

本接口(DescribeVpnGatewaySslServers)用于查询SSL-VPN SERVER 列表信息。

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeVpnGatewaySslServers。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
Offset Integer 偏移量。
示例值:0
Limit Integer 请求对象个数。
示例值:2
SslVpnServerIds.N Array of String SSL-VPN-SERVER实例ID。形如:vpngwSslServer-12345678。每次请求的实例的上限为100。参数不支持同时指定SslVpnServerIds和Filters。
示例值:['vpngwSslServer-12345']
Filters.N Array of FilterObject 过滤条件,参数不支持同时指定SslVpnServerIds和Filters。
  • vpc-id - String - (过滤条件)VPC实例ID,形如:vpc-f49l6u0z。
  • vpn-gateway-id - String - (过滤条件)VPN实例ID,形如:vpngw-5aluhh9t。
  • vpn-gateway-name - String - (过滤条件)VPN实例名称。
  • ssl-vpn-server-name - String - (过滤条件)SSL-VPN-SERVER实例名称。
  • ssl-vpn-server-id - String - (过滤条件)SSL-VPN-SERVER实例ID,形如:vpns-xxx。
  • IsVpnPortal Boolean vpn门户使用。 默认Flase

    3. 输出参数

    参数名称 类型 描述
    TotalCount Integer 符合条件的实例数量。
    示例值:1
    SslVpnSeverSet Array of SslVpnSever SSL-VPN-SERVER 实例详细信息列表。
    RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 查询SSL-VPN-SERVER

    查询SSL-VPN-SERVER

    输入示例

    https://vpc.tencentcloudapi.com/?Action=DescribeVpnGatewaySslServers
    &Offset=0
    &Limit=2
    &Filters.0.Name=vpn-gateway-id
    &Filters.0.Values.0=vpn-123456
    &<公共请求参数>

    输出示例

    {
        "Response": {
            "TotalCount": 1,
            "SslVpnSeverSet": [
                {
                    "VpcId": "abc",
                    "SslVpnServerId": "abc",
                    "VpnGatewayId": "abc",
                    "SslVpnServerName": "abc",
                    "LocalAddress": [
                        "abc"
                    ],
                    "RemoteAddress": "abc",
                    "MaxConnection": 1,
                    "WanIp": "abc",
                    "SslVpnProtocol": "abc",
                    "SslVpnPort": 1,
                    "EncryptAlgorithm": "abc",
                    "IntegrityAlgorithm": "abc",
                    "Compress": 1,
                    "CreateTime": "abc",
                    "State": 1,
                    "SsoEnabled": 1,
                    "EiamApplicationId": "abc",
                    "AccessPolicyEnabled": 1,
                    "AccessPolicy": [
                        {
                            "TargetCidr": "abc",
                            "VpnGatewayIdSslAccessPolicyId": "abc",
                            "ForAllClient": 1,
                            "UserGroupIds": [
                                "abc"
                            ],
                            "UpdateTime": "abc",
                            "Remark": "abc"
                        }
                    ]
                }
            ],
            "RequestId": "abc"
        }
    }

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

    错误码 描述
    InternalError 内部错误。
    InvalidParameter.Coexist 参数不支持同时指定。
    InvalidParameter.FilterInvalidKey 指定过滤条件不存在。
    InvalidParameterValue.Malformed 入参格式不合法。
    InvalidParameterValue.Range 参数值不在指定范围。
    ResourceNotFound 资源不存在。