Automate SSL VPN Client Certificate Deletion via API - VPN Gateway - Alibaba Cloud - VPN Gateway

Operation description

Deleting an SSL-VPN client certificate disconnects all clients under the SSL server from their SSL-VPN connections. If clients need to continue using SSL-VPN connections, they must re-initiate the SSL-VPN connections.

For example, if SSL-VPN client certificate 1 and SSL-VPN client certificate 2 are created under an SSL server, deleting SSL-VPN client certificate 1 disconnects all clients associated with both SSL-VPN client certificate 1 and SSL-VPN client certificate 2.
- If clients associated with SSL-VPN client certificate 1 need to continue using SSL-VPN connections, they must install another certificate and then re-initiate the SSL-VPN connections.
- If clients associated with SSL-VPN client certificate 2 need to continue using SSL-VPN connections, they only need to re-initiate the SSL-VPN connections.
The DeleteSslVpnClientCert operation is asynchronous. After a request is sent, the system returns a request ID. However, the SSL-VPN client certificate is not immediately deleted. The deletion task runs in the background. You can call DescribeVpnGateway to query the status of the VPN gateway instance associated with the SSL server to check the deletion status of the SSL-VPN client certificate:
- If the VPN gateway instance is in the updating state, the SSL-VPN client certificate is being deleted.
- If the VPN gateway instance is in the active state, the SSL-VPN client certificate is deleted.
The DeleteSslVpnClientCert operation does not support concurrent deletion of SSL-VPN client certificates under the same VPN gateway instance.

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

delete

*SslVpnClientCert

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the SSL-VPN client certificate. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The ClientToken value can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId value as the ClientToken value. The RequestId value is different for each API request.	02fb3da4-130e-11e9-8e44-0016e04115b
SslVpnClientCertId	string	Yes	The ID of the SSL-VPN client certificate.	vsc-bp1n8wcf134yl0osr****

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	606998F0-B94D-48FE-8316-ACA81BB230DA

Examples

Success response

JSON format

{
  "RequestId": "606998F0-B94D-48FE-8316-ACA81BB230DA"
}

Error response

JSON format

{
  "RequestId":"606998F0-B94D-48FE-8316-ACA81BB230DA"
}

Error codes

HTTP status code	Error code	Error message	Description
400	VpnGateway.Configuring	The specified service is configuring.
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.
404	InvalidSslVpnClientCertId.NotFound	The specified SSL VPN client cert id does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.