tencent cloud

Feedback

ReplaceCertForLoadBalancers

Last updated: 2024-09-05 19:28:19

    1. API Description

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

    This API (ReplaceCertForLoadBalancers) is used to replace the certificate associated with a CLB instance. A new certificates can be associated with a CLB only after the original certificate is disassociated from it.
    This API supports replacing server certificates and client certificates.
    The new certificate to be used can be specified by passing in the certificate ID. If no certificate ID is specified, relevant information such as certificate content must be passed in to create a new certificate and bind it to the CLB.
    Note: This API can only be called in the Guangzhou region; for other regions, an error will occur due to domain name resolution problems.

    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: ReplaceCertForLoadBalancers.
    Version Yes String Common Params. The value used for this API: 2018-03-17.
    Region No String Common Params. This parameter is not required for this API.
    OldCertificateId Yes String ID of the certificate to be replaced, which can be a server certificate or a client certificate.
    Certificate Yes CertificateInput Information such as the content of the new certificate

    3. Output Parameters

    Parameter Name Type Description
    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 Replacing the server certificate associated with a CLB instance

    This example shows you how to replace a server certificate by specifying a new certificate ID.

    Input Example

    https://clb.tencentcloudapi.com/?Action=ReplaceCertForLoadBalancers
    &OldCertificateId=cuxw0123
    &Certificate.CertId=cuxw4567
    &<Common request parameters>
    

    Output Example

    {
        "Response": {
            "RequestId": "00ca7fca-90f1-47fe-a724-5d7e96d04633"
        }
    }
    

    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.
    InternalError Internal error.
    InvalidParameter Parameter error.
    InvalidParameter.FormatError Wrong parameter format.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.Length Wrong parameter length.