tencent cloud

文档反馈

ModifyLoadBalancerAttributes

最后更新时间:2024-12-19 15:06:04

    API Description

    This API is used to modify basic configuration information of CLB instances based on your input parameters.
    Domain name for API calls: lb.api.qcloud.com

    Request Parameters

    The list below contains only the API request parameters. Common parameters should be added when you call the API. For more information, see Common Request Parameters. The Action field for this API is ModifyLoadBalancerAttributes.
    Parameter
    Required
    Type
    Description
    loadBalancerId
    Yes
    String
    Unique ID of the CLB instance, which can be queried via the DescribeLoadBalancers API.
    loadBalancerName
    No
    String
    Name of the CLB instance, which can contain 1-50 characters, including letters, Chinese, numbers, hyphen (-) or underscore (_).
    domainPrefix
    No
    String
    Domain name prefix. The domain name of a CLB instance consists of the user-defined domain name prefix and the domain suffix in the configuration file to ensure the uniqueness.Rule: 1-20 characters including lowercase letters, numbers, or hyphen (-). This field cannot be specified for private network CLB instances.

    Response Parameters

    Parameter
    Type
    Description
    code
    Int
    Common error code. 0: success; other values: failure. For more information, see Common Error Codes.
    message
    String
    API-related module error message description.
    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. The API provides an asynchronous task. You can use this parameter to query the execution result of the task via the DescribeLoadBalancersTaskResult API.

    Example

    Request
    https://lb.api.qcloud.com/v2/index.php?Action=ModifyLoadBalancerAttributes
    &loadBalancerId=lb-abcdefgh
    &loadBalancerName=my-lb-name
    Response
    {
    "code" : 0,
    "message" : "",
    "codeDesc": "Success",
    "requestId" : 1234
    }