调用DescribeRuleAttribute查询指定转发规则的配置详情

查询指定转发规则的配置详情。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
slb:DescribeRuleAttribute	get	loadbalancer acs:slb:{#regionId}:{#accountId}:loadbalancer/{#loadbalancerId}	slb:tag	无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	负载均衡实例的地域 ID。您可以通过调用 DescribeRegions 接口查询地域 ID。	cn-hangzhou
RuleId	string	是	转发规则 ID。	rule-bp1efemp9****

返回参数

名称	类型	描述	示例值
	object
VServerGroupId	string	转发规则关联的服务器组 ID。	rsp-cige6j****
Cookie	string	服务器上配置的 Cookie。长度为 1~200 个字符，只能包含 ASCII 英文字母和数字字符，不能包含半角逗号（,）、半角分号（;）或空格，也不能以美元符号（$）开头。当 StickySession 为 on 且 StickySessionType 为 server 时，该参数必选且有效。	wwe
LoadBalancerId	string	负载均衡实例 ID。	lb-bp1ca0zt07t934wxe****
RuleId	string	转发规则 ID。	rule-hfgnd*****
RequestId	string	请求 ID。	9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C
HealthCheckConnectPort	integer	健康检查的后端服务器的端口。取值：1~65535。说明 HealthCheck 为 on 时，该参数有效。若为空且 HealthCheck 为 on，表明默认使用监听后端端口配置。	23
HealthCheckTimeout	integer	接收来自运行状况检查的响应需要等待的时间。如果后端 ECS 在指定的时间内没有正确响应，则判定为健康检查失败。取值：1~300 秒。说明 HealthCheck 为 on 时，该参数有效。	34
CookieTimeout	integer	Cookie 超时时间。取值：1~86400秒。说明当 StickySession 为 on 且 StickySessionType 为 insert 时，该参数必选且有效。	12
HealthCheckDomain	string	用于健康检查的域名，取值： $_ip：后端服务器的私网 IP。当指定了 IP 或该参数未指定时，负载均衡会使用各后端服务器的私网 IP 当做健康检查使用的域名。 domain：域名长度为 1~80 字符，只能包含字母、数字、半角句号（.）和短划线（-）。说明 HealthCheck 为 on 时，该参数有效。	www.example.com
UnhealthyThreshold	integer	健康检查连续失败多少次后，将后端服务器的健康检查状态由 success 判定为 fail。取值：2~10。说明 HealthCheck 为 on 时，该参数有效。	3
HealthCheckHttpCode	string	健康检查正常的 HTTP 状态码，多个状态码用逗号分隔。默认值为http_2xx。取值：http_2xx或http_3xx或http_4xx或http_5xx。说明 HealthCheck 为 on 时，该参数有效。	http_3xx
Domain	string	转发规则域名。	www.example.com
ListenerPort	string	负载均衡实例前端使用的监听端口。	90
Url	string	转发规则路径。	/cache
HealthCheckInterval	integer	健康检查的时间间隔。取值：1~50 秒。说明 HealthCheck 为 on 时，该参数有效。	34
HealthCheckURI	string	用于健康检查的 URI。说明 HealthCheck 为 on 时，该参数有效。	/rest
RuleName	string	转发规则名称。	Rule1
StickySessionType	string	Cookie 的处理方式。取值： insert：植入 Cookie。客户端第一次访问时，负载均衡会在返回请求中植入 Cookie（即在 HTTP/HTTPS 响应报文中插入 SERVERID），下次客户端携带此 Cookie 访问，负载均衡服务会将请求定向转发给之前记录到的后端服务器上。 server：重写 Cookie。负载均衡发现用户自定义了 Cookie，将会对原来的 Cookie 进行重写，下次客户端携带新的 Cookie 访问，负载均衡服务会将请求定向转发给之前记录到的后端服务器。说明当 StickySession 的值为 on 时，该参数有效。	insert
Scheduler	string	调度算法。取值： wrr（默认值）：权重值越高的后端服务器，被轮询到的次数（概率）也越高。 rr：按照访问顺序依次将外部请求依序分发到后端服务器。说明 ListenerSync 为 off 时有效，为 on 时表明与监听配置一致。	wrr
ListenerSync	string	转发规则是否从监听上继承健康检查、会话保持和调度算法配置。取值：on 或 off。 off：不继承监听配置，转发规则自定义健康检查及会话保持配置。 on：继承监听配置。	off
HealthyThreshold	integer	健康检查连续成功多少次后，将后端服务器的健康检查状态由 fail 判定为 success。取值：1~10。说明 HealthCheck 为 on 时，该参数有效。	2
StickySession	string	是否开启会话保持。取值： on：开启 off：不开启说明在 ListenerSync 为 off 时必选且有效，为 on 时表明与监听配置一致。	off
HealthCheck	string	是否开启健康检查。取值： on：开启 off：不开启说明 ListenerSync 为 off 时有效，为 on 时表明与监听配置一致。	off

示例

正常返回示例

JSON格式

{
  "VServerGroupId": "rsp-cige6j****",
  "Cookie": "wwe",
  "LoadBalancerId": "lb-bp1ca0zt07t934wxe****",
  "RuleId": "rule-hfgnd*****",
  "RequestId": "9DEC9C28-AB05-4DDF-9A78-6B08EC9CE18C",
  "HealthCheckConnectPort": 23,
  "HealthCheckTimeout": 34,
  "CookieTimeout": 12,
  "HealthCheckDomain": "www.example.com",
  "UnhealthyThreshold": 3,
  "HealthCheckHttpCode": "http_3xx ",
  "Domain": "www.example.com",
  "ListenerPort": "90",
  "Url": "/cache",
  "HealthCheckInterval": 34,
  "HealthCheckURI": "/rest",
  "RuleName": "Rule1",
  "StickySessionType": "insert",
  "Scheduler": "wrr",
  "ListenerSync": "off",
  "HealthyThreshold": 2,
  "StickySession": "off",
  "HealthCheck": "off"
}

错误码

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