Modify CLB Attributes

Last updated: 2019-11-29 18:54:34

    API Description

    This API (ModifyLoadBalancerAttributes) is used to modify basic configuration information of load balancer instances based on your input parameters.

    Domain name for API access: lb.api.qcloud.com

    Request Parameters

    The following request parameter list only provides the API request parameters. Common request parameters are required when the API is called. The Action field for this API is ModifyLoadBalancerAttributes.

    Parameter Name Required Type Description
    loadBalancerId Yes String Unique ID of the load balancer instance, which can be queried via the API DescribeLoadBalancers.
    loadBalancerName No String Name of the load balancer instance, which can contain 1-50 characters, including letters, numbers, "-" or "_".
    domainPrefix No String Domain prefix. The domain name of a load balancer instance consists of the domain prefix entered by a user and the domain suffix in the configuration file to ensure the uniqueness.
    The prefix should be a combination of 1-20 characters comprised of lowercase letters, numbers or "-".
    This field is not applicable to private network-based load balancer instances.

    Response Parameters

    Parameter Name Type Description
    code Int Common error code; 0: Successful; other values: Failed.
    message String Module error message description depending on API.
    codeDesc String Error code. For a successful operation, "Success" is returned. For a failed operation, a message describing the failure is returned.
    requestId Int Request task ID.

    Example

    Request

    https://lb.api.qcloud.com/v2/index.php?Action=ModifyLoadBalancerAttributes
    &<Common request parameters>
    &loadBalancerId=lb-abcdefgh
    &loadBalancerName=my-lb-name
    

    Response

    {
        "code" : 0,
        "message" : "",
        "codeDesc": "Success",
        "requestId" : 1234
    }

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help