RegisterInstancesWithLoadBalancer

Last updated: 2020-08-04 14:40:07

    API Description

    This API is used to bind one or more CVMs to a CLB instance.

    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 RegisterInstancesWithLoadBalancer.

    Parameter Required Type Description
    loadBalancerId Yes String CLB instance ID, which can be queried via the DescribeLoadBalancers API.
    backends.n.instanceId Yes String Unique ID of the CVM, which can be obtained from the “unInstanceId” field in the response of the DescribeInstances API.
    This API supports entering multiple CVM instance IDs at a time. For example, if you want to specify two CVMs, enter backends.0.instanceId&backends.1.instanceId.
    backends.n.weight No Int Weight of the CVM. Value range: 0-100. Default value: 10.

    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 operation result via the DescribeLoadBalancersTaskResult API.

    Example

    Request

    https://lb.api.qcloud.com/v2/index.php?Action=RegisterInstancesWithLoadBalancer
    &<Common request parameters>
    &loadBalancerId=lb-abcdefgh
    &backends.0.instanceId=ins-1234test
    &backends.0.weight=10
    &backends.1.instanceId=ins-5678test
    &backends.1.weight=6
    

    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