tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

ModifyLoadBalancerAttributes

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

    1. API Description

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

    This API is used to modify the attributes of a CLB instance, such as name and cross-region attributes.

    Note: For CLB instances of bill-by-CVM users, cross-region attributes can be set only after a bandwidth package is purchased.This is an asynchronous API. After it returns a result successfully, the obtained RequestID should be used as an input parameter to call the DescribeTaskStatus API, for checking whether this task succeeds.

    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: ModifyLoadBalancerAttributes.
    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.
    LoadBalancerId Yes String Unique CLB ID
    LoadBalancerName No String CLB instance name
    TargetRegionInfo No TargetRegionInfo The backend service information of cross-region binding 1.0
    InternetChargeInfo No InternetAccessible Network billing parameter
    LoadBalancerPassToTarget No Boolean Whether the target opens traffic from CLB to the internet. If yes (true), only security groups on CLB will be verified; if no (false), security groups on both CLB and backend instance need to be verified.
    SnatPro No Boolean Whether to enable cross-region binding 2.0
    DeleteProtect No Boolean Specifies whether to enable deletion protection.
    ModifyClassicDomain No Boolean Modifies the second-level domain name of CLB from mycloud.com to tencentclb.com. Note that the sub-domain names will be changed as well. After the modification, mycloud.com will be invalidated.

    3. Output Parameters

    Parameter Name Type Description
    DealName String This parameter can be used to query whether CLB billing mode switch is successful.
    Note: this field may return null, indicating that no valid values can be obtained.
    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 Renaming a CLB instance

    Modifies a CLB instance.

    Input Example

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

{
    "LoadBalancerName": "newlbname",
    "LoadBalancerId": "lb-6efswuxa"
}

    Output Example

    {
    "Response": {
        "DealName": null,
        "RequestId": "78a40898-8210-44c7-8bc6-f83e50878d12"
    }
}

    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.ResourceInOperating The specified resource is currently being operated. Please try again later.
    InternalError Internal error.
    InvalidParameter Parameter error.
    InvalidParameter.FormatError Wrong parameter format.
    InvalidParameter.LBIdNotFound Wrong CLB instance ID.
    InvalidParameter.RegionNotFound Invalid region.
    InvalidParameterValue Incorrect parameter value.
    InvalidParameterValue.Duplicate Duplicate parameter value.
    InvalidParameterValue.Length Wrong parameter length.
    LimitExceeded Quota exceeded.
    MissingParameter Missing parameter.
    ResourceInsufficient Insufficient resources.
    UnauthorizedOperation Unauthorized operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy