Obtain SSL Certificate Information - DescribeSSL

Overview

Obtain SSL certificate information, can only get the binding relationship between SSL certificate and traditional load balancer listener.

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeSSL`.	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
Region	string	Region. See List of Regions and Availability Zones	Yes
ProjectId	string	Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.	Yes
SSLId	string	Id of SSL Certificate	No
Limit	int	Data pagination value, default is 20	No
Offset	int	Data offset, default value 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
TotalCount	int	Total number of eligible SSL certificates	No
DataSet	array[ULBSSLSet]	Details of SSL Certificate, see the specific structure in ULBSSLSet	No

Data Model

ULBSSLSet

Field Name	Type	Description Information	Required
SSLId	string	Id of SSL Certificate	No
SSLName	string	Name of the SSL Certificate	No
SSLType	string	SSL Certificate type, currently only Pem type is available	No
SSLContent	string	Content of the SSL Certificate	No
CreateTime	int	Creation time of the SSL certificate	No
HashValue	string	HASH value of SSL certificate	No
BindedTargetSet	array[SSLBindedTargetSet]	Object bound to the SSL certificate	No
SSLSource	int	Source of SSL Certificate, Source of SSL Certificate, 0 represents the certificate is from the ULB platform, 1 represents the certificate is from the USSL platform.	No
USSLId	string	The ID of the USSL Certificate Platform, only appears when SSLSource is 1.	No
Domains	string	Domain name of the SSL Certificate platform, when there are multiple domain names, extended domain names are not displayed.	No
NotBefore	int	Certificate Issuance Time	No
NotAfter	int	Certificate Expiration Time	No

SSLBindedTargetSet

Field Name	Type	Description Information	Required
VServerId	string	Resource ID of the VServer to which the SSL certificate is bound	No
VServerName	string	The name of the corresponding VServer	No
ULBId	string	The resource ID of the ULB instance to which the VServer belongs	No
ULBName	string	Name of the ULB instance	No

Example

Request Example

https://api.surfercloud.com/?Action=DescribeSSL
&Region=cn-bj2
&ProjectId=project-XXXXXX

Response Example

{
  "Action": "DescribeSSLResponse",
  "DataSet ": [
    {
      "CreateTime": 1418099063,
      "HashValue": "1d5da9cf215d7c0e7b41b85af8adac2b",
      "SSLContent": "-----BEGIN RSA PRIVATE KEY-----\nXXXXXXXXXXXXX\n-----END CERTIFICATE-----",
      "SSLId": "ssl-XXXXX",
      "SSLName": "testpem",
      "SSLType": "Pem",
      "VServerId": ""
    }
  ],
  "RetCode": 0,
  "TotalCount": 1
}

DescribeVServer DescribeSecurityPolicies