API Category

Last updated: 2020-08-03 17:58:12

    General APIs

    API Name Description
    DescribeLoadBalancersTaskResult Queries the result of executing an asynchronous CLB API.
    CreateLoadBalancer Purchases a CLB instance.
    InquiryLBPriceAll Queries the prices of CLB instances.
    DescribeLoadBalancers Queries the list of CLB instances.
    DeleteLoadBalancers Deletes a CLB instance.
    GetMonitorData Queries the monitoring data of the CLB instance.
    ReplaceCert Replaces the certificate of the CLB instance.
    GetCertListWithLoadBalancer Queries the information of the CLB instance associated with the certificate.
    DescribeLoadBalancerLog Queries the CLB Layer-7 log in COS.
    CloneLB Clones a CLB instance.

    Classic CLB APIs

    Instance APIs

    API Name Description
    ModifyLoadBalancerAttributes Modifies the attributes of the specified CLB instance, including the CLB instance name.

    Listener APIs

    API Name Description
    CreateLoadBalancerListeners Creates a CLB listener for the specified CLB instance. A CLB listener provides the protocols for the requests to be forwarded, as well as ports and health check policies.
    DescribeLoadBalancerListeners Returns the list of listeners for the specified CLB instances, including unique ID, name, port health check policy and other information of listeners.
    DeleteLoadBalancerListeners Deletes a set of listeners for the specified CLB instance.
    ModifyLoadBalancerListener Modifies the attributes of the listener for the CLB instance, including the name, health check policy and other information of the listener.

    Real server APIs

    API Name Description
    RegisterInstancesWithLoadBalancer Binds a set of specified CVMs to the specified CLB instance.
    DescribeLoadBalancerBackends Obtains the list of CVMs bound to the CLB instance identified by LoadBalanceId.
    ModifyLoadBalancerBackends Modifies the weight of a set of CVMs bound to the CLB instance.
    DeregisterInstancesFromLoadBalancer Unbinds CVMs from the CLB instance.

    Health check APIs

    API Name Description
    DescribeLBHealthStatus Queries the health status of a CLB instance.

    CLB APIs

    Note:

    The following CLB APIs have been updated to version 3.0, which is more standardized with significantly reduced access latency. The legacy APIs will be deprecated and is currently not displayed on the left sidebar. We recommend using CLB API 3.0.

    CLB instance APIs

    API Name Description
    ModifyForwardLBName Modifies the name of a CLB instance.

    Listener APIs

    API Name Description
    DescribeForwardLBListeners Queries the CLB listener.
    CreateForwardLBSeventhLayerListeners Creates a Layer-7 listener.
    CreateForwardLBFourthLayerListeners Creates a Layer-4 listener.
    ModifyForwardLBFourthListener Modifies the attributes of the CLB Layer-4 listener.
    ModifyForwardLBSeventhListener Modifies the attributes of the CLB Layer-7 listener.
    DeleteForwardLBListener Deletes a CLB listener.

    Forwarding rule APIs

    API Name Description
    CreateForwardLBListenerRules Creates forwarding rules of the CLB Layer-7 listener.
    ModifyForwardLBRulesDomain Modifies the domain name under the CLB Layer-7 listener.
    ModifyLoadBalancerRulesProbe Modifies the health check and forwarding path for the forwarding rules of the CLB Layer-7 listener.
    DeleteForwardLBListenerRules Deletes the forwarding rules of the CLB Layer-7 listener.

    CVM APIs

    API Name Description
    DescribeForwardLBBackends Queries the list of CVMs bound to the CLB instance.
    RegisterInstancesWithForwardLBFourthListener Binds a CVM to the forwarding rules of the CLB Layer-4 listener.
    RegisterInstancesWithForwardLBSeventhListener Binds a CVM to the forwarding rules of the CLB Layer-7 listener.
    ModifyForwardFourthBackendsWeight Modifies the weight of a CVM bound to the Layer-4 listener.
    ModifyForwardSeventhBackends Modifies the weight of a CVM bound to the Layer-7 listener.
    ModifyForwardFourthBackendsPort Modifies the port of a CVM bound to the Layer-4 listener.
    ModifyForwardSeventhBackendsPort Modifies the port of a CVM bound to the Layer-7 listener.
    DeregisterInstancesFromForwardLBFourthListener Unbinds a CVM from the CLB Layer-4 listener.
    DeregisterInstancesFromForwardLB Unbinds a CVM from the forwarding rules of the CLB Layer-7 listener.

    Health check APIs

    API Name Description
    [DescribeForwardLBHealthStatus] Queries the health check of a CLB instance.

    Redirection APIs

    API Name Description
    DescribeRewrite Queries the redirection relationship of the CLB instance.
    DeleteRewrite Deletes the redirection relationship of the CLB instance.
    ManualRewrite Adds the redirection relationship to a CLB instance manually.
    AutoRewrite Generates the redirection relationship for a CLB instance automatically.

    Was this page helpful?

    Was this page helpful?

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