有奖捉虫:云通信与企业服务文档专题,速来> HOT
文档中心 > 私有网络 > API 文档 > VPN网关相关接口 > 下载SSL-VPN-CLIENT 客户端证书

1. 接口描述

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

本接口(DownloadVpnGatewaySslClientCert)用于下载SSL-VPN-CLIENT 客户端证书。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DownloadVpnGatewaySslClientCert。
Version String 公共参数,本接口取值:2017-03-12。
Region String 公共参数,详见产品支持的 地域列表
SslVpnClientId String SSL-VPN-CLIENT 实例ID。不可以和SslVpnClientIds同时使用。
示例值:vpnc-123456
SamlToken String SAML Token(SAML令牌)。
IsVpnPortal Boolean VPN门户网站使用。默认False
SslVpnClientIds.N Array of String SSL-VPN-CLIENT 实例ID列表。批量下载时使用。不可以和SslVpnClientId同时使用。
示例值:["vpnc-123456"]

3. 输出参数

参数名称 类型 描述
SslClientConfigsSet String SSL-VPN 客户端配置。
SslClientConfig Array of SslClientConfig SSL-VPN 客户端配置。
Authenticated Integer 是否鉴权成功 只有传入SamlToken 才生效,1为成功,0为失败。
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 下载SSL-VPN-CLIENT配置

下载SSL-VPN-CLIENT配置

输入示例

https://vpc.tencentcloudapi.com/?Action=DownloadVpnGatewaySslClientCert
&SslVpnClientId=vpnc--84tby4k2
&<公共请求参数>

输出示例

{
    "Response": {
        "SslClientConfig": [
            {
                "SslVpnCert": "-----BEGIN CERTIFICATE-----......",
                "SslVpnKey": "-----BEGIN PRIVATE KEY-----......",
                "SslVpnRootCert": "-----BEGIN CERTIFICATE-----......",
                "SslVpnClientConfiguration": "client\ndev tun\nproto udp\nremote......"
            }
        ],
        "Authenticated": 1,
        "RequestId": "d3c01d8b-0363-41d4-a8be-3cfcf2c69711",
        "SslClientConfigsSet": "${SslClientConfigsSet}"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误。
InvalidParameterValue.LimitExceeded 参数值超出限制。
UnsupportedOperation 操作不支持。
UnsupportedOperation.SSLClientCertDisableUnsupportedDownloadSSLClientCert SSL客户端状态不可用,不支持下载
UnsupportedOperation.SslVpnClientIdNotFound SslVpnClientId 不存在。