文档

API概览

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

地域与可用区

API标题API概述
DescribeRegions查询地域查询NLB的可用地域。
DescribeZones查询可用区查询NLB一个地域下的可用区列表。

实例

API标题API概述
CreateLoadBalancer创建网络型负载均衡实例创建网络型负载均衡实例。
DeleteLoadBalancer删除负载均衡实例删除网络型负载均衡实例。
UpdateLoadBalancerAddressTypeConfig变更网络类型配置变更网络型负载均衡NLB实例的IPv4地址的网络类型。
UpdateLoadBalancerAttribute更新负载均衡实例属性更新网络型负载均衡实例名称等属性。
UpdateLoadBalancerZones更新实例可用区及可用区属性修改网络型负载均衡实例可用区及可用区属性。
EnableLoadBalancerIpv6Internet开启NLB实例IPv6公网将双栈NLB实例的IPv6地址从私网变更为公网。
DisableLoadBalancerIpv6Internet关闭NLB实例IPv6公网将双栈NLB实例的Pv6地址从公网变更为私网。
LoadBalancerLeaveSecurityGroup解绑安全组为网络型负载均衡实例解绑安全组。
LoadBalancerJoinSecurityGroup绑定安全组为网络型负载均衡实例绑定已创建的安全组。
UpdateLoadBalancerProtection修改删除保护开启或关闭删除保护功能,及更新修改保护功能。
ListLoadBalancers查询负载均衡实例信息查询已创建的网络型负载均衡实例的基本信息。
GetLoadBalancerAttribute查询负载均衡实例的详细信息查询指定网络型负载均衡实例的详细信息。
StartShiftLoadBalancerZones把可用区的EIP/VIP从域名解析中摘除将可用区对应的EIP/VIP从域名解析中摘除。
CancelShiftLoadBalancerZones把可用区的EIP/VIP加到DNS中将可用区对应的EIP/VIP加回到域名解析中。

监听

API标题API概述
CreateListener创建监听在网络型负载均衡实例中创建TCP、UDP或TCPSSL监听。
DeleteListener删除监听删除网络型负载均衡监听。
StartListener启动监听启动网络型负载均衡监听。
StopListener停止监听停止网络型负载均衡实例的监听。
UpdateListenerAttribute更新监听配置更新网络型负载均衡监听的配置。
ListListeners查询监听查询网络型负载均衡监听列表。
GetListenerAttribute查询监听的属性查询网络型负载均衡实例的监听详情。
GetListenerHealthStatus查询监听健康检查状态查询网络型负载均衡实例监听的健康检查状态。

监听证书

API标题API概述
ListListenerCertificates查询TCPSSL监听证书查询TCPSSL监听的服务器证书。
AssociateAdditionalCertificatesWithListener关联扩展证书和监听为TCPSSL监听关联扩展证书。
DisassociateAdditionalCertificatesWithListener解除关联监听和扩展证书解除TCPSSL监听关联的扩展证书。

服务器组

API标题API概述
CreateServerGroup创建服务器组在指定地域创建服务器组。
AddServersToServerGroup添加后端服务器向网络型负载均衡服务器组中添加后端服务器。
DeleteServerGroup删除服务器组删除网络型负载均衡的服务器组。
RemoveServersFromServerGroup移除后端服务器从网络型负载均衡服务器组中移除后端服务器。
UpdateServerGroupAttribute更新服务器组配置更新网络型负载均衡服务器组的配置。
UpdateServerGroupServersAttribute更新后端服务器配置更新网络型负载均衡服务器组中后端服务器的权重和描述信息。
ListServerGroups查询服务器组查询网络型负载均衡实例的服务器组列表。
ListServerGroupServers查询服务器查询网络型负载均衡服务器组中的服务器列表。

共享带宽包

API标题API概述
DetachCommonBandwidthPackageFromLoadBalancer实例解绑共享带宽包解绑网络型负载均衡实例中的共享带宽包。
AttachCommonBandwidthPackageToLoadBalancer实例绑定共享带宽包为网络型负载均衡实例绑定共享带宽包。

安全策略

API标题API概述
CreateSecurityPolicy创建自定义安全策略在指定地域创建TCPSSL监听的自定义安全策略。
DeleteSecurityPolicy删除自定义安全策略删除网络型负载均衡TLS自定义安全策略。
UpdateSecurityPolicyAttribute更新自定义安全策略属性更新网络型负载均衡自定义安全策略属性。
ListSecurityPolicy查询自定义安全策略查询网络型负载均衡的TLS自定义安全策略。
ListSystemSecurityPolicy查询系统安全策略查询系统默认的TLS安全策略。

资源组

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

异步任务

API标题API概述
GetJobStatus查询异步任务结果查询网络型负载均衡的异步任务执行结果信息。

标签

API标题API概述
TagResources给资源添加标签为指定的资源列表统一创建并绑定标签。
UntagResources删除资源的标签为指定的资源列表统一解绑标签。
ListTagResources查询资源标签查询指定资源标签。
  • 本页导读 (1)
文档反馈