查询指定监听已配置的转发规则。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI
Explorer可以自动生成SDK代码示例。
调试
调试
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| slb:DescribeRules | READ |
|
|
无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 |
负载均衡实例的地域ID。 您可以通过调用DescribeRegions接口查询地域ID。 |
cn-hangzhou |
| LoadBalancerId | string | 是 |
负载均衡实例ID。 |
lb-bp1ca0zt07t934**** |
| ListenerProtocol | string | 否 |
负载均衡实例前端使用的协议。 说明 | https |
| ListenerPort | integer | 是 | 负载均衡实例前端使用的监听端口。 取值范围：1~65535。 |
90 |
返回参数
| 名称 | 类型 | 描述 | 示例值 |
|---|---|---|---|
| object | |||
| RequestId | string |
请求ID。 |
9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C |
| Rules | object [] |
转发规则列表。 |
|
| HealthCheckHttpCode | string |
健康检查正常的HTTP状态码，多个状态码用半角逗号（,）分隔。默认值为http_2xx。 取值：http_2xx、http_3xx、http_4xx或http_5xx。 说明 | http_3xx |
| VServerGroupId | string | 转发规则绑定的目标虚拟服务器组ID。 |
rsp-6cejjzl**** |
| Domain | string |
转发规则绑定的请求域名。 |
test.com |
| Cookie | string |
服务器上配置的Cookie。 长度为1~200个字符，只能包含ASCII英文字母和数字字符，不能包含逗号（,）、半角分号（;）或空格，也不能以美元符号（$）开头。 说明 | 23 |
| HealthCheckInterval | integer | 健康检查的时间间隔。 取值：1~50秒。 说明 | 5 |
| Url | string | 转发规则绑定的请求路径。 |
/cache |
| HealthCheckURI | string |
用于健康检查的URI。 说明 | /example |
| StickySessionType | string | Cookie的处理方式。取值：
说明 | insert |
| RuleName | string | 转发规则名称，长度为1~80个字符，只能使用字母、数字、短划线（-）、正斜线（/）、半角句号（.）和下划线（_）这些字符。 说明 | Rule2 |
| RuleId | string | 转发规则ID。 |
rule-tybqi6**** |
| HealthCheckConnectPort | integer |
健康检查的后端服务器的端口。 取值：1~65535。 说明 | 45 |
| Scheduler | string | 调度算法。取值：
说明 | wrr |
| HealthCheckTimeout | integer | 接收来自运行状况检查的响应需要等待的时间。如果后端ECS在指定的时间内没有正确响应，则判定为健康检查失败。 取值：1~300秒。 说明 | 34 |
| ListenerSync | string | 转发规则是否从监听上继承健康检查、会话保持和调度算法配置。 取值：on或off。
|
off |
| HealthyThreshold | integer |
健康检查连续成功多少次后，将后端服务器的健康检查状态由失败判定为成功。 取值：2~10。 说明 | 5 |
| CookieTimeout | integer | Cookie超时时间。取值：1~86400秒。 说明 | 56 |
| HealthCheckDomain | string | 用于健康检查的域名，取值：
当指定了IP或该参数未指定时，负载均衡会使用各后端服务器的私网IP当做健康检查使用的域名。
说明 | www.domain.com |
| UnhealthyThreshold | integer | 健康检查连续失败多少次后，将后端服务器的健康检查状态由success判定为fail。 取值：2~10 说明 | 2 |
| StickySession | string | 是否开启会话保持。 取值：on或off。 说明 | off |
| HealthCheck | string | 是否开启健康检查。 取值：on或off。 说明 | off |
示例
正常返回示例
JSON格式
{
"RequestId": "9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C",
"Rules": {
"Rule": [
{
"HealthCheckHttpCode": "http_3xx",
"VServerGroupId": "rsp-6cejjzl****",
"Domain": "test.com",
"Cookie": "23",
"HealthCheckInterval": 5,
"Url": "/cache",
"HealthCheckURI": "/example",
"StickySessionType": "insert",
"RuleName": "Rule2",
"RuleId": "rule-tybqi6****",
"HealthCheckConnectPort": 45,
"Scheduler": "wrr",
"HealthCheckTimeout": 34,
"ListenerSync": "off",
"HealthyThreshold": 5,
"CookieTimeout": 56,
"HealthCheckDomain": "www.domain.com",
"UnhealthyThreshold": 2,
"StickySession": "off",
"HealthCheck": "off"
}
]
}
}JSON格式
{
"RequestId": "9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C",
"Rules": {
"Rule": [
{
"HealthCheckHttpCode": "http_3xx",
"VServerGroupId": "rsp-6cejjzl****",
"Domain": "test.com",
"Cookie": "23",
"HealthCheckInterval": 5,
"Url": "/cache",
"HealthCheckURI": "/example",
"StickySessionType": "insert",
"RuleName": "Rule2",
"RuleId": "rule-tybqi6****",
"HealthCheckConnectPort": 45,
"Scheduler": "wrr",
"HealthCheckTimeout": 34,
"ListenerSync": "off",
"HealthyThreshold": 5,
"CookieTimeout": 56,
"HealthCheckDomain": "www.domain.com",
"UnhealthyThreshold": 2,
"StickySession": "off",
"HealthCheck": "off"
}
]
}
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | TooManyListeners | More than 1 listener is found, please be more specified. | 检索到的监听数量大于1，请提供更具体的查询条件。 |
访问错误中心查看更多错误码。
内容没看懂？ 不太想学习？想快速解决？ 有偿解决： 联系专家
阿里云企业补贴进行中： 马上申请
腾讯云限时活动1折起，即将结束： 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折，更有现金返利:同意关联，立享优惠
转转请注明出处：https://www.yunxiaoer.com/168747.html