操作指南

API 文档

诚邀爱技术、爱分享的你,成为文档内容共建者> HOT
文档中心 > 负载均衡 > API 文档 > 负载均衡 API2.0 切换 API3.0 指引

负载均衡 API 已全面升级至3.0版本,基于2.0版本接口访问时延较高和使用复杂的考虑,原负载均衡 API2.0 接口服务将不再提供技术支持,并于北京时间2022年11月30日起下线。如果您的业务还在使用负载均衡 API2.0 相关接口,建议尽快将服务升级至 API3.0 接口,以免对您的业务造成影响。

  • 【推荐】当前负载均衡 API2.0 的接口大多为传统型负载均衡使用的接口,您可选择将“传统型负载均衡”升级为“负载均衡”类型,升级后资费不变,VIP 不变,可覆盖传统型负载均衡的所有功能,且能提供更多功能和更好的用户体验。升级后支持直接调用 API3.0 接口。传统型负载均衡升级详情请参见 传统型负载均衡升级公告
  • 若您暂未从“传统型负载均衡”升级为“负载均衡”类型,则可选择将 API2.0 接口切换为 API3.0。您可参照下方的 API2.0 切换3.0接口列表 找到需切换的新接口,完成升级。

API2.0 切换3.0接口列表

通用接口

API2.0 接口 API3.0 接口 备注
DescribeLoadBalancersTaskResult
(查询负载均衡异步接口的执行结果)
DescribeTaskStatus
(查询异步任务状态)
支持切换,切换后该接口可按 API3.0 的调用方式进行调用,不存在鉴权问题。
CreateLoadBalancer
(购买负载均衡实例)
CreateLoadBalancer
(购买负载均衡实例)
InquiryLBPriceAll
(查询负载均衡实例价格)
/ 原有 API 对应的价格查询功能已不再推荐使用。
DescribeLoadBalancers
(查询负载均衡实例列表)
DescribeLoadBalancers
(查询负载均衡实例列表)
支持切换,切换后该接口可按 API3.0 的调用方式进行调用,不存在鉴权问题。
DeleteLoadBalancers
(删除负载均衡实例)
DeleteLoadBalancer
(删除负载均衡实例)
GetMonitorData
(负载均衡监控接口)
GetMonitorData
(拉取指标监控数据)
此接口为云监控 API 接口,切换至 API3.0 接口的方式请参见 接口迁移说明
ReplaceCert
(更换 HTTPS 类型负载均衡证书)
ReplaceCertForLoadBalancers
(替换负载均衡实例所关联的证书)
支持切换,切换后该接口可按 API3.0 的调用方式进行调用,不存在鉴权问题。
GetCertListWithLoadBalancer
(查询证书关联的负载均衡监听器)
DescribeLoadBalancerListByCertId
(根据证书ID查询负载均衡)
CloneLB
(克隆负载均衡)
CloneLoadBalancer
(克隆负载均衡实例)
该接口 API3.0 无法沿用 API2.0 的 CAM 权限,调用时可能会出现鉴权失败问题。建议您将“传统型负载均衡”升级为“负载均衡”类型,升级后支持直接调用 API3.0 接口,升级详情请参见 传统型负载均衡升级公告

传统型负载均衡接口

实例相关接口

API2.0 接口 API3.0 接口 备注
ModifyLoadBalancerAttributes
(修改负载均衡属性信息)
ModifyLoadBalancerAttributes
(修改负载均衡实例的属性)
支持切换,切换后该接口可按 API3.0 的调用方式进行调用。
注意

该接口 API2.0 仅支持修改实例名称,对应仅修改实例名称的 CAM 权限。该接口 API3.0 支持修改实例名称、调整网络计费模式、修改绑定的后端服务的地域信息等,对应这些功能的 CAM 权限。切换后,会存在 CAM 权限策略比切换前多的情况。

监听器相关接口

API2.0 接口 API3.0 接口 备注
DescribeLoadBalancerListeners
(获取负载均衡监听器列表)
DescribeClassicalLBListeners
(获取传统型负载均衡监听器列表)
支持切换,切换后该接口可按 API3.0 的调用方式进行调用,不存在鉴权问题。
CreateLoadBalancerListeners
(创建负载均衡监听器)
CreateListener
(创建负载均衡监听器)
该接口 API3.0 无法沿用 API2.0 的 CAM 权限,调用时可能会出现鉴权失败问题。建议您将“传统型负载均衡”升级为“负载均衡”类型,升级后支持直接调用 API3.0 接口,升级详情请参见 传统型负载均衡升级公告
DeleteLoadBalancerListeners
(删除负载均衡监听器)
DeleteListener
(删除负载均衡监听器)
ModifyLoadBalancerListener
(修改负载均衡监听器属性)
ModifyListener
(修改负载均衡监听器属性)

后端服务器相关接口

API2.0 接口 API3.0 接口 备注
RegisterInstancesWithLoadBalancer
(绑定后端服务器到负载均衡)
RegisterTargetsWithClassicalLB
(绑定后端服务到传统型负载均衡)
支持切换,切换后该接口可按 API3.0 的调用方式进行调用,不存在鉴权问题。
DescribeLoadBalancerBackends
(获取负载均衡绑定的后端服务器列表)
DescribeClassicalLBTargets
(获取传统型负载均衡绑定的后端服务器列表)
DeregisterInstancesFromLoadBalancer
(解绑后端服务器)
DeregisterTargetsFromClassicalLB
(解绑传统型负载均衡的后端服务器)
ModifyLoadBalancerBackends
(修改负载均衡后端服务器权重)
ModifyTargetWeight
(修改监听器绑定的后端机器的转发权重)
该接口 API3.0 无法沿用 API2.0 的 CAM 权限,调用时可能会出现鉴权失败问题。建议您将“传统型负载均衡”升级为“负载均衡”类型,升级后支持直接调用 API3.0 接口,升级详情请参见 传统型负载均衡升级公告

其他相关接口

API2.0 接口 API3.0 接口 备注
DescribeLBHealthStatus
(查询负载均衡健康检查状态)
DescribeClassicalLBHealthStatus
(获取传统型负载均衡后端的健康状态)
支持切换,切换后该接口可按 API3.0 的调用方式进行调用,不存在鉴权问题。

负载均衡接口

负载均衡实例相关接口

API2.0 接口 API3.0 接口 备注
ModifyForwardLBName
(修改负载均衡名字)
ModifyLoadBalancerAttributes
(修改负载均衡实例的属性)
支持切换,切换后该接口可按 API3.0 的调用方式进行调用,不存在鉴权问题。

监听器相关接口

API2.0 接口 API3.0 接口 备注
CreateForwardLBFourthLayerListeners
(创建四层负载均衡监听器)
CreateListener
(创建负载均衡监听器)
支持切换,切换后该接口可按 API3.0 的调用方式进行调用,不存在鉴权问题。
CreateForwardLBSeventhLayerListeners
(创建七层负载均衡监听器)
CreateListener
(创建负载均衡监听器)
CreateForwardLBListenerRules
(创建负载均衡监听器转发规则)
CreateRule
(创建负载均衡七层监听器转发规则 )
DeleteForwardLBListener
(删除负载均衡监听器)
DeleteListener
(删除负载均衡监听器)
DeleteForwardLBListenerRules
(删除七层负载均衡监听器规则)
DeleteRule
(删除负载均衡七层监听器的转发规则)
DescribeForwardLBListeners
(查询负载均衡监听器列表)
DescribeListeners
(查询负载均衡的监听器列表)
ModifyForwardLBFourthListener
(修改负载均衡四层监听器属性)
ModifyLoadBalancerListener
(修改负载均衡监听器属性)
ModifyForwardLBSeventhListener
(修改负载均衡七层监听器属性)
ModifyLoadBalancerListener
(修改负载均衡监听器属性)
ModifyForwardLBRulesDomain
(修改负载均衡监听器转发规则的域名)
ModifyDomain
(修改七层转发规则的域名)
ModifyLoadBalancerRulesProbe
(修改负载均衡监听器转发规则的健康检查及转发路径)
ModifyRule
(修改负载均衡七层监听器的转发规则)

后端服务相关接口

API2.0 接口 API3.0 接口 备注
DeregisterInstancesFromForwardLBFourthListener
(解绑负载均衡四层监听器转发规则上的云服务器)
DeregisterTargets
(从负载均衡监听器上解绑后端服务)
支持切换,切换后该接口可按 API3.0 的调用方式进行调用,不存在鉴权问题。
DeregisterInstancesFromForwardLB
(解绑负载均衡七层监听器转发规则上的云服务器)
DeregisterTargets
(从负载均衡监听器上解绑后端服务)
DescribeForwardLBBackends
(查询负载均衡云服务器列表)
DescribeTargets
(查询负载均衡绑定的后端服务列表)
RegisterInstancesWithForwardLBFourthListener
(绑定云服务器到负载均衡四层监听器的转发规则上)
RegisterTargets
(绑定后端机器到监听器上)
RegisterInstancesWithForwardLBSeventhListener
(绑定云服务器到负载均衡七层监听器的转发规则上)
RegisterTargets
(绑定后端机器到监听器上)
ModifyForwardFourthBackendsPort
(修改四层监听器转发规则上云服务器的端口)
ModifyTargetPort
(修改监听器绑定的后端机器的端口)
ModifyForwardFourthBackendsWeight
(修改四层监听器转发规则上云服务器的权重)
ModifyTargetWeight
(修改监听器绑定的后端机器的转发权重)
ModifyForwardSeventhBackends
(修改七层监听器转发规则上云服务器的权重)
ModifyTargetWeight
(修改监听器绑定的后端机器的转发权重)
ModifyForwardSeventhBackendsPort
(修改七层监听器转发规则上云服务器的端口)
ModifyTargetPort
(修改监听器绑定的后端机器的端口)

健康检查相关接口

API2.0 接口 API3.0 接口 备注
DescribeForwardLBHealthStatus
(查询负载均衡健康检查状态)
DescribeTargetHealth
(获取负载均衡后端服务的健康检查状态)
支持切换,切换后该接口可按 API3.0 的调用方式进行调用,不存在鉴权问题。

重定向相关接口

API2.0 接口 API3.0 接口 备注
AutoRewrite
(自动重定向配置)
AutoRewrite
(自动生成负载均衡转发规则的重定向关系)
支持切换,切换后该接口可按 API3.0 的调用方式进行调用,不存在鉴权问题。
DescribeRewrite
(查询监听器规则的重定向关系)
DescribeRewrite
(查询负载均衡转发规则的重定向关系)
DeleteRewrite
(删除重定向配置)
DeleteRewrite
(删除负载均衡转发规则之间的重定向关系)
ManualRewrite
(手动重定向配置)
ManualRewrite
(手动添加负载均衡转发规则的重定向关系)
目录