Queries one or more SSL client certificates.

Make the API call

You can use OpenAPI Explorer to make API calls, search for API calls, perform debugging, and generate SDK example code.

Request parameters

Parameter Type Required? Example value Description
Action String Yes DescribeSslVpnClientCerts

The name of this action. Value: DescribeSslVpnClientCerts.

RegionId String Yes cn-hangzhou

The region of the SSL client certificate to query. To query the region ID, call DescribeRegions.

Name String No cert1

The name of the SSL client certificate.

PageNumber Integer No 1

The page number. Default value: 1.

PageSize Integer No 10

The number of entries per page in the case of a paged query result. Maximum value: 50. Default value: 10.

SslVpnClientCertId String No vsc-bp1n8wcf134yl0osr****

The ID of the SSL client certificate.

SslVpnServerId String No vss-bp18q7hzj6largv4v****

The ID of the SSL server.

Response parameters

Parameter Type Example value Description
PageNumber Integer 1

The current page number.

PageSize Integer 10

The number of entries per page.

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

The ID of the request.

SslVpnClientCertKeys Array

The details of SSL client certificates.

SslVpnClientCertKey

The details of SSL client certificates.

CreateTime Long 1492747187000

The time when the SSL client certificate was created.

EndTime Long 1494966335000

The time when the SSL client certificate expires.

Name String cert1

The name of the SSL client certificate.

RegionId String cn-hangzhou

The region of the SSL client certificate.

SslVpnClientCertId String vsc-bp1n8wcf134yl0osr****

The ID of the SSL client certificate.

SslVpnServerId String vss-bp18q7hzj6largv4v****

The ID of the SSL server.

Status String normal

The status of the client certificate.

  • expiring-soon: The certificate will expire in one week.
  • normal: Indicates that the certificate is in the normal state.
  • expired: Indicates that the certificate is expired.
TotalCount Integer 1

The total number of entries.

Examples

Request example


http(s)://vpc.aliyuncs.com/? Action=DescribeSslVpnClientCerts
&RegionId=cn-hangzhou
&<Common request parameters>

Response example

XML format

<DescribeSslVpnServersResponse>
      <PageNumber>1</PageNumber>
      <TotalCount>1</TotalCount>
      <PageSize>10</PageSize>
      <SslVpnServers>
            <SslVpnServer>
                  <RegionId>cn-hanghzou</RegionId>
                  <SslVpnServerId>vss-bp18q7hzj6largv4v****</SslVpnServerId>
                  <VpnGatewayId>vpn-bp1q8bgx4xnkm2ogj****</VpnGatewayId>
                  <Name>test</Name>
                  <CLientIpPool>10.10.10.20/24</CLientIpPool>
                  <LocalSubnet>10.10.10.10/24</LocalSubnet>
                  <Proto>UDP</Proto>
                  <Port>1194</Port>
                  <Cipher>AES-128-CBC</Cipher>
                  <Compress>true</Compress>
                  <CreateTime>1492753580000</CreateTime>
                  <Connections>0</Connections>
                  <MaxConnections>5</MaxConnections>
                  <InternetIp>47.98.xx.xx</InternetIp>
            </SslVpnServer>
      </SslVpnServers>
      <RequestId>DF11D6F6-E35A-41C3-9B20-6FC8A901FE65</RequestId>
</DescribeSslVpnServersResponse>

JSON format

{
	"DescribeSslVpnServersResponse":{
		"PageNumber":"1",
		"TotalCount":"1",
		"SslVpnServers":{
			"SslVpnServer":{
				"VpnGatewayId":"vpn-bp1q8bgx4xnkm2ogj****",
				"CLientIpPool":"10.10.10.20/24",
				"Proto":"UDP",
				"Cipher":"AES-128-CBC",
				"InternetIp":"47.98.xx.xx",
				"SslVpnServerId":"vss-bp18q7hzj6largv4v****",
				"Name":"test",
				"Port":"1194",
				"MaxConnections":"5",
				"RegionId":"cn-hanghzou",
				"CreateTime":"1492753580000",
				"Compress":"true",
				"LocalSubnet":"10.10.10.10/24",
				"Connections":"0"
			}
		},
		"PageSize":"10",
		"RequestId":"DF11D6F6-E35A-41C3-9B20-6FC8A901FE65"
	}
}

Errors

HTTP status code 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. You are not authorized to operate on this resource.
403 Forbidden User not authorized to operate on the specified resource. You are not authorized to operate on this resource.

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