查询HTTP监听配置。
接口说明
前提条件
- 您已经创建传统型负载均衡，具体操作，请参见CreateLoadBalancer。
- 您已经创建HTTP监听，具体操作，请参见CreateLoadBalancerHTTPListener。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI
Explorer可以自动生成SDK代码示例。
调试
调试
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| slb:DescribeLoadBalancerHTTPListenerAttribute | READ |
|
|
无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 否 |
传统型负载均衡实例的地域ID。 您可以调用DescribeRegions接口获取地域ID。 |
cn-hangzhou |
| LoadBalancerId | string | 是 |
传统型负载均衡实例的ID。 |
lb-bp1uaunez0uho0zf0**** |
| ListenerPort | integer | 是 |
实例前端使用的端口。 取值：1~65535。 |
80 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| object | |||
| AclType | string |
访问控制类型：
如果开启了白名单访问，但访问策略组中没有添加任何IP，则负载均衡监听会转发全部请求。
如果开启了黑名单访问，但访问策略组中没有添加任何IP，则负载均衡监听会转发全部请求。 说明 | white |
| VServerGroupId | string | 绑定的服务器组ID。 |
rsp-cige6j**** |
| Status | string |
当前监听的状态。取值：
|
stopped |
| Cookie | string |
服务器上配置的Cookie。 |
B490B5EBF6F3CD402E515D22BCDA1598 |
| Gzip | string |
是否开启
|
on |
| HealthCheckConnectPort | integer |
健康检查的端口。 说明 | 8080 |
| RequestId | string | 请求ID。 |
365F4154-92F6-4AE4-92F8-7FF34B540710 |
| Description | string |
自定义监听名称。 |
HTTP_80 |
| Bandwidth | integer |
监听的带宽峰值。单位：Mbps。
|
-1 |
| HealthCheckTimeout | integer |
每次健康检查响应的超时时间，单位：秒。 |
3 |
| AclStatus | string |
是否开启访问控制功能。取值：
|
off |
| BackendServerPort | integer |
实例后端使用的端口。 |
80 |
| CookieTimeout | integer |
Cookie超时时间。单位：秒。 |
500 |
| HealthCheckDomain | string |
用于健康检查的域名。 |
www.domain.com |
| UnhealthyThreshold | integer |
不健康检查阈值。 |
4 |
| ForwardPort | integer |
HTTP至HTTPS的监听转发端口。 说明 | 80 |
| XForwardedFor_SLBID | string | 是否通过
|
on |
| SecurityStatus | string |
是否开启安全状态。取值：
|
on |
| HealthCheckHttpCode | string |
健康检查正常的HTTP状态码。 |
http_2xx,http_3xx |
| ListenerForward | string |
是否开启HTTP至HTTPS的监听转发。取值：
|
on |
| XForwardedFor | string |
是否开启通过
|
on |
| IdleTimeout | integer |
指定连接空闲超时时间，单位：秒。 默认值为15，取值范围为1~60。 在超时时间内一直没有访问请求，负载均衡会暂时中断当前连接，直到下一次请求来临时重新建立新的连接。 |
2 |
| RequestTimeout | integer |
指定请求超时时间。单位：秒。 默认值为60，取值范围为1~180。 在超时时间内后端服务器一直没有响应，负载均衡将放弃等待，给客户端返回HTTP 504错误码。 |
34 |
| ListenerPort | integer |
实例前端使用的端口。 |
80 |
| HealthCheckInterval | integer |
健康检查的时间间隔，单位：秒。 |
5 |
| HealthCheckURI | string |
用于健康检查的URI。 长度限制为1~80，只能使用字母、数字和短划线（-）、正斜线（/）、半角句号（.）、百分号（%），半角问号（?）、井号（#）和and（&）这些字符。URI不能只为正斜线（/），但必须以正斜线（/）开头。 |
/test/index.html |
| StickySessionType | string |
Cookie的处理方式。 取值：insert或server。
说明 | insert |
| AclId | string | 监听绑定的访问策略组ID。 说明 | on |
| Scheduler | string | 调度算法。取值：
|
wrr |
| HealthyThreshold | integer |
健康检查阈值。 |
4 |
| XForwardedFor_proto | string |
是否通过
|
on |
| XForwardedFor_SLBIP | string |
是否通过
|
on |
| StickySession | string |
是否开启会话保持。取值：
|
on |
| HealthCheckMethod | string |
监听HTTP类型健康检查的健康检查方法。取值：head或get。 说明 | get |
| HealthCheck | string | 是否开启健康检查。取值：
|
on |
| Rules | object [] |
转发规则描述。 |
|
| VServerGroupId | string |
转发规则的目标服务器组ID。 |
123 |
| Url | string |
访问路径。 |
/example |
| Domain | string |
域名。 |
www.example.com |
| RuleName | string |
转发规则名称。 |
test |
| RuleId | string |
转发规则ID。 |
1234 |
| LoadBalancerId | string |
传统型负载均衡实例ID。 |
lb-bp1uaunez0uho0zf0**** |
| Tags | object [] |
标签列表。 |
|
| TagKey | string |
监听的标签键。N的取值范围：1~20。一旦传入该值，则不允许为空字符串。最多支持64个字符，不能以 |
TestKey |
| TagValue | string |
监听的标签值。N的取值范围：1~20。一旦传入该值，可以为空字符串。最多支持128个字符，不能以 |
TestValue |
示例
正常返回示例
JSON格式
{
"AclType": "white",
"VServerGroupId": "rsp-cige6j****",
"Status": "stopped",
"Cookie": "B490B5EBF6F3CD402E515D22BCDA1598",
"Gzip": "on",
"HealthCheckConnectPort": 8080,
"RequestId": "365F4154-92F6-4AE4-92F8-7FF34B540710",
"Description": "HTTP_80",
"Bandwidth": -1,
"HealthCheckTimeout": 3,
"AclStatus": "off",
"BackendServerPort": 80,
"CookieTimeout": 500,
"HealthCheckDomain": "www.domain.com",
"UnhealthyThreshold": 4,
"ForwardPort": 80,
"XForwardedFor_SLBID": "on",
"SecurityStatus": "on",
"HealthCheckHttpCode": "http_2xx,http_3xx",
"ListenerForward": "on",
"XForwardedFor": "on",
"IdleTimeout": 2,
"RequestTimeout": 34,
"ListenerPort": 80,
"HealthCheckInterval": 5,
"HealthCheckURI": "/test/index.html",
"StickySessionType": "insert ",
"AclId": "on",
"Scheduler": "wrr",
"HealthyThreshold": 4,
"XForwardedFor_proto": "on",
"XForwardedFor_SLBIP": "on",
"StickySession": "on",
"HealthCheckMethod": "get",
"HealthCheck": "on",
"Rules": {
"Rule": [
{
"VServerGroupId": "123",
"Url": "/example",
"Domain": "www.example.com",
"RuleName": "test",
"RuleId": "1234"
}
]
},
"LoadBalancerId": "lb-bp1uaunez0uho0zf0****",
"Tags": {
"Tag": [
{
"TagKey": "TestKey",
"TagValue": "TestValue"
}
]
}
}错误码
访问错误中心查看更多错误码。
内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家
阿里云企业补贴进行中： 马上申请
腾讯云限时活动1折起，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠
转转请注明出处：https://www.yunxiaoer.com/168740.html