GetLoadBalancer - 查询单个负载均衡器 - 边缘安全加速

根据指定站点ID和负载均衡器ID，获取单个负载均衡器的详细信息。

接口说明

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

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

esa:GetLoadBalancer

get

*Site

acs:esa:{#regionId}:{#accountId}:site/{#SiteId}

无

请求参数

名称	类型	必填	描述	示例值
Id	integer	是	负载均衡器 ID，用于唯一标识要查询的负载均衡器，负载均衡器创建时会直接返回，也可以通 ListLoadBalancers 接口获取站点下所有负载均衡器查询。	99867648760****
SiteId	integer	是	站点 ID，可通过调用 ListSites 接口获取。	1159101787****

返回参数

名称	类型	描述	示例值
	object	成功响应时返回的数据结构，包含负载均衡器的详细配置信息。
RequestId	string	请求 ID。	EEEBE525-F576-1196-8DAF-2D70CA3F4D2F
Id	integer	负载均衡器的唯一标识 ID。	99867648760****
Name	string	负载均衡器的名称。	lb.example.com
SiteId	integer	负载均衡器所归属的站点 ID。	11591017874****
Enabled	boolean	负载均衡器是否启用。 true：启用。 false：不启用。	true
Ttl	integer	TTL 值，DNS 记录的生存时间，默认为 30 秒。	60
SessionAffinity	string	会话保持，取值： off：不开启。 ip：按 ip 方式会话保持。 cookie: 按 cookie 方式会话保持。	ip
FallbackPool	integer	兜底地址池 ID，当所有其他地址池不可用时，流量将被重定向至此地址池。	96228666776****
SteeringPolicy	string	负载均衡策略。	order
Description	string	负载均衡器的描述信息。	test
AdaptiveRouting	object	跨地址池回源配置。
FailoverAcrossPools	boolean	是否跨地址池回源。 true：是。 false: 否。	true
DefaultPools	array	默认地址池 ID 列表。
	integer	默认地址池。	96228666776****
RandomSteering	object	加权轮询配置，用于控制不同地址池的流量分配权重。
DefaultWeight	integer	默认的轮询权重，用于所有没有单独指定权重的地址池。取值范围：0-100 的数字。	50
PoolWeights	object	各后端服务器池的权重配置，键为池 ID，值为权重系数。权重系数表示相对流量分配的比例。
	integer	单个源地址池的权重，0-100 的数字，0 表示不往该源地址池调度流量。	50
Rules	array<object>	规则配置列表，用于定义特定条件下的行为。
	array<object>	规则集中的规则配置。
FixedResponse	object	匹配规则后执行响应指定内容。
ContentType	string	HTTP Header 中的 Content-Type 字段。	application/json
Location	string	http 返回中的 location 字段。	http://www.example.com/index.html
MessageBody	string	响应 body 值。	Hello World.
StatusCode	integer	状态码。	200
Overrides	any	匹配规则后修改对应请求改写的负载均衡配置，配置的字段，会覆盖负载均衡器配置里相应的字段。	{ "adaptive_routing": { "failover_across_pools": true }, "sub_region_pools": { "GB": [ 96228666776** ], "US": [ 96228666776 ] }, "default_pools": [ 96228666776, 96228666776 ], "fallback_pool": 96228666776, "location_strategy": { "mode": "resolver_ip", "prefer_ecs": "always" }, "random_steering": { "default_weight": 30, "pool_weights": { "96228666776": 70, "96228666776": 80 } }, "region_pools": { "ENAM": [ 96228666776, 92843536908 ], "WNAM": [ 92843536908** ] }, "session_affinity": "cookie", "session_affinity_attributes": { "drain_duration": 100, "headers": ["none"], "require_all_headers": false, "samesite": "Auto", "secure": "Auto", "zero_downtime_failover": "sticky" }, "session_affinity_ttl": 1800, "steering_policy": "dynamic_latency", "ttl": 30 }
Rule	string	规则内容，使用条件表达式来匹配用户请求。添加全局配置的时候不需要设置该参数。存在两种使用场景：匹配所有传入请求：值设置为 true 匹配指定请求：值设置为自定义表达式，例如：(http.host eq "video.example.com")	http.request.uri.path contains "/testing"
RuleName	string	规则名称。添加全局配置的时候不需要设置该参数。	r2
RuleEnable	string	规则开关。添加全局配置的时候不需要设置该参数。取值范围： on：开启。 off：关闭。	off
Sequence	integer	规则执行顺序。数值越大越优先执行。	1
Terminates	boolean	是否终止执行后续规则。 true：是。 false：否，默认值。	true
Monitor	object	监视器配置。
Type	string	监视器协议类型，如 HTTP，用于健康检查，值为 off 时，表示不进行检查。	HTTP
Method	string	健康检查的方法。	GET
Port	integer	目标端口。	80
Path	string	路径。	/
Interval	integer	健康检查的间隔时间，单位：秒。	60
ExpectedCodes	string	预期状态码，如 200,202，成功的 HTTP 响应。	200,202
FollowRedirects	boolean	是否跟随重定向。 true：是。 false：否。	true
ConsecutiveUp	integer	连续探测多少次成功算成功，如`3`。	3
ConsecutiveDown	integer	连续探测多少次失败算失败，如`5`。	5
Header	any	探测时所带头部信息，HTTP 头。	{ "host": [ "example1.com", "example2.com" ] }
Timeout	integer	健康检查超时时间，单位：秒。	5
MonitoringRegion	string	探测点所在区域，默认为 Global， Global: 全球。 ChineseMainland: 中国内地。 OutsideChineseMainland: 全球（不包括中国内地）。	Global
Status	string	负载均衡器的状态。	healthy
SubRegionPools	any	二级 region 对应的地址池，多个二级 region 共用一批地址池时，可以多个二级 region，使用逗号拼接作为 key。	{"AL,MO": [92298024898**],"CN-SH,CN-SX,CN-SC":[92304347804,92843536908**]}
RegionPools	any	一级 region 对应的地址池。	{ "ENAM": [ 12345678** ], "WNAM": [ 23456789, 23456789** ] }

示例

正常返回示例

JSON格式

{
  "RequestId": "EEEBE525-F576-1196-8DAF-2D70CA3F4D2F",
  "Id": 0,
  "Name": "lb.example.com",
  "SiteId": 0,
  "Enabled": true,
  "Ttl": 60,
  "SessionAffinity": "ip",
  "FallbackPool": 0,
  "SteeringPolicy": "order",
  "Description": "test",
  "AdaptiveRouting": {
    "FailoverAcrossPools": true
  },
  "DefaultPools": [
    0
  ],
  "RandomSteering": {
    "DefaultWeight": 50,
    "PoolWeights": {
      "key": 50
    }
  },
  "Rules": [
    {
      "FixedResponse": {
        "ContentType": "application/json",
        "Location": "http://www.example.com/index.html",
        "MessageBody": "Hello World.",
        "StatusCode": 200
      },
      "Overrides": "{\n            \"adaptive_routing\": {\n                \"failover_across_pools\": true\n            },\n            \"sub_region_pools\": {\n                \"GB\": [\n                    96228666776****\n                ],\n                \"US\": [\n                    96228666776****\n                ]\n            },\n            \"default_pools\": [\n                96228666776****,\n                96228666776****\n            ],\n            \"fallback_pool\": 96228666776****,\n            \"location_strategy\": {\n                \"mode\": \"resolver_ip\",\n                \"prefer_ecs\": \"always\"\n            },\n            \"random_steering\": {\n                \"default_weight\": 30,\n                \"pool_weights\": {\n                    \"96228666776****\": 70,\n                    \"96228666776****\": 80\n                }\n            },\n            \"region_pools\": {\n                \"ENAM\": [\n                    96228666776****,\n                    92843536908****\n                ],\n                \"WNAM\": [\n                    92843536908****\n                ]\n            },\n            \"session_affinity\": \"cookie\",\n            \"session_affinity_attributes\": {\n                \"drain_duration\": 100,\n                \"headers\": [\"none\"],\n                \"require_all_headers\": false,\n                \"samesite\": \"Auto\",\n                \"secure\": \"Auto\",\n                \"zero_downtime_failover\": \"sticky\"\n            },\n            \"session_affinity_ttl\": 1800,\n            \"steering_policy\": \"dynamic_latency\",\n            \"ttl\": 30\n        }",
      "Rule": "http.request.uri.path contains \"/testing\"",
      "RuleName": "r2",
      "RuleEnable": "off",
      "Sequence": 1,
      "Terminates": true
    }
  ],
  "Monitor": {
    "Type": "HTTP",
    "Method": "GET",
    "Port": 80,
    "Path": "/",
    "Interval": 60,
    "ExpectedCodes": "200,202",
    "FollowRedirects": true,
    "ConsecutiveUp": 3,
    "ConsecutiveDown": 5,
    "Header": "{\n        \"host\": [\n            \"example1.com\",\n            \"example2.com\"\n        ]\n    }",
    "Timeout": 5,
    "MonitoringRegion": "Global"
  },
  "Status": "healthy",
  "SubRegionPools": "{\"AL,MO\": [92298024898****],\"CN-SH,CN-SX,CN-SC\":[92304347804****,92843536908****]}",
  "RegionPools": "{\n  \"ENAM\": [\n    12345678****\n  ],\n  \"WNAM\": [\n    23456789****,\n    23456789****\n  ]\n}"
}

错误码

HTTP status code	错误码	错误信息	描述
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.	站点不存在，或者不属于你。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。