GetCertificate - Query certificate information | ESA API - Edge Security Acceleration

Retrieves information about a specified certificate for a site.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

esa:GetCertificate

list

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	The site ID. You can call the ListSites operation to query the site ID.	1234567890123
Id	string	Yes	The certificate ID.	babaded901474b9693acf530e0fb1d95

Response elements

Element	Type	Description	Example
	object	Schema of Response
SiteId	integer	The site ID.	1234567890123
SiteName	string	The site name.	example.com
Status	string	The certificate status.	OK
Certificate	string	The certificate content.	-----BEGIN CERTIFICATE-----
Result	object	The certificate information.
CasId	string	The cloud certificate ID.	30000478
Id	string	The certificate ID.	babaded901474b9693acf530e0fb1d95
Name	string	The certificate name.	yourCertName
Region	string	The region.	cn-hangzhou
Status	string	The certificate status.	OK
Type	string	The certificate type. Valid values: cas : SSL Certificates Service certificate. upload : custom uploaded certificate. keyless : Keyless certificate. free : free certificate.	free
CommonName	string	The Common Name (CN) field of the certificate.	www.example.com
NotBefore	string	The start time of the certificate validity period. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.	2026-07-01 06:26:47
NotAfter	string	The end time of the certificate validity period. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.	2026-09-29 06:26:46
Issuer	string	The certificate issuer.	DigiCert
IssuerCN	string	The certification authority.	DigiCert Global Root CA
SAN	string	The Subject Alternative Name (SAN) of the certificate.	www.example.com,*.example.com
SigAlg	string	The signature algorithm of the certificate.	ECDSA-SHA1
PubAlg	string	The public key algorithm of the certificate.	ECDSA
CreateTime	string	The creation time. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.	2026-07-01 07:25:23
UpdateTime	string	The update time. The time is in the YYYY-MM-DD HH:MM:SS format in the UTC/GMT time zone.	2026-07-01 07:25:23
SerialNumber	string	The certificate serial number.	babaded901474b9693acf530e0fb1daa
FingerprintSha256	string	The SHA-256 fingerprint of the certificate.	1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66
DCV	array<object>	The Domain Control Validation (DCV) information.
	object	The Domain Control Validation (DCV) information.
Id	string	The DCV ID.	bababf7cdd1546a2ad04c0def1f4c980
Type	string	The DCV type. Valid values: `DNS` and `HTTP`. Valid values: DNS : DNS HTTP : HTTP	HTTP
Key	string	The DCV name. For DNS, this is the TXT record name. For HTTP, this is the URL.	http://www.example.com/.well-known/acme-challenge/pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow
Value	string	The value required for the DCV check. For a DNS check, this is the TXT record value. For an HTTP check, this is the content of the validation file.	pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow.KfzYo4LH3EgOt7a73G-RqZkbR0eYtLfEUmtmqGmr4FQ
Status	string	The status of the DCV check.	pending
ApplyCode	integer	The error code of the certificate application.	2
ApplyMessage	string	The error message of the certificate application.	canceled
KeyServerId	string	The Keyless server ID. This parameter is valid only when Type is set to keyless.	baba39055622c008b90285a8838e****
RequestId	string	The request ID.	04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Success response

JSON format

{
  "SiteId": 1234567890123,
  "SiteName": "example.com ",
  "Status": "OK",
  "Certificate": "-----BEGIN CERTIFICATE-----",
  "Result": {
    "CasId": "30000478",
    "Id": "babaded901474b9693acf530e0fb1d95",
    "Name": "yourCertName",
    "Region": "cn-hangzhou",
    "Status": "OK",
    "Type": "free",
    "CommonName": "www.example.com",
    "NotBefore": "2026-07-01 06:26:47",
    "NotAfter": "2026-09-29 06:26:46",
    "Issuer": "DigiCert",
    "IssuerCN": "DigiCert Global Root CA",
    "SAN": "www.example.com,*.example.com",
    "SigAlg": "ECDSA-SHA1",
    "PubAlg": "ECDSA",
    "CreateTime": "2026-07-01 07:25:23",
    "UpdateTime": "2026-07-01 07:25:23",
    "SerialNumber": "babaded901474b9693acf530e0fb1daa",
    "FingerprintSha256": "1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66",
    "DCV": [
      {
        "Id": "bababf7cdd1546a2ad04c0def1f4c980",
        "Type": "HTTP",
        "Key": "http://www.example.com/.well-known/acme-challenge/pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow",
        "Value": "pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow.KfzYo4LH3EgOt7a73G-RqZkbR0eYtLfEUmtmqGmr4FQ",
        "Status": "pending"
      }
    ],
    "ApplyCode": 2,
    "ApplyMessage": "canceled",
    "KeyServerId": "baba39055622c008b90285a8838e****"
  },
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

Error codes

HTTP status code	Error code	Error message	Description
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.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.