Lists the back-to-origin client certificates for a site.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| SiteId |
integer |
Yes |
The site ID. |
123456789**** |
| PageNumber |
integer |
No |
The page number. The default value is 1. |
1 |
| PageSize |
integer |
No |
The number of entries per page. |
20 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The request ID. |
15C66C7B-671A-4297-9187-2C4477247A74 |
| TotalCount |
integer |
The total number of real-time log projects. |
90 |
| PageNumber |
integer |
The page number. The default value is 1. |
1 |
| PageSize |
integer |
The number of entries per page. |
1024 |
| SiteId |
integer |
The site ID. |
123456789**** |
| SiteName |
string |
The site name. |
example.com |
| Result |
array<object> |
The list of certificate information. |
|
|
object |
The certificate information. |
||
| Id |
string |
The certificate ID. |
babaabcd**** |
| Name |
string |
The certificate name. |
yourCertName |
| Status |
string |
The certificate status. |
OK |
| Type |
string |
The certificate type. |
upload |
| CommonName |
string |
The common name of the certificate. |
www.example.com |
| NotBefore |
string |
The start time of the certificate validity period. |
2023-03-31 02:08:00 |
| NotAfter |
string |
The end time of the certificate validity period. |
2024-03-31 02:08:00 |
| Issuer |
string |
The certification authority. |
DigiCert |
| SAN |
string |
The subject alternative name (SAN) of the certificate. |
www.example.com,*.example.com |
| SignatureAlgorithm |
string |
The signature algorithm of the certificate. |
SHA256-RSA |
| PubkeyAlgorithm |
string |
The public-key algorithm of the certificate. |
RSA |
| CreateTime |
string |
The time when the certificate was created. |
2024-06-24 07:48:51 |
| UpdateTime |
string |
The time when the certificate was last updated. |
2022-09-22 05:33:13 |
| SerialNumber |
string |
The certificate serial number. |
babaded901474b9693acf530e0fb1d** |
| FingerprintSha256 |
string |
The SHA-256 fingerprint of the certificate. |
1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a**** |
Examples
Success response
JSON format
{
"RequestId": "15C66C7B-671A-4297-9187-2C4477247A74",
"TotalCount": 90,
"PageNumber": 1,
"PageSize": 1024,
"SiteId": 0,
"SiteName": "example.com ",
"Result": [
{
"Id": "babaabcd****",
"Name": "yourCertName",
"Status": "OK",
"Type": "upload",
"CommonName": "www.example.com ",
"NotBefore": "2023-03-31 02:08:00",
"NotAfter": "2024-03-31 02:08:00",
"Issuer": "DigiCert",
"SAN": "www.example.com,*.example.com",
"SignatureAlgorithm": "SHA256-RSA",
"PubkeyAlgorithm": "RSA",
"CreateTime": "2024-06-24 07:48:51",
"UpdateTime": "2022-09-22 05:33:13",
"SerialNumber": "babaded901474b9693acf530e0fb1d**",
"FingerprintSha256": "1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456a****"
}
]
}Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | InvalidParameter.SiteId | Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again. | Failed to query the website based on the SiteID you specified. Check parameter SiteId and try again. |
| 400 | MissingSiteId | Required parameter SiteId missing. Specify SiteId and try again. | Required parameter SiteId missing. Specify SiteId and try again. |
| 400 | InternalException | Failed to call the service. Try again later or contact technical support. | Failed to call the service. Try again later or contact technical support. |
| 403 | Unauthorized.InvalidTime | The specified authentication time is invalid. | The authentication time parameter you entered is invalid. Check the parameter value and try again. |
| 403 | Unauthorized.InvalidToken | Token authentication failed. | The token you entered is invalid. Please check and enter the correct token and try again. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.