Overview
Menu

ModifyHostsCertificate

1. API Description

Domain name for API request: teo.tencentcloudapi.com.

This API is used to configure the certificate of a site. You can use your own certificate or apply for a free certificate.
To use an external certificate, upload the certificate to SSL Certificates Console first, and then input the certificate ID in this API. For details, see Deploying Own Certificates to EdgeOne Domains.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter NameRequiredTypeDescription
ActionYesStringCommon Params. The value used for this API: ModifyHostsCertificate.
VersionYesStringCommon Params. The value used for this API: 2022-09-01.
RegionNoStringCommon Params. This parameter is not required.
ZoneIdYesStringID of the site.
Hosts.NYesArray of StringDomain names that you need to modify the certificate configuration
ModeNoStringCertificate configuration mode. Values:
  • disable: (Default) Do not configure the certificate
  • eofreecert: Use a free certificate provided by EdgeOne
  • sslcert: Configure an SSL certificate.
  • ServerCertInfo.NNoArray of ServerCertInfoID of the SSL certificate. It takes effect when mode=sslcert. To check the certificate ID, go to the SSL Certificate console.

    3. Output Parameters

    Parameter NameTypeDescription
    RequestIdStringThe unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Configuring an SSL certificate

    Add the certificate cert-244ffgv 7m17xw to the domain name abc.test.com under the site zone-2fgd 17m17xw.

    Input Example

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifyHostsCertificate
    <Common request parameters>
    
    {
        "ZoneId": "zone-2fgd17m17xw",
        "Hosts": [
            "abc.test.com"
        ],
        "Mode": "sslcert",
        "ServerCertInfo": [
            {
                "CertId": "cert-244ffgv7m17xw"
            }
        ]
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "5e5a0d0f-52f3-4bad-9bd3-dcf1d5c954e7"
        }
    }
    

    Example2 Configuring a free certificate

    Configure a free certificate for the domain name abc.test.com under the site zone-2fgd17m17xw.

    Input Example

    POST / HTTP/1.1
    Host: teo.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: ModifyHostsCertificate
    <Common request parameters>
    
    {
        "ZoneId": "zone-2fgd17m17xw",
        "Hosts": [
            "abc.test.com"
        ],
        "Mode": "eofreecert"
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "084d5612-67a7-4aca-aac9-827aa3662b2d"
        }
    }
    

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error CodeDescription
    FailedOperationOperation failed.
    FailedOperation.CertificateHasExpiredFailed to publish: The certificate has expired.
    FailedOperation.CertificateNotFoundThe certificate does not exist.
    FailedOperation.InvalidZoneStatusThe site status is invalid.
    FailedOperation.ModifyFailedOperation failed.
    InternalError.ConfigLockedThe configuration is locked. Please unlock and try again.
    InternalError.GetRoleErrorFailed to get the role.
    InternalError.ProxyServerAn unknown error occurred in the backend server.
    InternalError.RouteErrorThe backend routing address is incorrect.
    InternalError.SystemErrorInternal system error.
    InternalError.UnknowErrorUnknown error.
    InvalidParameter.ActionInProgressToo many attempts. Please try again later.
    InvalidParameter.CertNotMatchDomainMismatch between the HTTPS certificate and the domain name.
    InvalidParameter.CertToExpireThe HTTPS certificate is about to expire.
    InvalidParameter.CertTooShortKeySizeCertificate error.
    InvalidParameter.CnameWildHostNotAllowApplyCertificateUnable to apply for a wildcard certificate under CNAME mode.
    InvalidParameter.HostStatusNotAllowApplyCertificateCNAME is not switched or the origin is not routed to the EdgeOne server.
    InvalidParameter.InvalidCertInfoIncorrect certificate information.
    InvalidParameter.InvalidHttpsCertInfoInvalid HTTPS certificate.
    InvalidParameter.InvalidHttpsTlsVersionInvalid HTTPS TLS version.
    InvalidParameter.ZoneIsGrayPublishingThe site is being upgraded. Changing is not supported. Please try again later.
    LimitExceeded.RateLimitExceededReached the API rate limit.
    OperationDeniedOperation denied.
    OperationDenied.ConfigLockedThe configuration is locked. Please unlock and try again.
    OperationDenied.DisableZoneNotCompletedThe EdgeOne service of the site is being disabled. Please try again later.
    OperationDenied.ErrZoneIsAlreadyPausedThe EdgeOne service of the site is disabled. Please enable it and try again.
    OperationDenied.VersionControlIsGrayingThere is a test version in use. Please release the test version to the live environment, or roll back the test version and try again.
    ResourceInUseThe resource is occupied.
    ResourceUnavailable.CertNotFoundThe certificate does not exist or is not authorized.
    ResourceUnavailable.HostNotFoundThe domain name does not exist or not use a proxy.
    UnauthorizedOperation.CamUnauthorizedCAM is not authorized.