ApplyCertificate - Apply for free SSL/TLS certificates | ESA API - Edge Security Acceleration

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:ApplyCertificate

create

*Site

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

None

Request parameters

Parameter	Type	Required	Description	Example
SiteId	integer	Yes	The site ID.	1234567890123
Domains	string	Yes	A comma-separated list of domain names.	www.example.com,blog.example.com
Type	string	No	The certificate type. Valid values: `lets_encrypt` (Let's Encrypt), `digicert_single` (DigiCert single-domain), and `digicert_wildcard` (DigiCert wildcard). Valid values: digicert_wildcard : digicert_wildcard lets_encrypt : lets_encrypt digicert_single : digicert_single	lets_encrypt

Response elements

Element	Type	Description	Example
	object	The response object.
SiteName	string	The site name.	example.com
TotalCount	integer	The total number of certificates applied for. Matches the number of domain names in the request.	2
Result	array<object>	Application details for each certificate.
	object	Details of a certificate application.
Domain	string	The certificate domain name.	*.example.com
Status	string	The certificate application status.	Applying
Id	string	The certificate ID.	30000478
RequestId	string	The request ID.	156A6B-677B1A-4297B7-9187B7-2B44792

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	SiteNotFound	The specified site is not found.	The specified site does not exist. Verify the site ID.
400	SiteNotActivated	The site is not activated, the process is not allowed.	The operation is not supported because the site is not activated.
400	MissingSiteId	Required parameter SiteId missing. Specify SiteId and try again.	Required parameter SiteId missing. Specify SiteId and try again.
400	InvalidParameter.Domains	You have already submitted a certificate application for the domain name.	You have already submitted a certificate application for the domain name.
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	QuotaCheckFailed	Failed to check free certificate Quota, please try again later.	Failed to check free certificate Quota, please try again later.
400	InvalidParameter.Type	The specified Type parameter is invalid, please check and try again.	The Type parameter is invalid. Valid values: lets_encrypt, digicert_single, digicert_wildcard.
400	QuotaExceed.RecordCount	The 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.
403	Unauthorized.InvalidTime	The specified authentication time is invalid.	The authentication time is invalid. Verify the parameter and try again.
403	Unauthorized.InvalidToken	Token authentication failed.	The token is invalid. Provide a valid token and try again.
403	QuotaExceeded	The quota is exceeded.	The quota is exceeded.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.