负载均衡
负载均衡
应用型负载均衡ALB
请输入
- 文档首页
负载均衡API 参考转发规则DescribeRules - 获取指定监听器转发规则列表
复制全文
下载 pdfDescribeRules - 获取指定监听器转发规则列表
文档反馈
问问助手调用 DescribeRules 接口，获取指定监听器转发规则列表。
使用说明
每秒最多提交 40 个 API 请求。
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Action string 必选 示例值：DescribeRules
要执行的操作，取值：DescribeRules。
Version string 必选 示例值：2020-04-01
API的版本，取值：2020-04-01。
ListenerId string 必选 示例值：lsn-2fea4ayvu2g3k5oxruuz****
监听器 ID。
返回参数
RequestId string 示例值：20210811152539010225146063030****
请求 ID。
Rules object[] 示例值：--
符合条件的转发规则的详细信息。
Description string 示例值：rule1
转发规则的描述。
Domain string 示例值：www.test.com
转发规则的域名。
RewriteEnabled string 示例值：on
转发规则重写配置开关。
- on：开启。
- off：关闭。
RuleAction string 示例值：Redirect
转发规则动作。
- 空：默认转发至服务器组。
- Redirect：重定向。
RuleId string 示例值：rule-****
转发规则ID。
ServerGroupId string 示例值：rsp-2fel9y8pxr56o5oxruuuu****
转发规则关联的后端服务器组ID。
TrafficLimitEnabled string 示例值：on
转发规则 QPS 限速开关。
- on：开启。
- off：关闭。
TrafficLimitQPS integer 示例值：100
每秒请求数。取值范围：100～100000。
Url string 示例值：\
转发规则的URL。
RedirectConfig object 示例值：--
重定向相关配置信息。
RedirectHttpCode string 示例值：301
重定向状态码。
- 301
- 302
- 307
- 308
RedirectProtocol string 示例值：HTTP
重定向使用的协议。
- HTTP
- HTTPS
RedirectUri string 示例值：/
重定向的URI。
若创建/修改重定向类型的转发规则时，重定向uri设置为空，接口会返回${request_uri}，该变量含义为重定向uri与请求uri保持一致，但不支持创建/修改时，将重定向uri设置为${request_uri}。
RedirectPort string 示例值：80
重定向的端口。
若创建/修改重定向类型的转发规则时，重定向端口设置为空，接口会返回${port}，该变量含义为重定向端口与请求端口（监听器端口）保持一致，但不支持创建/修改时，将重定向端口设置为${port}。
RedirectDomain string 示例值：www.test.com
重定向的域名。
若创建/修改重定向类型的转发规则时，重定向域名设置为空，接口会返回${host}，该变量含义为重定向域名与请求域名保持一致，但不支持创建/修改时，将重定向域名设置为${host}。
RewriteConfig object 示例值：--
重定向相关配置信息。
RewritePath string 示例值：/abc
重写路径。
ForwardGroupConfig object 示例值：--
转发规则服务器组配置。
ServerGroupTuples object[] 示例值：--
转发到的目的服务器组列表。
ServerGroupId string 示例值：rsp-j23jl2hh52ljllfksjl
转发到的目的服务器组 ID。
Weight integer 示例值：99
服务器组权重。
StickySessionEnabled string 示例值：on
是否开启组间会话保持。
- on：开启。
- off：不开启。
StickySessionTimeout integer 示例值：1000
组件回话保持的超时时间。单位：秒。
Priority integer 示例值：1
标准版转发规则优先级。
RuleConditions object[] 示例值：--
标准版转发规则条件。
SourceIpConfig object 示例值：--
Source IP配置。
Values string[] 示例值：192.168.1.0/24
IPv4地址或IPv4地址段。
CookieConfig object 示例值：--
Cookie配置。
Values object[] 示例值：--
Cookie配置。
Key string 示例值：username
Cookie字符串键。
Value string 示例值：zhangsan
Cookie字符串值。
Type string 示例值：Host
标准版转发规则条件类型。
- Host： 域名。
- Path： 路径。
- Header：HTTP头字段。
HostConfig object 示例值：--
域名配置。
Values string[] 示例值：www.test.com
转发规则的域名，支持泛域名和精确域名。
PathConfig object 示例值：--
路径配置。
Values string[] 示例值：/foo
转发规则的URL，仅支持绝对路径。
HeaderConfig object 示例值：--
HTTP标头配置。
Values string[] 示例值：test
头字段值。
Key string 示例值：X-Forwarded-For
头字段键。
MethodConfig object 示例值：--
请求方法。
Values string[] 示例值：GET
请求方法。
支持HEAD、GET、POST、OPTIONS、PUT、PATCH、DELETE。
QueryStringConfig object 示例值：--
查询字符串。
Values object[] 示例值：--
字符串的信息。
Key string 示例值：version
查询字符串键。
Value string 示例值：1.0.0
查询字符串值。
RuleActions object[] 示例值：--
标准版转发规则动作。
CorsConfig object 示例值：--
跨域配置。
AllowCredentials string 示例值：on
跨域访问时是否允许携带凭证信息。
- on
- off
ExposeHeaders string[] 示例值：test
允许浏览器、JavaScript脚本访问的响应头部。
AllowHeaders string[] 示例值：test
除了浏览器内置的基础Header，设置跨域访问时允许的Header。
MaxAge integer 示例值：300
浏览器的缓存时间。 单位为秒。
AllowMethods string[] 示例值：GET
跨域访问时允许的HTTP方法。
支持GET、POST、PUT、DELETE、HEAD、OPTIONS、PATCH。
AllowOrigin string[] 示例值：http://www.test.com
允许通过浏览器访问服务器资源的站点。
InsertHeaderConfig object 示例值：--
写入header的配置。
Key string 示例值：test
头字段的名称。
Value string 示例值：remote_addr
头字段内容。
ValueType string 示例值：UserDefined
头字段内容类型。
- UserDefined：您自定义头字段内容。
- SystemDefined：系统定义头字段内容。
Type string 示例值：Rewrite
转发规则动作类型。
- ForwardGroup：转发至多个虚拟服务器组。
- Redirect： 重定向。
- Rewrite： 重写。
- TrafficLimit：流量限速。
TrafficLimitConfig object 示例值：--
限速的配置信息。
QPS integer 示例值：1000
每秒请求数。
RewriteConfig object 示例值：--
重写的配置信息。
Host string 示例值：www.test.com
重写域名。
Path string 示例值：/test
重写路径。
RedirectConfig object 示例值：--
重定向的配置信息。
Query string 示例值：test
重定向查询字符串。
Host string 示例值：www.test.com
重定向域名，仅支持精确域名。
Path string 示例值：/test
重定向 URI。
Protocol string 示例值：HTTP
重定向使用的协议，支持HTTP，HTTPS。
HttpCode string 示例值：301
重定向状态码，支持301，302，307，308。
Port string 示例值：88
重定向端口。
ForwardGroupConfig object 示例值：--
转发至的转发动作配置信息。
ServerGroupTuples object[] 示例值：--
服务器组配置。
ServerGroupId string 示例值：rsp-j23jl2hh52ljllfksjl
转发到的目的服务器组 ID。
Weight integer 示例值：99
服务器组权重。
ServerGroupStickySession object 示例值：--
会话保持配置。
Enabled string 示例值：on
是否开启组间会话保持。
- on：开启。
- off：不开启。
Timeout integer 示例值：10
组件回话保持的超时时间。单位：秒。
FixedResponseConfig object 示例值：--
返回固定响应的配置下信息。
Content string 示例值：esponse_ok
返回的固定内容。
HttpCode string 示例值：200
返回的 HTTP 状态码。
ContentType string 示例值：text/plain
返回的固定内容的格式。
- text/plain
- text/css
- text/html
- application/javascript
- application/json
请求示例
返回示例
错误码
最近更新时间：2026.09.30 10:13:02
这个页面对您有帮助吗？
有用
有用
无用
无用