DescribeSslVpnClientCerts API Reference - VPN Gateway - Alibaba Cloud - VPN Gateway

Queries created SSL client certificates by calling the DescribeSslVpnClientCerts operation.

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:DescribeSslVpnClientCerts

list

SslVpnClientCert

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

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 that you want to query. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
SslVpnServerId	string	No	The ID of the SSL server.	vss-bp18q7hzj6largv4v****
SslVpnClientCertId	string	No	The ID of the SSL client certificate.	vsc-bp1n8wcf134yl0osr****
Name	string	No	The name of the SSL client certificate.	cert1
PageNumber	integer	No	The page number of the list. Default value: 1.	1
PageSize	integer	No	The number of entries per page in a paged query. Default value: 10. Valid values: 1 to 50.	10
ResourceGroupId	string	No	The ID of the resource group to which the SSL client certificate belongs. The SSL client certificate belongs to the same resource group as its associated SSL server. You can call the DescribeSslVpnServers operation to query the resource group ID of the SSL server.	rg-acfmzs372yg****

Response elements

Element	Type	Description	Example
	object	The response parameters.
PageSize	integer	The number of entries per page in a paged query. This is used for paging.	10
RequestId	string	The request ID.	5BE01CD7-5A50-472D-AC14-CA181C5C03BE
PageNumber	integer	The page number of the list.	1
TotalCount	integer	The total number of entries in the list.	1
SslVpnClientCertKeys	object
SslVpnClientCertKey	array<object>	The list of SSL client certificates.
	object	The information about the SSL client certificate.
Status	string	The status of the SSL client certificate. Valid values: expiring-soon: The certificate expires in one week. normal expired	normal
EndTime	integer	The timestamp generated when the SSL client certificate expires. Unit: milliseconds. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1494966335000
CreateTime	integer	The timestamp generated when the SSL client certificate was created. Unit: milliseconds. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1492747187000
SslVpnClientCertId	string	The ID of the SSL client certificate.	vsc-bp1n8wcf134yl0osr****
SslVpnServerId	string	The ID of the SSL server.	vss-bp18q7hzj6largv4v****
Name	string	The name of the SSL client certificate.	cert1
RegionId	string	The region ID of the SSL client certificate.	cn-hangzhou
ResourceGroupId	string	The ID of the resource group to which the SSL client certificate belongs. You can call the ListResourceGroups operation to query resource groups.	rg-acfmzs372yg****

Examples

Success response

JSON format

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

Error codes

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.
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.