Obtain SSL Certificate Information - DescribePathXSSL

Overview

Obtain SSL certificate information, support pagination, support fuzzy search by certificate name and certificate domain name.

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribePathXSSL`.	Yes
PublicKey	string	The user's public key can be obtained from Console (opens in a new tab)	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required
ProjectId	string	Project ID. Please refer to the GetProjectList interface.	Yes
SSLId	string	The Id of the SSL certificate, if not passed, get the certificate list by pagination	No
SearchValue	string	If not empty, search by certificate name and domain name and return paginated results	No
Limit	int	Maximum number of return entries, default is 100, maximum is 400	No
Offset	int	Offset Default is 0	No

Response Field

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No
DataSet	array[PathXSSLSet]	Detailed information of SSL certificate, see the specific structure in PathXSSLSet	No
TotalCount	int	Total number of eligible certificates	No

Data Model

PathXSSLSet

Field Name	Type	Description Information	Required
SSLId	string	Id of SSL Certificate	No
SSLName	string	Name of the SSL Certificate	No
SubjectName	string	UCertificate	No
ExpireTime	int	Certificate Expiration Time Timestamp	No
SourceType	int	Certificate source, 0: User upload 1: Free issuance	No
SSLMD5	string	MD5 value of SSL certificate (user certificate, private key, ca certificate combined) content	No
CreateTime	int	Creation time of SSL certificate Timestamp	No
SSLBindedTargetSet	array[SSLBindedTargetSet]	Object Bound to SSL Certificate	No
SSLContent	string	SSL Certificate Content	No

SSLBindedTargetSet

Field Name	Type	Description Information	Required
ResourceId	string	Instance ID to which the SSL certificate is bound	Yes
ResourceName	string	Name of the instance to which the SSL certificate is bound	No

Example

Request Example

https://api.surfercloud.com/?Action=DescribePathXSSL
&ProjectId=org-xxx
&SSLId=gssl-xxxx
&SearchValue=
&Limit=10
&Offset=0

Response Example

{
  "Action": "DescribePathXSSLResponse",
  "DataSet": [
    {
      "CreateTime": 1580000001,
      "ExpireTime": 1590000001,
      "SSLBindedTargetSet": [
        {
          "ResourceId": "uga-xxx",
          "ResourceName": "testl7"
        }
      ],
      "SSLContent": "----BEGIN-----",
      "SSLId": "gssl-xxxx",
      "SSLMD5": "132321312323==",
      "SSLName": "test",
      "SubjectName": "www.uclouds.com"
    }
  ],
  "RetCode": 0,
  "TotalCount": 8
}

DescribePathXLineConfig DescribeUGAInstance