tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ReplaceCertificate

Last updated: 2024-12-02 16:46:14

    1. API Description

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

    This API is used to reissue a certificate. Note that if you have applied for a free certificate, only an RSA-2048 certificate will be reissued, and the certificate can be reissued only once.

    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: ReplaceCertificate.
    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.
    CertificateId Yes String Certificate ID
    ValidType Yes String Validation type. DNS_AUTO: automatic DNS validation; DNS: manual DNS validation; FILE: file validation
    CsrType No String Type. original: original certificate CSR; upload: uploaded manually; online: generated online. The default value is original.
    CsrContent No String CSR content
    CsrkeyPassword No String Password of the key
    Reason No String Reissue reason
    CertCSREncryptAlgo No String The CSR encryption algorithm. Valid values: RSA (default), ECC1, and SM2.
    This parameter is available for selection only when the value of CsrType is Online.
    CertCSRKeyParameter No String The CSR encryption parameters. When CsrEncryptAlgo is set to RSA, 2048 (default) and 4096 are available for selection; and whenCsrEncryptAlgo is set to ECC, prime256v1 (default) and secp384r1 are available for selection.

    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 Reissuing a certificate

    Input Example

    https://ssl.intl.tencentcloudapi.com/?Action=ReplaceCertificate
&CertificateId=a91hoLqi
&ValidType=DNS
&<Common request parameters>

    Output Example

    {
    "Response": {
        "CertificateId": "a91hoLqo",
        "RequestId": "91afa3b6-5b67-43e1-b312-9d3b9bf0f410"
    }
}

    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.InvalidCertificateSource Certificate source error.
    FailedOperation.InvalidCertificateStatusCode The certificate status is incorrect.
    FailedOperation.InvalidParam Incorrect parameters.
    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.
    InternalError Internal error.
    InvalidParameter.RenewAlgorithmInvalid The algorithm is invalid.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy