SSL Hosted Certificate API¶

POST Query SSL Hosted Certificates¶

POST /prod-api/cdn/ssl/hosting/describeHosting

Body request parameters

{
  "pageNum": 10,
  "pageSize": 1
}

request parameters¶

Name	Location	Type	Required	Chinese Name	Description
Authorization	header	string	Yes		none
body	body	object	Yes		none
» filters	body	[object]	No	Search conditions	none
»» label	body	string	No	Parameter name	alias：represents alias
»» value	body	[string]	No	Value	Array type, single value for fuzzy search, multiple values for exact search
» pageNum	body	integer(int32)	Yes	Current page number	none
» pageSize	body	integer(int32)	Yes	Items per page	none
» searchHeader	body	object	No	Filter conditions	none
»» certEndDay	body	string	Yes	Parameter name (expiry time)	7: represents 7 days until expiry

Detailed Description¶

»» label: alias: represents alias issuerDN: represents certificate type

»» certEndDay: 7: represents 7 days until expiry 30: represents 30 days until expiry

Response Example

200 Response

{
  "total": 6,
  "rows": [
    {
      "certId": 91,
      "status": 0,
      "dnsName": "*.demo.com,demoy.com",
      "alias": "*.demoy.com",
      "sslcrt": "-----BEGIN CERTIFICATE-----\nMIIHlzCCBX+gAwIBAgIQBiis4ELtiiXRwdC6m/B4UzANBgkqhkiG9w0BAQsFADBc\nMQswCQYDVQQGEwJVUzEXMBUGA1UEChMORGlnaUNlcnQsIEluYy4xNDAyBgNVBAMT\nK1JhcGlkU1NMIEdsb2JhbCBUTFMgUlNBNDA5NiBTSEEyNTYgMjAyMiBDQTEwHhcN\nMjQwNDIzMDAwMDAwWhcNMj+Q76tV4/EMUlaU05FL9XPuTv7fdFAGkSNXltAyVABDnVp8uBxF8zSA\nn0d7wuxS8hrDs12Iti/Inz5lpi8igUinXRFB\n-----END CERTIFICATE-----\n-----BEGIN CERTIFICATE-----\nMIIFyzCCBLOgAwIBAgIQCgWbJfVLPYeUzGYxR3U4ozANBgkqhkiG9w0BAQsFADBh\nMQswCQYDVv1sAgEwBwYFZ4EMAQEwCAYGZ4EMAQIBMAgGBmeBDAEC\nAjAIBgZngQwBAgMwDQYJKoZIhvcNAQELBQADggEBAAfjh/s1f5dDdfm0sNm74/dW\nMbbsxfYV1LoTpFt+3MSUWvSbiPQfUkoV57b5rutRJvnPP9mSlpFwcZ3e1nSUbi2o\nITGA7RCOj23I1F4zk0YJm42qAwJIqOVenR3XtyQ2+9i1R4Fg5zPNvHs2BbIve0vkwxAy+R4727qYzl3027w9jEFC6HMXRaDc=\n-----END CERTIFICATE-----",
      "subjectDN": "*.demoyy.com",
      "issuerDN": "Rapi SHA256 2022 CA1",
      "beginTime": null,
      "endTime": "2025-04-23 07:59:59",
      "createTime": "2024-09-07 17:12:14"
    }
  ],
  "code": 200,
  "msg": "Success"
}

201 Response

{}

Response Results¶

Status Code	Meaning	Description	Data Model
200	OK	none	Inline
201	Created	none	Inline
401	Unauthorized	none	Inline
403	Forbidden	none	Inline
404	Not Found	none	Inline

Response Data Structure¶

Status Code 200

Name	Type	Required	Constraints	Chinese Name	Description
» total	integer	true	none		none
» rows	[object]	true	none		none
»» certId	integer	false	none	Certificate ID	none
»» status	integer	false	none	Status	0：represents uploaded hosting 1：represents whether remainder equals 1 when status code divided by 10 (pending verification)证 2：represents processing 3：represents issued 4：represents verification failed
»» dnsName	string	false	none	Other domains	none
»» alias	string	false	none	Alias	none
»» sslcrt	string	false	none	Certificate content	none
»» subjectDN	string	false	none	Common name	none
»» issuerDN	string	false	none	Certificate type	none
»» beginTime	null	false	none	Start time	none
»» endTime	string	false	none	Expiry time	none
»» createTime	string	false	none	Submission time	none
» code	integer	true	none		none
» msg	string	true	none		none

Data Model¶

SearchFilterVo

{
  "label": "string",
  "value": ["string"]
}

SearchFilterVo

Properties¶

Name	Type	Required	Constraints	Chinese Name	Description
label	string	false	none		none
value	[string]	false	none		none

DescribeSSLHostingVO

{
  "country": "string",
  "domainId": 0,
  "filters": [
    {
      "label": "string",
      "value": ["string"]
    }
  ],
  "pageNum": 0,
  "pageSize": 0,
  "params": {},
  "searchHeader": {},
  "searchValue": "string",
  "tableCul": {
    "property1": "string",
    "property2": "string"
  },
  "userId": 0
}

DescribeSSLHostingVO

Properties¶

Name	Type	Required	Constraints	Chinese Name	Description
country	string	false	none		none
domainId	integer(int64)	false	none		none
filters	[SearchFilterVo]	false	none		none
pageNum	integer(int32)	true	none	Current page number	none
pageSize	integer(int32)	true	none	Items per page	none
params	object	false	none		none
searchHeader	object	false	none	Filter conditions	none
searchValue	string	false	none		none
tableCul	object	false	none		none
» additionalProperties	string	false	none		none
userId	integer(int64)	false	none		none