Queries a client certificate.
Debugging
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:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis 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.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| esa:GetClientCertificate | get |
*Site
acs:esa:{#regionId}:{#accountId}:site/{#SiteId} |
|
none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| SiteId | long | Yes |
The website ID. |
1234567890123 |
| Id | string | Yes |
The certificate ID. |
baba39055622c008b90285a8838ed09a |
Response parameters
Examples
Sample success responses
JSONformat
{
"SiteId": 1234567890123,
"SiteName": "example.com\n",
"Status": "active",
"Certificate": "-----BEGIN CERTIFICATE-----",
"Result": {
"Id": "baba39055622c008b90285a8838ed09a",
"Name": "yourCertName",
"Status": "active",
"Type": "dcdn",
"CommonName": "www.example.com ",
"NotBefore": "2023-03-31 02:08:00",
"NotAfter": "2024-03-31 02:08:00",
"Issuer": "GlobalSign nv-sa",
"SAN": "www.example.com,*.example.com",
"SignatureAlgorithm": "SHA256-RSA",
"PubkeyAlgorithm": "RSA",
"CreateTime": "2024-06-24 07:48:51",
"UpdateTime": "2024-09-22 05:33:13",
"CACertificateId": "babab9db65ee5efcca9f3d41d4b50d66"
},
"RequestId": "0AEDAF20-4DDF-4165-8750-47FF9C1929C9"
}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. |
| 400 | Id.MissingParameter | The parameter Id is required. | The required parameter Id is missing. |
| 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. |
| 404 | Certificate.NotFound | The specified certificate does not exist. | The specified certificate does not exist. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-03-12 | The Error code has changed. The response structure of the API has changed | View Change Details |