Queries SSL client certificates.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeSslVpnClientCerts

The operation that you want to perform. Set the value to DescribeSslVpnClientCerts.

RegionId String Yes cn-hangzhou

The region ID of the SSL client certificates to be queried.

You can call the DescribeRegions operation to query the most recent region list.

SslVpnServerId String No vss-bp18q7hzj6largv4v****

The ID of the SSL server.

SslVpnClientCertId String No vsc-bp1n8wcf134yl0osr****

The ID of the SSL client certificate.

Name String No cert1

The name of the SSL client certificate.

PageNumber Integer No 1

The number of the page to return. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Default value: 10. Valid values: 1 to 50.

Response parameters

Parameter Type Example Description
PageSize Integer 10

The number of entries returned per page.

RequestId String 5BE01CD7-5A50-472D-AC14-CA181C5C03BE

The ID of the request.

PageNumber Integer 1

The number of the returned page.

TotalCount Integer 1

The number of entries returned.

SslVpnClientCertKeys Array of SslVpnClientCertKey

The information about the SSL client certificates.

SslVpnClientCertKey
Status String normal

The status of the SSL client certificate. Valid values:

  • expiring-soon: The certificate expires in one week.
  • normal: The certificate is active.
  • expired: The certificate has expired.
EndTime Long 1494966335000

The timestamp that indicates when the SSL client certificate expires. Unit: milliseconds.

This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

CreateTime Long 1492747187000

The timestamp that indicates when the SSL client certificate was created. Unit: milliseconds.

This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

SslVpnClientCertId String vsc-bp1n8wcf134yl0osr****

The ID of the SSL client certificate.

SslVpnServerId String vss-bp18q7hzj6largv4v****

The ID of the SSL server.

Name String cert1

The name of the SSL client certificate.

RegionId String cn-hangzhou

The region where the SSL client certificate is created.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeSslVpnClientCerts
&RegionId=cn-hangzhou
&SslVpnServerId=vss-bp18q7hzj6largv4v****
&SslVpnClientCertId=vsc-bp1n8wcf134yl0osr****
&Name=cert1
&PageNumber=1
&PageSize=10
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeSslVpnClientCertsResponse>
    <PageSize>10</PageSize>
    <RequestId>5BE01CD7-5A50-472D-AC14-CA181C5C03BE</RequestId>
    <PageNumber>1</PageNumber>
    <TotalCount>1</TotalCount>
    <SslVpnClientCertKeys>
        <Status>normal</Status>
        <EndTime>1494966335000</EndTime>
        <CreateTime>1492747187000</CreateTime>
        <SslVpnClientCertId>vsc-bp1n8wcf134yl0osr****</SslVpnClientCertId>
        <SslVpnServerId>vss-bp18q7hzj6largv4v****</SslVpnServerId>
        <Name>cert1</Name>
        <RegionId>cn-hangzhou</RegionId>
    </SslVpnClientCertKeys>
</DescribeSslVpnClientCertsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "PageSize" : 10,
  "RequestId" : "5BE01CD7-5A50-472D-AC14-CA181C5C03BE",
  "PageNumber" : 1,
  "TotalCount" : 1,
  "SslVpnClientCertKeys" : [ {
    "Status" : "normal",
    "EndTime" : 1494966335000,
    "CreateTime" : 1492747187000,
    "SslVpnClientCertId" : "vsc-bp1n8wcf134yl0osr****",
    "SslVpnServerId" : "vss-bp18q7hzj6largv4v****",
    "Name" : "cert1",
    "RegionId" : "cn-hangzhou"
  } ]
}

Error codes

HttpCode Error code Error message Description
403 Forbbiden.SubUser User not authorized to operate on the specified resource as your account is created by another user. The error message returned because you are unauthorized to perform this operation on the specified resource. Apply for the required permissions and try again.
403 Forbidden User not authorized to operate on the specified resource. The error message returned because you are not authorized to perform the operation on the specified resource. Acquire the required permissions and try again.

For a list of error codes, visit the API Error Center.