All Products
Search
Document Center

Edge Security Acceleration:ApplyCertificate

Last Updated:Mar 18, 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.

Applies for a free SSL certificate.

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:ApplyCertificatecreate
*Site
acs:esa:{#regionId}:{#accountId}:site/{#SiteId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
SiteIdlongYes

Site ID.

1234567890123
DomainsstringYes

List of domains, separated by commas.

www.example.com,blog.example.com
TypestringNo

The certificate type. Valid values: lets_encrypt, digicert_single, and digicert_wildcard.

lets_encrypt

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

SiteNamestring

Site name.

example.com
TotalCountlong

Number of certificates applied for, which is the same as the number of input domains.

2
Resultarray<object>

List of free certificate application details.

Resultobject

Details of the free certificate application.

Domainstring

Certificate domain.

*.example.com
Statusstring

Status of the certificate application.

Applying
Idstring

Certificate ID.

30000478
RequestIdstring

Request ID.

156A6B-677B1A-4297B7-9187B7-2B44792

Examples

Sample success responses

JSONformat

{
  "SiteName": "example.com ",
  "TotalCount": 2,
  "Result": [
    {
      "Domain": "*.example.com ",
      "Status": "Applying",
      "Id": "30000478"
    }
  ],
  "RequestId": "156A6B-677B1A-4297B7-9187B7-2B44792"
}

Error codes

HTTP status codeError codeError messageDescription
400SiteNotFoundThe specified site is not found.The site you specified does not exist. Please check whether the site you entered is correct.
400SiteNotActivatedThe site is not activated, the process is not allowed.The operation is not supported because the site is not activated.
400MissingSiteIdRequired parameter SiteId missing. Specify SiteId and try again.Required parameter SiteId missing. Specify SiteId and try again.
400InvalidParameter.DomainsYou have already submitted a certificate application for the domain name.You have already submitted a certificate application for the domain name.
400InternalExceptionFailed to call the service. Try again later or contact technical support.Failed to call the service. Try again later or contact technical support.
400InvalidParameter.DomainsThe maximum number of domain names specified by parameter Domains has been reached. Adjust your configurations and try again. The upper limit of lets.encrypt type domain name is 50, the upper limit of digicert.single type domain name is 10, and the upper limit of digicert.wildcard type domain name is 1.The maximum number of domain names specified by parameter Domains has been reached. Adjust your configurations and try again. The upper limit of lets_encrypt type domain name is 50, the upper limit of digicert_single type domain name is 10, and the upper limit of digicert_wildcard type domain name is 1.
400InvalidParameter.DomainsThe domain specified in Domains parameter is not a valid domain name, please check and try again.Domains there is an invalid domain name in the parameter, please check and try again.
400InvalidParameter.DomainsOne or more domain names specified by parameter Domains do not belong to the current website. Check and try again.One or more domain names specified by parameter Domains do not belong to the current website. Check and try again.
400QuotaCheckFailedFailed to check free certificate Quota, please try again later.Failed to check free certificate Quota, please try again later.
400InvalidParameter.TypeThe specified Type parameter is invalid, please check and try again.The Type parameter you configured is incorrect. Please check and try again. Certificate application type support lets_encrypt, digicert_single, digicert_wildcard.
400QuotaExceed.RecordCountThe maximum number of records has been reached. Delete some and try again or upgrade your plan.The maximum number of records has been reached. Delete some and try again or upgrade your plan.
400InvalidParameter.DomainsThe site which is configured in CNAME mode does not support wildcard domain certificate application.The CNAME site does not support applying for a free certificate for wildcard domain names.
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.
403QuotaExceededThe quota is exceeded.The quota is exceeded.

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