All Products
Search
Document Center

Edge Security Acceleration:GetCertificate

Last Updated:Nov 07, 2025
This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Retrieve the certificate, private key, and certificate information

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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 Resources is 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.
OperationAccess levelResource typeCondition keyAssociated operation
esa:GetCertificatelist
*Site
acs:esa:{#regionId}:{#accountId}:site/{#SiteId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SiteIdlongYes

Site ID, which can be obtained by calling the ListSites interface.

1234567890123
IdstringYes

Certificate ID.

babaded901474b9693acf530e0fb1d95

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

SiteIdlong

Site ID.

1234567890123
SiteNamestring

Site name.

example.com
Statusstring

Certificate status.

OK
Certificatestring

Certificate content.

-----BEGIN CERTIFICATE-----
Resultobject

The certificate information.

CasIdstring

Cloud certificate ID.

30000478
Idstring

Certificate ID.

babaded901474b9693acf530e0fb1d95
Namestring

Certificate name.

yourCertName
Regionstring

Region.

cn-hangzhou
Statusstring

Certificate status.

OK
Typestring

Certificate type.

free
CommonNamestring

Common Name (CN) field of the certificate.

www.example.com
NotBeforestring

Start time of the certificate validity period.

2023-11-26T16:00:00Z
NotAfterstring

End time of the certificate validity period.

2023-11-26T16:00:00Z
Issuerstring

Certificate issuer.

DigiCert
IssuerCNstring

Certificate issuing authority.

DigiCert Global Root CA
SANstring

Subject Alternative Name (SAN) of the certificate.

www.example.com,*.example.com
SigAlgstring

Certificate signature algorithm.

ECDSA-SHA1
PubAlgstring

Certificate public key algorithm.

ECDSA
CreateTimestring

Creation time.

2020-05-12 02:00:53
UpdateTimestring

Update time.

2022-09-22 05:33:13
SerialNumberstring

Serial number of the certificate.

babaded901474b9693acf530e0fb1daa
FingerprintSha256string

SHA256 fingerprint of the certificate.

1dc5fc9af4eead2570c70d94b416130baeb6d4429b51fd3557379588456aca66
DCVarray<object>

The Domain Control Validation (DCV) information.

DCVobject
Idstring

The DCV ID.

bababf7cdd1546a2ad04c0def1f4c980
Typestring

The DCV type. Valid values: DNS and HTTP.

HTTP
Keystring

The DCV name. It is a TXT record name if Type is DNS or URL if Type is HTTP.

http://www.example.com/.well-known/acme-challenge/pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow
Valuestring

The DCV content.

pH20CqwS5L3ZnvkhI436DCzadKFuG7QcUcvB_4KsAow.KfzYo4LH3EgOt7a73G-RqZkbR0eYtLfEUmtmqGmr4FQ
Statusstring

The verification status.

pending
ApplyCodelong

The error code returned for certificate application.

2
ApplyMessagestring

The error message returned for certificate application.

canceled
RequestIdstring

Request ID.

04F0F334-1335-436C-A1D7-6C044FE73368

Examples

Sample success responses

JSONformat

{
  "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": "2023-11-26T16:00:00Z",
    "NotAfter": "2023-11-26T16:00:00Z",
    "Issuer": "DigiCert",
    "IssuerCN": "DigiCert Global Root CA",
    "SAN": "www.example.com,*.example.com",
    "SigAlg": "ECDSA-SHA1",
    "PubAlg": "ECDSA",
    "CreateTime": "2020-05-12 02:00:53",
    "UpdateTime": "2022-09-22 05:33:13",
    "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"
  },
  "RequestId": "04F0F334-1335-436C-A1D7-6C044FE73368"
}

Error codes

HTTP status codeError codeError messageDescription
400MissingSiteIdRequired parameter SiteId missing. Specify SiteId and try again.Required parameter SiteId missing. Specify SiteId and try again.
400InternalExceptionFailed to call the service. Try again later or contact technical support.Failed to call the service. Try again later or contact technical support.
400Id.MissingParameterThe parameter Id is required.The required parameter Id is missing.
403Unauthorized.InvalidTimeThe specified authentication time is invalid.The authentication time parameter you entered is invalid. Check the parameter value and try again.
403Unauthorized.InvalidTokenToken authentication failed.The token you entered is invalid. Please check and enter the correct token and try again.
404Certificate.NotFoundThe specified certificate does not exist.The specified certificate does not exist.

For a list of error codes, visit the Service error codes.