SSL Client Certificate Details Reference - VPN Gateway - Alibaba Cloud - VPN Gateway

Queries the information about a specified SSL client certificate.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vpc:DescribeSslVpnClientCert

get

*SslVpnClientCert

acs:vpc:{#regionId}:{#accountId}:sslvpnclientcert/{#SslVpnClientCertId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the SSL client certificate to query. You can call the DescribeRegions operation to query region IDs.	cn-hangzhou
SslVpnClientCertId	string	Yes	The ID of the SSL client certificate to query.	vsc-bp17r58rjf5r1gjyr****

Response elements

Element	Type	Description	Example
	object	The response parameters.
Status	string	The status of the SSL client certificate. Valid values: expiring-soon: The certificate will expire within one week. normal: Normal. expired: Expired.	normal
CreateTime	integer	The timestamp when the SSL client certificate was created. Unit: milliseconds. The timestamp is in the Unix format, which represents the total number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC, to the time when the SSL client certificate was created.	1552550980000
ClientKey	string	The client key.	-----BEGIN RSA PRIVATE KEY----- MIIEpAI****ZzNFhuM/za== -----END RSA PRIVATE KEY-----
RegionId	string	The region ID of the SSL client certificate.	cn-hangzhou
ClientConfig	string	The client configuration.	client dev tun proto tcp remote 120.XX.XX.33 1194 resolv-retry infinite nobind persist-key persist-tun ca ca.crt cert vsc-bp15t7**.crt key vsc-bp15t7**.key cipher AES-128-CBC ;comp-lzo verb 4
EndTime	integer	The timestamp when the SSL client certificate expires. Unit: milliseconds. The timestamp is in the Unix format, which represents the total number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC, to the time when the SSL client certificate expires.	1647158980000
RequestId	string	The request ID.	5BE01CD7-5A50-472D-AC14-CA181C5C03BE
ClientCert	string	The client certificate.	-----BEGIN CERTIFICATE----- MIIDR****A== -----END CERTIFICATE-----
CaCert	string	The CA certificate.	-----BEGIN CERTIFICATE----- MIID****r4w= -----END CERTIFICATE-----
SslVpnClientCertId	string	The ID of the SSL client certificate.	vsc-bp13k5mp4tg8v3z9b****
SslVpnServerId	string	The SSL server ID.	vss-bp155e9yclsg1xgq4****
Name	string	The name of the SSL client certificate.	nametest
ResourceGroupId	string	The resource group ID of the SSL client certificate. The SSL client certificate belongs to the same resource group as its associated SSL server. You can call the ListResourceGroups operation to query resource group information.	rg-acfmzs372yg****

Examples

Success response

JSON format

{
  "Status": "normal",
  "CreateTime": 1552550980000,
  "ClientKey": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAI****ZzNFhuM/za==\n-----END RSA PRIVATE KEY-----",
  "RegionId": "cn-hangzhou",
  "ClientConfig": "client\ndev tun\nproto tcp\nremote 120.XX.XX.33 1194\nresolv-retry infinite\nnobind\npersist-key\npersist-tun\nca ca.crt\ncert vsc-bp15t7****.crt\nkey vsc-bp15t7****.key\ncipher AES-128-CBC\n;comp-lzo\nverb 4",
  "EndTime": 1647158980000,
  "RequestId": "5BE01CD7-5A50-472D-AC14-CA181C5C03BE",
  "ClientCert": "-----BEGIN CERTIFICATE-----\nMIIDR****A==\n-----END CERTIFICATE-----",
  "CaCert": "-----BEGIN CERTIFICATE-----\nMIID****r4w=\n-----END CERTIFICATE-----",
  "SslVpnClientCertId": "vsc-bp13k5mp4tg8v3z9b****",
  "SslVpnServerId": "vss-bp155e9yclsg1xgq4****",
  "Name": "nametest",
  "ResourceGroupId": "rg-acfmzs372yg****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidInstanceId.NotFound	The InstanceId is not found.	The InstanceId is not found.
403	Forbbiden.SubUser	User not authorized to operate on the specified resource as your account is created by another user.
403	Forbidden	User not authorized to operate on the specified resource.	You do not have the permissions to manage the specified resource. Apply for the permissions and try again.
404	InvalidRegionId.NotFound	The specified region is not found during access authentication.	The specified area is not found during authentication.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.