You need to enable JavaScript to run this app.
导航
VPN连接
  • 文档首页
    • /
  • VPN连接

DescribeSslVpnClientCerts

最近更新时间：2024.04.18 17:23:57

首次发布时间：2023.07.28 08:04:09

我的收藏

调用DescribeSslVpnClientCerts查询符合条件的SSL客户端证书的信息。

调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

请求参数

名称类型是否必选示例值描述
ActionString是DescribeSslVpnClientCerts要执行的操作，取值：DescribeSslVpnClientCerts。
VersionString是2020-04-01API版本信息。

SslVpnClientCertIds.N

List of String

否

SslVpnClientCertIds.1=vsc-12b8vwu4k5****&SslVpnClientCertIds.2=vsc-q417q7y1t6n8no****

SSL客户端证书的ID。

  • 参数 - N：表示SSL客户端ID的序号。

  • 多个ID之间用&分隔。

SslVpnClientCertName

String

否

example_ssl_client_cert

SSL客户端证书的名称。

SslVpnServerIdString否example_ssl_clientSSL客户端关联的SSL服务端的ID。您可调用 DescribeSslVpnServers查询SSL服务端的ID信息。
PageSizeInteger否20查询结果的分页大小。最大值：100，默认值：20。

PageNumber

Integer

否

1

查询结果的页码。

  • 如需传入此参数，请传入非负整数。

  • 不传或传入0，则均默认为1。

返回数据

名称类型示例值描述
RequestIdString0ED8D006-F706-4D23-88ED-E11ED28****请求ID。
PageSizeInteger20当前分页的行数。
PageNumberInteger1当前页码。
TotalCountInteger33符合查询条件的SSL客户端证书的总数。
SslVpnClientCertsArray of struct-SSL客户端证书的信息集合，具体请见下表“SslVpnClientCert”。

SslVpnClientCert

名称类型示例值描述
SslVpnClientCertIdStringvsc-zm55pqtvk17oq32zd****SSL客户端证书的ID。

SslVpnClientCertName

String

example_ssl_client_cert

SSL客户端证书的名称。

DescriptionStringexample_ssl_vpn_client_cert_descriptionSSL客户端证书的描述信息。
SslVpnServerIdStringvss-zm55pqtvk17oq32zd****SSL服务端的ID。

Status

String

Available

SSL客户端的状态。

  • Creating: 创建中

  • Deleting: 删除中

  • Pending：配置中

  • Available：可用

CertificateStatus

String

Available

SSL客户端证书状态。

  • Available：可用

  • Expiring：即将到期，到期时间不足一周（包含）展示此状态。

  • Expired：已到期

CreationTimeString2023-04-18T15:02:37+08:00SSL客户端证书的创建时间。
UpdateTimeString2023-05-28T18:09:12+08:00SSL客户端证书的修改时间。
ExpiredTimeString2023-04-18T15:02:37+08:00SSL客户端证书的到期时间。

请求示例

GET /?Action=DescribeSslVpnClientCerts&Version=2020-04-01&SslVpnClientCertIds.1=vsc-12ads0g2fsmps17q7y2w8****&PageNumber=1&PageSize=10 HTTP/1.1
Host: open.volcengineapi.com
ServiceName: vpn
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230727200729C3CE7E861A3C6C00****",
        "Action": "DescribeSslVpnClientCerts",
        "Version": "2020-04-01",
        "Service": "vpn",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "20230727200729C3CE7E861A3C6C00****",
        "PageNumber": 1,
        "PageSize": 10,
        "TotalCount": 1,
        "SslVpnClientCerts": [
            {
                "SslVpnClientCertId": "vsc-12ads0g2fsmps17q7y2w8****",
                "SslVpnClientCertName": "test-cicd",
                "Description": "abc",
                "SslVpnServerId": "vss-imwoo6i1dfk08gbssxfj****",
                "Status": "Available",
                "CertificateStatus": "Available",
                "CreationTime": "2023-07-27T19:55:08+08:00",
                "ExpiredTime": "2026-07-27T19:55:08+08:00",
                "UpdateTime": "2023-07-27T19:57:56+08:00"
            }
        ]
    }
}

错误码

此处仅展示当前API的错误码，更多错误码请参见公共错误码。

HttpCode错误码错误信息描述
400InvalidPage.MalformedThe specified page is malformed.指定的分页参数不合法。
400LimitExceeded.SslVpnClientCertIdYou've reached the limit on the number of SSL client certificate IDs that you can describe.已达到可查询的SSL客户端证书ID数量上限。