GetLoadBalancer_边缘安全加速_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

此 API 允许用户通过提供必要的身份验证信息和资源标识,查询特定负载均衡器的配置详情,包括但不限于名称、会话保持策略、路由策略等。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
esa:GetLoadBalancer
Get
Site
acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

请求参数

字段名称字段详情
Idinteger<int64>

负载均衡器 ID,用于唯一标识要查询的负载均衡器,负载均衡器创建时会直接返回,也可以通 ListLoadBalancers 接口获取站点下所有负载均衡器查询。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:99867648760****
SiteIdinteger<int64>

站点 ID,可通过调用 ListSites 接口获取。

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:1159101787****

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:EEEBE525-F576-1196-8DAF-2D70CA3F4D2F
Idinteger<int64>

负载均衡器的唯一标识 ID。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:99867648760****
Namestring

负载均衡器的名称。

示例值:lb.example.com
SiteIdinteger<int64>

负载均衡器所归属的站点 ID。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:11591017874****
Enabledboolean

负载均衡器是否启用。展开详情

示例值:true
Ttlinteger<int32>

TTL 值,DNS 记录的生存时间,默认为 30 秒。

示例值:60
SessionAffinitystring

会话保持,取值:展开详情

示例值:ip
FallbackPoolinteger<int64>

兜底地址池 ID,当所有其他地址池不可用时,流量将被重定向至此地址池。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:96228666776****
SteeringPolicystring

负载均衡策略。

示例值:order
Descriptionstring

负载均衡器的描述信息。

示例值:test
AdaptiveRoutingobject

跨地址池回源配置。

DefaultPoolsarray<integer<int64>>

默认地址池 ID 列表。

RandomSteeringobject

加权轮询配置,用于控制不同地址池的流量分配权重。

Rulesarray<object>

规则配置列表,用于定义特定条件下的行为。

Monitorobject

监视器配置。

Statusstring

负载均衡器的状态。

示例值:healthy
SubRegionPoolsany

二级 region 对应的地址池,多个二级 region 共用一批地址池时,可以多个二级 region,使用逗号拼接作为 key。

示例值:{"AL,MO": [92298024898****],"CN-SH,CN-SX,CN-SC":[92304347804****,92843536908****]}
RegionPoolsany

一级 region 对应的地址池。

示例值:{ "ENAM": [ 12345678**** ], "WNAM": [ 23456789****, 23456789**** ] }

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InternalException
Failed to call the service. Try again later or contact technical support.诊断
400
LoadBalancerNotExist
The specified load balancer name is invalid or load balancing is not enabled for your website.Make sure that you specify a valid load balancer name and load balancing is enabled. Then, try again.诊断
404
SiteNotFound
The website does not exist or does not belong to you.诊断

变更历史

变更时间变更内容概要操作
2025-02-07
新增OpenAPI,查询单个负载均衡器

相关示例