API 文档

负载均衡 API 概览

最近更新时间:2020-09-17 19:23:00

通用接口

接口名 Action 功能描述
查询负载均衡异步接口的执行结果 DescribeLoadBalancersTaskResult 查询负载均衡异步操作接口的执行结果。
购买负载均衡 CreateLoadBalancer 通过该接口来购买负载均衡。
查询负载均衡实例价格 InquiryLBPriceAll 查询负载均衡实例的价格。
查询负载均衡实例列表 DescribeLoadBalancers 查询负载均衡实例的列表。
删除负载均衡实例 DeleteLoadBalancers 删除负载均衡实例。
负载均衡监控接口 GetMonitorData 查询负载均衡的监控数据。
更换 HTTPS 类型负载均衡证书 ReplaceCert 更换负载均衡使用的证书。
查询证书关联的负载均衡监听器 GetCertListWithLoadBalancer 查询证书关联的负载均衡信息。
克隆负载均衡 CloneLB 克隆负载均衡。

传统型负载均衡相关接口

实例相关接口

接口名 Action 功能描述
修改负载均衡属性信息 ModifyLoadBalancerAttributes 修改用户指定的负载均衡实例的属性信息,包括负载均衡实例的名字等。

监听器相关接口

接口名 Action 功能描述
创建负载均衡监听器 CreateLoadBalancerListeners 为用户指定的负载均衡实例创建负载均衡监听器。负载均衡监听器包含了客户要转发请求的协议,端口以及健康检查的策略。
获取负载均衡监听器列表 DescribeLoadBalancerListeners 返回用户指定的负载均衡实例的监听器列表。包含监听器的唯一 ID,名字,端口健康检查策略等信息。
删除负载均衡监听器 DeleteLoadBalancerListeners 删除用户指定的负载均衡实例的一组监听器。
修改负载均衡监听器属性 ModifyLoadBalancerListener 修改负载均衡实例的监听器的属性信息,包括监听器的名字,健康检查策略等信息。

后端服务器相关接口

接口名 Action 功能描述
绑定后端服务器到负载均衡 RegisterInstancesWithLoadBalancer 将用户指定的一组云服务器关联到用户指定的负载均衡实例上。
获取负载均衡绑定的后端服务器列表 DescribeLoadBalancerBackends 获取用户输入的 LoadBalanceId 这个负载均衡实例上关联的云服务器列表。
修改负载均衡后端服务器权重 ModifyLoadBalancerBackends 修改关联到负载均衡实例的一组云服务器的权重。
解绑后端服务器 DeregisterInstancesFromLoadBalancer 将关联到负载均衡实例的云服务器进行解绑操作。

健康检查相关接口

接口名 Action 功能描述
查询负载均衡健康检查状态 DescribeLBHealthStatus 查询负载均衡实例健康状态。

负载均衡相关接口

说明:

如下负载均衡相关接口已升级到 3.0 版本,旧版 API 接口未来可能停止维护,目前不展示在左侧导航。负载均衡 API 3.0 版本接口定义更加规范,访问时延下降显著,建议使用 负载均衡 API 3.0

负载均衡实例相关接口

接口名 Action 功能描述
修改负载均衡名字 ModifyForwardLBName 修改负载均衡的名称。

监听器相关接口

接口名 Action ID 功能描述
查询负载均衡监听器列表 DescribeForwardLBListeners 查询负载均衡监听器。
创建七层负载均衡监听器 CreateForwardLBSeventhLayerListeners 创建七层监听器。
创建四层负载均衡监听器 CreateForwardLBFourthLayerListeners 创建四层监听器。
修改负载均衡四层监听器属性 ModifyForwardLBFourthListener 修改负载均衡四层监听器属性。
修改负载均衡七层监听器属性 ModifyForwardLBSeventhListener 修改负载均衡七层监听器属性。
删除负载均衡监听器 DeleteForwardLBListener 删除负载均衡监听器。

转发规则相关接口

接口名 Action ID 功能描述
创建负载均衡监听器转发规则 CreateForwardLBListenerRules 创建负载均衡七层监听器转发规则的能力。
修改负载均衡监听器转发规则的域名 ModifyForwardLBRulesDomain 修改负载均衡七层监听器下的域名。
修改负载均衡监听器转发规则的健康检查及转发路径 ModifyLoadBalancerRulesProbe 修改负载均衡七层监听器转发规则的健康检查及转发路径。
删除七层负载均衡监听器规则 DeleteForwardLBListenerRules 删除负载均衡实例七层监听器的转发规则。

云服务器相关接口

接口名 Action ID 功能描述
查询负载均衡云服务器列表 DescribeForwardLBBackends 查询负载均后端绑定的云服务器列表。
绑定云服务器到负载均衡四层监听器的转发规则上 RegisterInstancesWithForwardLBFourthListener 绑定云服务器到负载均衡四层监听器的转发规则上。
绑定云服务器到负载均衡七层监听器的转发规则上 RegisterInstancesWithForwardLBSeventhListener 绑定云服务器到负载均衡七层监听器的转发规则上。
修改四层监听器转发规则上云服务器的权重 ModifyForwardFourthBackendsWeight 修改绑定到四层监听器的云服务器的权重。
修改七层监听器转发规则上云服务器的权重 ModifyForwardSeventhBackends 修改绑定到七层监听器的云服务器的权重。
修改四层监听器转发规则上云服务器的端口 ModifyForwardFourthBackendsPort 修改绑定到四层监听器的云服务器的端口。
修改七层监听器转发规则上云服务器的端口 ModifyForwardSeventhBackendsPort 修改绑定到七层监听器的云服务器的端口。
解绑负载均衡四层监听器转发规则上的云服务器 DeregisterInstancesFromForwardLBFourthListener 解绑负载均衡四层监听器转发规则上的云服务器。
解绑负载均衡七层监听器转发规则上的云服务器 DeregisterInstancesFromForwardLB 解绑负载均衡七层监听器转发规则上的云服务器。

健康检查相关接口

接口名 Action ID 功能描述
查询负载均衡健康检查状态 DescribeForwardLBHealthStatus 查询负载均衡实例的健康检查。

重定向相关接口

接口名 Action ID 功能描述
查询监听器规则的重定向关系 DescribeRewrite 查询负载均衡的重定向关系。
删除重定向配置 DeleteRewrite 删除负载均衡的重定向关系。
手动重定向配置 ManualRewrite 手动添加负载均衡的重定向关系。
自动重定向配置 AutoRewrite 自动生成负载均衡的重定向关系。
目录