All Products
Search
Document Center

Virtual Private Cloud:DescribeSslVpnClientCerts

Last Updated:Feb 22, 2024

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vpc:DescribeSslVpnClientCertsList
  • SslVpnClientCert
    acs:vpc:{#regionId}:{#accountId}:sslvpnclientcert/*
  • SslVpnClientCert
    acs:vpc:{#regionId}:{#accountId}:sslvpnclientcert/{#SslVpnClientCertId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

The region ID of the SSL client certificate.

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

cn-hangzhou
SslVpnServerIdstringNo

The ID of the SSL server.

vss-bp18q7hzj6largv4v****
SslVpnClientCertIdstringNo

The ID of the SSL client certificate.

vsc-bp1n8wcf134yl0osr****
NamestringNo

The name of the SSL client certificate.

cert1
PageNumberintegerNo

The page number. Default value: 1.

1
PageSizeintegerNo

The number of entries per page. Default value: 10. Valid values: 1 to 50.

10
ResourceGroupIdstringNo

The ID of the resource group to which the SSL client certificate belongs.

The SSL client certificate is the same as the resource group of the SSL server associated with it. You can call the DescribeSslVpnServers operation to query the ID of the resource group to which the SSL server belongs.

rg-acfmzs372yg****

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

PageSizeinteger

The number of entries per page.

10
RequestIdstring

The request ID.

5BE01CD7-5A50-472D-AC14-CA181C5C03BE
PageNumberinteger

The number of the page to return.

1
TotalCountinteger

The number of entries returned.

1
SslVpnClientCertKeysobject []

The information about the SSL client certificates.

Statusstring

The status of the SSL client certificate. Valid values:

  • expiring-soon
  • normal
  • expired
normal
EndTimelong

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

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.

1494966335000
CreateTimelong

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

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.

1492747187000
SslVpnClientCertIdstring

The ID of the SSL client certificate.

vsc-bp1n8wcf134yl0osr****
SslVpnServerIdstring

The ID of the SSL server.

vss-bp18q7hzj6largv4v****
Namestring

The name of the SSL client certificate.

cert1
RegionIdstring

The region where the SSL client certificate is created.

cn-hangzhou
ResourceGroupIdstring

The ID of the resource group to which the SSL client certificate belongs.

You can call the ListResourceGroups operation to query the resource group information.

rg-acfmzs372yg****

Examples

Sample success responses

JSONformat

{
  "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 codeError codeError messageDescription
403Forbbiden.SubUserUser not authorized to operate on the specified resource as your account is created by another user.You are unauthorized to perform this operation on the specified resource. Acquire the required permissions and try again.
403ForbiddenUser 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.
404InvalidRegionId.NotFoundThe specified region is not found during access authentication.The specified area is not found during authentication.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2023-10-19API Description Update. The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 403
    delete Error Codes: 404
Input ParametersThe request parameters of the API has changed.
    Added Input Parameters: ResourceGroupId
Output ParametersThe response structure of the API has changed.