You need to enable JavaScript to run this app.
文档中心
VPN连接

VPN连接

请输入
  • 文档首页
    • VPN连接API参考SSL客户端证书DescribeSslVpnClientCertAttributes-查询SSL客户端证书
复制全文
下载 pdf
我的收藏
SSL客户端证书
DescribeSslVpnClientCertAttributes-查询SSL客户端证书
复制全文
下载 pdf
我的收藏
DescribeSslVpnClientCertAttributes-查询SSL客户端证书
调用DescribeSslVpnClientCertAttributes查询指定SSL客户端证书信息。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action String 必选 示例值：DescribeSslVpnClientCertAttributes​
要执行的操作，取值：DescribeSslVpnClientCertAttributes。​
​
Version String 必选 示例值：2020-04-01​
API版本信息。​
​
SslVpnClientCertId String 必选 示例值：vsc-zm55pqtvk17oq32zd****​
待查询SSL客户端证书的ID。您可调用 DescribeSslVpnClientCerts查询SSL客户端的证书的ID信息。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
RequestId String 示例值：202307272000497643F762AB49C889****​
请求ID。​
​
SslVpnClientCertId String 示例值：vsc-zm55pqtvk17oq32zd****​
SSL客户端证书的ID。​
​
SslVpnClientCertName String 示例值：example_ssl_client_cert​
SSL客户端证书的名称。​
​
Description String 示例值：example_ssl_vpn_client_cert_description​
SSL客户端证书的描述信息。​
​
SslVpnServerId String 示例值：vss-zm55pqtvk17oq32zd****​
SSL服务端的ID。​
​
Status String 示例值：Available​
SSL客户端状态。​
  • Creating: 创建中​
  • Deleting: 删除中​
  • Pending：配置中​
  • Available：可用​
​
CertificateStatus String 示例值：Available​
SSL客户端证书状态。​
  • Available：可用​
  • Expiring：即将到期，到期时间不足一周（包含）展示此状态。​
  • Expired：已到期​
​
CaCertificate String 示例值：-----BEGIN CERTIFICATE-----\nMIIDPTCCAiWgAwIBAgIFAPYCuPgwDQYJKoZIhvcNAQELBQAwTjEQMA4GA1UEBhMH\0kiLwglC1aYQsdjTGuqM/wT+N9nHI5Eu99NvKhu4\n0Gq/oDuxom+*************=\n-----END CERTIFICATE-----\n​
CA证书信息。​
​
ClientCertificate String 示例值：-----BEGIN CERTIFICATE-----\nMIIDXDCCAkSgAwIBAgIEGn5UZjANBgkqhkiG9w0BAQsFADBOMRAwDgYDVQQGEwdC\nZIEwdCZWlqaW5nMQswCQYDVQQHEwJDTjEbMBkGA1UEAxqg58tSQENg3*************\n-----END CERTIFICATE-----\n​
客户端证书信息。​
​
ClientKey String 示例值：-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEAvxLr+6AovkwVm9ZKR7Y7Twq5QxfMmWK8GhYithfDYmg9\n+Urzj7R83zpbOmyJA25x9l2FiIvdS*************=\n-----END RSA PRIVATE KEY-----\n​
客户端密钥信息。​
​
OpenVpnClientConfig String 示例值：client\n# use comp-lzo in openvpn 2.3 or previous versions\n;compress lzo\nexplicit-exit-no******\n​
OpenVPN客户端的配置。​
​
CreationTime String 示例值：2023-04-18T15:02:37+08:00​
SSL客户端证书的创建时间。​
​
ExpiredTime String 示例值：2023-04-18T15:02:37+08:00​
SSL客户端证书的到期时间。​
​
UpdateTime String 示例值：2023-05-28T18:09:12+08:00​
SSL客户端证书的修改时间。​
​
Tags Object[] 示例值：-​
SSL客户端证书已添加的全部标签信息。​
Key String 示例值：key1​
标签键。​
​
Value String 示例值：value1​
标签值。​
​
​
​
​
请求示例​
​
GET /?Action=DescribeSslVpnClientCertAttributes&Version=2020-04-01&SslVpnClientCertId=vsc-12ads0g2fsmps17q7y2w8**** HTTP/1.1​
Host: vpn.cn-beijing.volcengineapi.com​
X-Date: 20251029T033538Z​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20251029/cn-beijing/vpn/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
返回示例​
​
{​
"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",​
"Tags": [​
{​
"Key": "k1",​
"Value": "v1"​
},​
{​
"Key": "k2",​
"Value": "v2"​
}​
],​
"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"​
}​
}​
​
错误码​
下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。​
​
状态码​
错误码​
错误信息​
说明​
404​
InvalidSslVpnClientCert.NotFound​
The specified SSL client certificate does not exist.​
指定的SSL客户端证书不存在。​
​
​
最近更新时间：2026.02.02 11:34:39
这个页面对您有帮助吗？
有用
有用
无用
无用