tencent cloud

Feedback

UploadConfirmLetter

Last updated: 2023-12-01 16:21:29

    1. API Description

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

    This API is used to upload the confirmation letter for a certificate.

    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 Name Required Type Description
    Action Yes String Common Params. The value used for this API: UploadConfirmLetter.
    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
    ConfirmLetter Yes String Base64-encoded confirmation letter file, which must be a JPG, JPEG, PNG, or PDF file of 1 KB to 1.4 MB

    3. Output Parameters

    Parameter Name Type Description
    CertificateId String Certificate ID
    IsSuccess Boolean Whether the operation is successful
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Uploading the confirmation letter for a certificate

    Input Example

    POST / HTTP/1.1
    Host: ssl.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: UploadConfirmLetter
    <Common request parameters>
    
    {
        "CertificateId": "flSFd6Fh",
        "ConfirmLetter": "UEsDBBQABgAIAAAAIQCM19MmCg......"
    }
    

    Output Example

    {
        "Response": {
            "RequestId": "15dc3823-4089-4fd6-81a6-ec8baf5ec330",
            "CertificateId": "flSFd6Fh",
            "IsSuccess": true
        }
    }
    

    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.CertificateInvalid The certificate is invalid.
    FailedOperation.CertificateNotFound The certificate does not exist.
    FailedOperation.ConfirmLetterTooLarge The confirmation letter file cannot exceed 1.4 MB.
    FailedOperation.ConfirmLetterTooSmall The confirmation letter file cannot be smaller than 1 KB.
    FailedOperation.InvalidCertificateSource Certificate source error.
    FailedOperation.InvalidCertificateStatusCode The certificate status is incorrect.
    FailedOperation.InvalidConfirmLetterFormat The format of the confirmation letter file is invalid (JPG, JPEG, PNG, and PDF are supported).
    FailedOperation.InvalidConfirmLetterFormatWosign The format of the confirmation letter file is invalid (JPG, PDF, and GIF are supported).
    FailedOperation.NetworkError The CA system is busy. Try again later.
    InternalError Internal error.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support