tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ApplyCertificate

Last updated: 2024-07-30 17:02:34

    1. API Description

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

    This API is used to apply for a free certificate.

    A maximum of 10 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 Name Required Type Description
    Action Yes String Common Params. The value used for this API: ApplyCertificate.
    Version Yes String Common Params. The value used for this API: 2019-12-05.
    Region No String Common Params. This parameter is not required for this API.
    DvAuthMethod Yes String Validation type. DNS_AUTO: automatic DNS validation; DNS: manual DNS validation; FILE: file validation.
    DomainName Yes String Domain name
    ProjectId No Integer Project ID
    PackageType No String Certificate type. Currently, the only supported value is 2, which indicates TrustAsia TLS RSA CA.
    ContactEmail No String Email address
    ContactPhone No String Mobile number
    ValidityPeriod No String Validity period. The default value is 12 months, which is the only supported value currently.
    CsrEncryptAlgo No String Encryption algorithm. RSA and ECC are supported.
    CsrKeyParameter No String Key pair parameters. RSA supports only 2048. ECC supports only prime256v1. When the encryption algorithm is set to ECC, this parameter is mandatory.
    CsrKeyPassword No String CSR encryption password
    Alias No String Alias
    OldCertificateId No String Original certificate ID, which is used to apply for a new certificate.
    PackageId No String Benefit package ID, which is used to expand the free certificate package
    DeleteDnsAutoRecord No Boolean Whether to delete the automatic domain name verification record after issuance, which is no by default. This parameter can be passed in only for domain names of the DNS_AUTO verification type.
    DnsNames.N No Array of String

    3. Output Parameters

    Parameter Name Type Description
    CertificateId String Certificate ID
    RequestId String The 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 Applying for a free certificate

    This example shows you how to apply for a free certificate.

    Input Example

    POST / HTTP/1.1
Host: ssl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ApplyCertificate
<Common request parameters>

{
    "DvAuthMethod": "DNS_AUTO",
    "DomainName": "wgc.red"
}

    Output Example

    {
    "Response": {
        "CertificateId": "a9TsmZkL",
        "RequestId": "0b39eaa4-f938-476d-9b26-19fb07b80936"
    }
}

    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 Code Description
    FailedOperation Operation failed.
    FailedOperation.AuthError You do not have permission to perform this operation.
    FailedOperation.CancelOrderFailed Failed to cancel the order.
    FailedOperation.CannotBeDeletedIssued Failed to delete the certificate because it has been issued.
    FailedOperation.CannotBeDeletedWithinHour Free certificates cannot be deleted within 1 hour after being applied for.
    FailedOperation.CannotGetOrder Failed to get order information. Try again later.
    FailedOperation.CertificateInvalid The certificate is invalid.
    FailedOperation.CertificateMismatch The certificate and the private key do not match.
    FailedOperation.CertificateNotFound The certificate does not exist.
    FailedOperation.ExceedsFreeLimit The number of free certificates exceeds the maximum value.
    FailedOperation.InvalidCertificateStatusCode The certificate status is incorrect.
    FailedOperation.InvalidParam Incorrect parameters.
    FailedOperation.MainDomainCertificateCountLimit The number of free certificates applied for under the primary domain name (%s) has reached the upper limit of %s. Please purchase a paid certificate.
    FailedOperation.NetworkError The CA system is busy. Try again later.
    FailedOperation.NoProjectPermission You do not have the permission to operate on this project.
    FailedOperation.NoRealNameAuth You have not completed the identity verification.
    FailedOperation.OrderAlreadyReplaced This order has already been replaced.
    FailedOperation.OrderReplaceFailed Failed to reissue a certificate.
    FailedOperation.PackageCountLimit The remaining benefit points are insufficient.
    FailedOperation.PackageExpired The benefit package has expired.
    FailedOperation.PackageNotFound The benefit package does not exist.
    InternalError Internal error.
    InvalidParameter The parameter is incorrect.
    InvalidParameter.PackageIdsInvalid The list of benefit point IDs is invalid.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy