API概览

更新时间:
复制 MD 格式

API标准及多语言预置SDK

本产品(Gwlb/2024-04-15)的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

地域与可用区

API

标题

API概述

DescribeRegions 查询地域 查询负载均衡支持地域和服务地址
DescribeZones 查询可用区 查询负载均衡支持可用区。

实例

API

标题

API概述

CreateLoadBalancer 创建负载均衡实例 创建负载均衡实例。
UpdateLoadBalancerAttribute 更新负载均衡实例属性 更新负载均衡实例属性。
UpdateLoadBalancerZones 更新负载均衡可用区 更新负载均衡实例可用区。
DeleteLoadBalancer 删除负载均衡实例 删除负载均衡实例。
ListLoadBalancers 查询负载均衡实例列表 查询负载均衡实例列表。
GetLoadBalancerAttribute 查询负载均衡实例详细信息 查询负载均衡实例详细信息。

服务器组

API

标题

API概述

CreateServerGroup 创建服务器组 创建负载均衡服务器组。
UpdateServerGroupAttribute 更新服务器组属性 更新负载均衡服务器组属性。
DeleteServerGroup 删除服务器组 删除负载均衡服务器组。
AddServersToServerGroup 服务器组中添加后端服务器 向负载均衡服务器组中添加后端服务器。
RemoveServersFromServerGroup 服务器组中移除后端服务器 从负载均衡服务器组中移除后端服务器。
ListServerGroups 查询服务器组列表 查询负载均衡服务器组列表。
ListServerGroupServers 查询服务器组中的服务器列表 查询负载均衡服务器组中的服务器列表。

监听

API

标题

API概述

CreateListener 创建监听 创建负载均衡监听器。
UpdateListenerAttribute 更新监听属性 更新负载均衡监听的属性。
DeleteListener 删除监听 删除负载均衡监听器。
ListListeners 查询监听列表 查询负载均衡监听列表。
GetListenerAttribute 查询监听详细信息 查询负载均衡实例的监听器详情。
GetListenerHealthStatus 查询监听健康检查状态 查询负载均衡实例监听的健康检查状态。

标签

API

标题

API概述

TagResources 添加资源标签 为指定的资源列表创建并绑定标签。
UntagResources 删除资源标签 为指定的资源列表解绑标签。
ListTagResources 查询资源标签 查询指定资源绑定的标签。

资源组

API

标题

API概述

MoveResourceGroup 迁移资源组 修改资源所属的资源组。