API概览

更新时间: 2023-09-26 12:00:27
本产品(应用型负载均衡/2020-06-16)的OpenAPI采用RPC签名风格,签名细节参见签名机制说明我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(11370001915),在专家指导下进行签名对接。
在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

地域与可用区

API标题API概述
DescribeRegions查询地域查询可用地域。
DescribeZones查询可用区查询指定地域的可用区。

实例

API标题API概述
CreateLoadBalancer创建应用型负载均衡实例在指定地域创建应用型负载均衡实例。
GetLoadBalancerAttribute查询负载均衡实例的详细信息查询指定负载均衡实例的详细信息。
DeleteLoadBalancer删除负载均衡实例删除指定的负载均衡实例。
UpdateLoadBalancerAttribute更新负载均衡实例属性更新负载均衡实例属性,如名称、修改保护等。
UpdateLoadBalancerZones更新负载均衡可用区调用UpdateLoadBalancerZones修改应用型负载均衡实例可用区属性。
UpdateLoadBalancerEdition变更负载均衡版本变更当前负载均衡版本。
UpdateLoadBalancerAddressTypeConfig变更负载均衡实例的网络类型配置调用UpdateLoadBalancerAddressTypeConfig接口变更应用型负载均衡实例的网络类型。
ListLoadBalancers查询负载均衡查询指定地域的负载均衡,支持根据条件过滤。
DisableDeletionProtection关闭删除保护关闭指定负载均衡实例的删除保护。
EnableDeletionProtection开启删除保护开启指定资源的删除保护。

监听

API标题API概述
CreateListener创建监听在指定地域创建HTTP、HTTPS或QUIC监听。
GetListenerAttribute查询监听器的属性查询监听的详细信息。
DeleteListener删除监听删除指定的监听。
ListListeners查询监听查询指定地域的监听。
StartListener启动监听启动指定的监听。
StopListener停止监听停止指定的监听。
UpdateListenerAttribute更新监听的配置更新监听的配置,如名称、默认动作等。
UpdateListenerLogConfig更新监听日志相关属性更新监听日志相关属性,如访问日志等。
GetListenerHealthStatus查询健康检查查询监听及其转发规则的健康检查状态。

服务器组

API标题API概述
AddServersToServerGroup添加后端服务器向服务器组中添加后端服务器。
CreateServerGroup创建服务器组在指定地域创建服务器组。
DeleteServerGroup删除服务器组删除指定的服务器组。
UpdateServerGroupAttribute更新服务器组配置调用UpdateServerGroupAttribute接口更新服务器组的配置,例如健康检查、会话保持、名称、调度算法和协议等。
UpdateServerGroupServersAttribute更新后端服务器配置更新服务器组中后端服务器的权重和描述等配置。
ListServerGroups查询服务器组查询指定地域的服务器组。
ListServerGroupServers查询服务器查询服务器组中的服务器。
RemoveServersFromServerGroup移除后端服务器从服务器组中移除后端服务器。
ReplaceServersInServerGroup替换后端服务器组中的后端服务器调用ReplaceServersInServerGroup替换后端服务器组中的后端服务器。

转发规则

API标题API概述
CreateRule创建转发规则在指定监听下创建转发规则。
CreateRules创建规则创建多条转发规则。
DeleteRule删除转发规则删除指定的转发规则。
DeleteRules批量删除转发规则批量删除同一监听下的转发规则。
UpdateRuleAttribute更新转发规则属性更新转发规则属性,如条件、动作、名称等。
UpdateRulesAttribute更新规则属性调用UpdateRulesAttribute批量更新转发规则属性。
ListRules查询转发规则查询指定地域的转发规则。

监听器证书

API标题API概述
AssociateAdditionalCertificatesWithListener关联扩展证书和监听将扩展证书关联到监听。
DissociateAdditionalCertificatesFromListener解除关联监听和扩展证书将扩展证书从监听上解除关联。
ListListenerCertificates查询监听证书查询指定监听关联的证书,包含扩展证书和默认证书。

共享带宽包

API标题API概述
DetachCommonBandwidthPackageFromLoadBalancer从负载均衡器分离通用带宽包调用DetachCommonBandwidthPackageFromLoadBalancer接口将共享带宽包从负载均衡实例中移除。
AttachCommonBandwidthPackageToLoadBalancer附加通用带宽包到负载均衡器调用AttachCommonBandwidthPackageToLoadBalancer接口将共享带宽包绑定到应用型负载均衡实例上。

访问日志

API标题API概述
DisableLoadBalancerAccessLog关闭访问日志关闭指定负载均衡实例的访问日志。
EnableLoadBalancerAccessLog开启访问日志开启指定负载均衡实例的访问日志。

健康检查

API标题API概述
CreateHealthCheckTemplate创建健康检查模板在指定地域创建健康检查模板。
GetHealthCheckTemplateAttribute查询健康检查模板详细信息查询指定健康检查模板详细信息。
DeleteHealthCheckTemplates批量删除健康检查模板批量删除指定的健康检查模板。
UpdateHealthCheckTemplateAttribute更新健康检查模板的属性更新健康检查模板的属性,如名称、健康检查协议等。
ListHealthCheckTemplates查询健康检查模板查询指定地域的健康检查模板。
ApplyHealthCheckTemplateToServerGroup应用健康检查模版到服务组调用ApplyHealthCheckTemplateToServerGroup接口将健康检查配置模板应用到后端服务器组,从而将后端服务器组的健康检查配置修改为模板值。

安全策略

API标题API概述
CreateSecurityPolicy创建自定义安全策略在指定地域创建自定义安全策略。
DeleteSecurityPolicy删除安全策略删除指定的自定义安全策略。
UpdateSecurityPolicyAttribute更新安全策略属性更新安全策略属性,如安全协议版本、加密套件。
ListSecurityPolicies查询自定义安全策略查询指定地域的自定义安全策略。
ListSecurityPolicyRelations查询安全策略关联关系查询安全策略关联的监听列表。
ListSystemSecurityPolicies查询系统安全策略查询指定地域下的系统安全策略。

访问控制

API标题API概述
AddEntriesToAcl添加访问控制条目向访问控制策略组中添加IP条目。
CreateAcl创建访问控制在指定地域创建访问控制。
DeleteAcl删除访问控制删除指定的访问控制。
UpdateAclAttribute更新访问控制的属性更新访问控制的属性,如名称。
ListAcls查询访问控制列表查询某一个地域的访问控制列表。
ListAclEntries查询访问控制条目查询指定访问控制的条目。
AssociateAclsWithListener关联访问控制和监听将访问控制关联到监听。
ListAclRelations查询访问控制关联关系查询访问控制关联的监听。
DissociateAclsFromListener解关联监听和访问控制将访问控制从监听上解除关联。
RemoveEntriesFromAcl移除访问控制条目从访问控制中移除条目。

资源组

API标题API概述
MoveResourceGroup修改资源组修改云资源所属的资源组。

标签

API标题API概述
ListTagKeys查询标签键查询指定标签的键。
ListTagResources查询资源标签查询指定资源标签。
ListTagValues查询标签值查询指定标签的值。
TagResources给资源添加标签给指定资源添加标签。
UnTagResources删除资源的标签删除资源上配置的标签。

异步任务

API标题API概述
ListAsynJobs查询异步任务查询指定地域的异步任务。

可编程脚本

API标题API概述
UpdateAScripts更新可编程脚本调用UpdateAScripts接口更新可编程脚本。
CreateAScripts创建可编程脚本创建可编程脚本。
DeleteAScripts删除可编程脚本调用DeleteAScripts接口删除可编程脚本。
ListAScripts查询可编程脚本列表调用ListAScripts接口查询可编程脚本列表。
EnableLoadBalancerIpv6Internet开启负载均衡IPv6公网调用EnableLoadBalancerIpv6Internet接口将双栈应用型负载均衡实例的IPv6私网变更为IPv6公网。
DisableLoadBalancerIpv6Internet关闭负载均衡IPv6公网调用DisableLoadBalancerIpv6Internet接口将双栈应用型负载均衡实例的IPv6公网变更为IPv6私网。
阿里云首页 负载均衡 相关技术圈