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

DescribeSslVpnClientCertAttributes

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

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

我的收藏

调用DescribeSslVpnClientCertAttributes查询指定SSL客户端证书信息。

调试

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

请求参数

名称类型是否必选示例值描述
ActionString是DescribeSslVpnClientCertAttributes要执行的操作，取值：DescribeSslVpnClientCertAttributes。
VersionString是2020-04-01API版本信息。
SslVpnClientCertIdString是vsc-zm55pqtvk17oq32zd****待查询SSL客户端证书的ID。您可调用 DescribeSslVpnClientCerts查询SSL客户端的证书的ID信息。

返回数据

名称类型示例值描述
RequestIdString请求ID。
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：已到期

CaCertificateString-----BEGIN CERTIFICATE-----\nMIIDPTCCAiWgAwIBAgIFAPYCuPgwDQYJKoZIhvcNAQELBQAwTjEQMA4GA1UEBhMH\0kiLwglC1aYQsdjTGuqM/wT+N9nHI5Eu99NvKhu4\n0Gq/oDuxom+*************=\n-----END CERTIFICATE-----\nCA证书信息。
ClientCertificateString-----BEGIN CERTIFICATE-----\nMIIDXDCCAkSgAwIBAgIEGn5UZjANBgkqhkiG9w0BAQsFADBOMRAwDgYDVQQGEwdC\nZIEwdCZWlqaW5nMQswCQYDVQQHEwJDTjEbMBkGA1UEAxqg58tSQENg3*************\n-----END CERTIFICATE-----\n客户端证书信息。
ClientKeyString-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEAvxLr+6AovkwVm9ZKR7Y7Twq5QxfMmWK8GhYithfDYmg9\n+Urzj7R83zpbOmyJA25x9l2FiIvdS*************=\n-----END RSA PRIVATE KEY-----\n客户端密钥信息。
OpenVpnClientConfigStringclient\n# use comp-lzo in openvpn 2.3 or previous versions\n;compress lzo\nexplicit-exit-no******\nOpenVPN客户端的配置。
CreationTimeString2023-04-18T15:02:37+08:00SSL客户端证书的创建时间。
ExpiredTimeString2023-04-18T15:02:37+08:00SSL客户端证书的到期时间。
UpdateTimeString2023-05-28T18:09:12+08:00SSL客户端证书的修改时间。

请求示例

GET /?Action=DescribeSslVpnClientCertAttributes&Version=2020-04-01&SslVpnClientCertId=vsc-12ads0g2fsmps17q7y2w8**** HTTP/1.1
Host: open.volcengineapi.com
ServiceName: vpn
Region: cn-beijing

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202307272000497643F762AB49C889****",
        "Action": "DescribeSslVpnClientCertAttributes",
        "Version": "2020-04-01",
        "Service": "vpn",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "202307272000497643F762AB49C889****",
        "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",
        "CaCertificate": "-----BEGIN CERTIFICATE-----\nMIIDXDCCAkSgAwIBAgIEGn5UZjANBgkqhkiG9w0BAQsFADBOMRAwDgYDVQQGEwdC\nZWlqaW5nMRAwDgYDVQQIEwdCZWlqaW5nMQswCQYDVQQHEwJDTjEbMBkGA1UEAxMS\fPNA1qH8gV/j37PnqxEVk2cOpgm2i1gs1c\nnQ222H5r51M9UpvrDi0/9EHeoUeZCwUnHJgn68ZtpJ5pr1Jws2Dv4AKTDxKgUQ6Y\n+6nSFhv51LoibWq4CzJNGQH3BzpO2svgG5H+LWHZ9pEiV3jyzZtc+ecZyzFm1X/2\nzOg/cauPxDlECkLv8Rt901t9ttisVtN4oIG6g8rU4VFqg58tSQENg3y**********\n-----END CERTIFICATE-----\n",
        "ClientCertificate": "-----BEGIN CERTIFICATE-----\nMIIDPTCCAiWgAwIBAgIFAPYCuPgwDQYJKoZIhvcNAQELBQAwTjEQMA4GA1UEBhMH\neZznSRLhkl40QOdOCnFELCjUTouSR1a25TtO1oPgWDNW5wughIO6sEUeQieWcgmB\nu3TOv+YZ4yQlqjJQ+HAYFN5bYkXNMv2cdCg1OqXWo23LAOJFCjxPbzfD5kI4vDC3\naVzrI89PIk0KozvCa9ZtvuHAXAopvK5sRHEiEw9rgL4WQS17EWnsKMSsB2ejF+rk\nY7qmXZ1jAO7VXxnRcttYzkQiMw0XKXNZChYj9uPT8oPzWM1necjcrzvi64lOtY1P\njZGYDO/1NN9iVp0kiLwglC1aYQs/U7HJZNBJWdjTGuqM/wT+N9nHI5Eu99NvKhu4\n0Gq/oDuxo*******=\n-----END CERTIFICATE-----\n",
        "ClientKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEAvxLr+6AovkwVm9ZKR7Y7Twq5eZznSRLhkl40QOdOCnFELCjU\no4jOeTD2JVtoftM9znbFrJy2/IaCMD7dfgMQRwIDAQABAoIBAAMfXQnkqSXK+oNs\n/vZnMzwxEL841Jk54CLDfwLjZMJQEM1PB1dMWqL38dg8QxfMmWK8GhYithfDYmg9\n+Urzj7R83zpbOmyJA25x9l2FiIvdSoq5RE3Txlxv******=\n-----END RSA PRIVATE KEY-----\n",
        "OpenVpnClientConfig": "client\n# use comp-lzo in openvpn 2.3 or previous versions\n;compress lzo\nexplicit-exit-no******\n"
    }
}

错误码

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

HttpCode错误码错误信息描述
404InvalidSslVpnClientCert.NotFoundThe specified SSL client certificate does not exist.指定的SSL客户端证书不存在。