All Products
Search

This Product

    Edge Security Acceleration:SetCertificate

    Document Center

    Edge Security Acceleration:SetCertificate

    Last Updated:Jun 25, 2026

    Configures whether to enable the certificate feature for a site and updates certificate information.

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

    none

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    SiteId

    integer

    Yes

    The site ID. You can call the ListSites operation to obtain the site ID.

    1234567890123
    Name

    string

    No

    The certificate name. This parameter is required when Type is set to upload.

    yourCertName
    CasId

    integer

    No

    The cloud certificate ID. This parameter is required when Type is set to cas.

    30000478

    Type

    string

    Yes

    The certificate type. Valid values:

    • cas: certificate from SSL Certificates Service.

    • upload: custom uploaded certificate.

    • keyless: keyless certificate.

    Valid values:

    • cas :

      Certificate from SSL Certificates Service.

    • upload :

      Custom uploaded certificate.

    • keyless :

      Keyless certificate.

    cas
    Certificate

    string

    No

    The certificate content. This parameter is required when Type is set to upload.

    -----BEGIN CERTIFICATE-----
    PrivateKey

    string

    No

    The certificate private key. This parameter is required when Type is set to upload.

    -----BEGIN PRIVATE KEY-----
    Region

    string

    No

    The region. This parameter is required when Type is set to cas. Valid values:

    • China site accounts: cn-hangzhou.

    • International site accounts: ap-southeast-1.

    cn-hangzhou
    Id

    string

    No

    The certificate ID. Certificates of the free type (created by calling the ApplyCertificate operation) are not supported. Certificates of the cas and upload types are supported.

    babae7c40fef412d887688b91c9e****
    KeyServerId

    string

    No

    The keyless server ID. This parameter takes effect only when Type is set to keyless.

    1233112****

    Response elements

    Element

    Type

    Description

    Example

    object

    Schema of Response

    RequestId

    string

    The request ID.

    A666D44F-19D6-490E-97CF-1A64AB962C57
    Id

    string

    The certificate ID.

    babae7c40fef412d887688b91c9e****

    Examples

    Success response

    JSON format

    {
  "RequestId": "A666D44F-19D6-490E-97CF-1A64AB962C57",
  "Id": "babae7c40fef412d887688b91c9e****"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 Certificate.StatusError The status of the certificate is invalid. The specified certificate status is invalid.
    400 Certificate.Duplicated The certificate name already exists. The certificate is duplicated.
    400 InvalidParameter The specified parameter is invalid. The specified parameter is invalid.
    400 InvalidCertificate.NotFound The specified certificate does not match the website. Check the validity of the certificate and try again. The specified certificate does not match the website. Check the validity of the certificate and try again.
    400 InvalidSSLPub The specified Certificate is invalid. The value specified for the Certificate parameter is invalid.
    400 InvalidSSLPri The specified PrivateKey is invalid. The value specified for the PrivateKey parameter is invalid.
    400 CasId.MissingParameter The CasId parameter is required. The CasId parameter is missing.
    400 PrivateKey.MissingParameter The PrivateKey parameter is required. Missing PrivateKey parameter.
    400 Certificate.MissingParameter The Certificate parameter is required. Missing Certificate parameter.
    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 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 UpdateFreeCertificate.NotSupport The free certificate does not support the update operation. The free certificate does not support the update operation.
    400 CertificateDomainNotMatchSite The domain name in the specified certificate does not match the site. The domain name in the certificate does not match the current site.
    400 CertificateNotMatchPrivateKey The specified certificate does not match the private key. The specified certificate and private key do not match.
    400 CertQuotaCheckFailed The custom certificate quota verification failed. The number of uploaded certificates exceeds the upper limit allowed for the plan. The custom certificate quota verification failed. The number of uploaded certificates exceeds the upper limit allowed for the plan.
    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.