Unbinding CVM from Forwarding Rules of Application Layer-7 Listener

Last updated: 2020-08-28 15:19:47

    API Description

    This API (DeregisterInstancesFromForwardLB) is used to disassociate one or more CVMs from the forwarding rules of application-based load balancer layer-7 listener.

    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. For more information, please see Common Request Parameters page. The Action field for this API is DeregisterInstancesFromForwardLB.

    Parameter Name Required Type Description
    loadBalancerId Yes String ID of load balancer instance. It can be queried by entering 1 or -1 in input parameter "forward" field through the API DescribeLoadBalancers.
    listenerId Yes String ID of application-based load balancer listener, which can be queried via the API DescribeForwardLBListeners.
    locationIds.n No String ID of specified forwarding rule. If this is not specified, the CVM will be unbound from the entire listener.
    domain No String Domain of forwarding rule of the listener to be bound.
    url No String Path of forwarding rule of the listener to be bound.
    backends.n.instanceId Yes String Unique ID of the CVM, which can be obtained from "unInstanceId" in the returned fields of API DescribeInstances.
    This API allows entering instance IDs of multiple CVMs at a time. For example, if you want to enter two CVMs, enter: backends.1.instanceId&backends.2.instanceId.
    backends.n.port Yes Int Listening port of backend CVM of load balancer listener. Value range: 1-65535. If this is not specified, all the ports of the CVM will be unbound.

    Response Parameters

    Parameter Name Type Description
    code Int Common error code. 0: Successful; other values: Failed. For more information, please see Common Error Codes on the Error Codes page.
    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. The operation status can be queried via the API DescribeLoadBalancersTaskResult.

    Example

    Request

    https://lb.api.qcloud.com/v2/index.php?Action=DeregisterInstancesFromForwardLB
    &<Common request parameters>
    &loadBalancerId=lb-abcdefgh
    &listenerId=lbl-abcdefgh
    &locationIds.0=loc-aaaadfa
    &backends.0.instanceId=ins-1234test
    &backends.0.port=80
    &backends.1.instanceId=ins-5678test
    &backends.1.port=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