Modifying the Port of CVM on Forwarding Rules of Application Layer-4 Listener

Last updated: 2020-08-17 15:22:08

    API Description

    This API (ModifyForwardFourthBackendsPort) is used to modify the weight of CVMs bound to the load balancer instance. You can adjust request forwarding rules by modifying weight of CVMs. For more information on weight configuration, please see Weight Configuration.

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

    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 load balancer listener, which can be queried via the API DescribeForwardLBListeners.
    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 Original listening port of backend CVM of load balancer listener. Value range: 1-65535.
    backends.n.newPort Yes Int New listening port of backend CVM of load balancer listener. Value range: 1-65535.
    backends.n.weight No Int Weight of CVM. Value range is 0-100. Default is 10.

    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=ModifyForwardFourthBackendsPort
    &<Common request parameters>
    &loadBalancerId=lb-abcdefgh
    &backends.0.instanceId=ins-6789test
    &backends.0.weight=10
    &backends.1.instanceId=ins-1234test
    &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