API Category

Last updated: 2020-10-26 16:20:35

    General APIs

    API Name Action Feature
    DescribeLoadBalancersTaskResult DescribeLoadBalancersTaskResult Queries the execution result of an async CLB API.
    CreateLoadBalancer CreateLoadBalancer Purchases a CLB instance.
    InquiryLBPriceAll InquiryLBPriceAll Queries the price of CLB instances.
    DescribeLoadBalancers DescribeLoadBalancers Queries the list of CLB instances.
    DeleteLoadBalancers DeleteLoadBalancers Deletes a CLB instance.
    GetMonitorData GetMonitorData Queries monitoring data of CLB instances.
    ReplaceCert ReplaceCert Changes the certificate of CLB instances.
    GetCertListWithLoadBalancer GetCertListWithLoadBalancer Queries CLB instances associated with the certificate.
    CloneLB CloneLB Clones a CLB instance.

    Classic CLB APIs

    Instance APIs

    API Name Action Feature
    ModifyLoadBalancerAttributes ModifyLoadBalancerAttributes Modifies the attributes of a specified CLB instance, including the CLB instance name.

    Listener APIs

    API Name Action Feature
    CreateLoadBalancerListeners CreateLoadBalancerListeners Creates a CLB listener for the specified CLB instance. A CLB listener provides request forwarding protocols, ports, and health check policies.
    DescribeLoadBalancerListeners DescribeLoadBalancerListeners Obtains the list of listeners for the specified CLB instance, including unique ID, name, port, and health check policy.
    DeleteLoadBalancerListeners DeleteLoadBalancerListeners Deletes listeners for the specified CLB instance.
    ModifyLoadBalancerListener ModifyLoadBalancerListener Modifies the attributes of a CLB listener, including the listener name and health check policy.

    Real server APIs

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

    Health check APIs

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

    Cloud Load Balancer APIs

    Note:

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

    CLB instance APIs

    API Name Action Feature
    ModifyForwardLBName ModifyForwardLBName Modifies the name of a CLB instance.

    Listener APIs

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

    |### Forwarding rule APIs

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

    CVM APIs

    API Name Action ID Feature
    DescribeForwardLBBackends DescribeForwardLBBackends Obtains the list of CVMs bound to a CLB instance.
    RegisterInstancesWithForwardLBFourthListener RegisterInstancesWithForwardLBFourthListener Binds CVMs to the forwarding rules of a CLB Layer-4 listener.
    RegisterInstancesWithForwardLBSeventhListener RegisterInstancesWithForwardLBSeventhListener Binds CVMs to the forwarding rules of a CLB Layer-7 listener.
    ModifyForwardFourthBackendsWeight ModifyForwardFourthBackendsWeight Modifies the weight of CVMs bound to a Layer-4 listener.
    ModifyForwardSeventhBackends ModifyForwardSeventhBackends Modifies the weight of CVMs bound to a Layer-7 listener.
    ModifyForwardFourthBackendsPort ModifyForwardFourthBackendsPort Modifies ports of CVMs bound to a Layer-4 listener.
    ModifyForwardSeventhBackendsPort ModifyForwardSeventhBackendsPort Modifies ports of CVMs bound to a Layer-7 listener.
    DeregisterInstancesFromForwardLBFourthListener DeregisterInstancesFromForwardLBFourthListener Unbinds CVMs from the forwarding rules of a CLB Layer-4 listener.
    DeregisterInstancesFromForwardLB DeregisterInstancesFromForwardLB Unbinds CVMs from the forwarding rules of a CLB Layer-7 listener.

    Health check APIs

    API Name Action ID Feature
    DescribeForwardLBHealthStatus DescribeForwardLBHealthStatus Describes the health check of a CLB instance.

    Redirection APIs

    API Name Action ID Feature
    DescribeRewrite DescribeRewrite Queries the redirection relationship of a CLB instance.
    DeleteRewrite DeleteRewrite Deletes the redirection relationship of a CLB instance.
    ManualRewrite ManualRewrite Adds the redirection relationship to a CLB instance manually.
    AutoRewrite 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