You need to enable JavaScript to run this app.
导航
应用型负载均衡
  • 文档首页
    • /
  • 应用型负载均衡

DescribeRules

最近更新时间：2024.02.29 14:48:19

首次发布时间：2022.05.20 22:34:48

我的收藏

API 说明

API 名称：DescribeRules。
API 域名：open.volcengineapi.com 。
API 描述：获取指定监听器转发规则列表。

使用限制

节流限制：每秒最多提交 40 个 API 请求。

快速调试

API Explorer
您可以通过API Explorer在线发起调用，无需关注签名生成过程，快速获取调用结果。
去调试

URI 参数

在使用该部分 API 提交请求时必须包含以下 URI 参数。

除了 URI 参数，该 API 请求还需要包含签名参数。关于更多签名参数的信息，参见公共请求参数。

名称类型是否必选格式说明
Action
string
是
[a-zA-Z]+
API 名称，如 DescribeRules。
Versionstring是YYYY-MM-DDAPI 版本信息。该参数的取值是 2020-04-01 。
X-Expiresint否900表示签名的有效时间，单位是秒，默认值是900。

请求正文

在使用该 API 提交请求时，请求正文中可以包含的参数如下。

参数类型是否必选参数说明示例值
ListenerId
String
是
监听器ID。
lsn-2fea4ayvu2g3k5oxruuz****

响应正文

参数类型参数说明示例值
RequestId
String
请求ID。
20210811152539010225146063030****
RulesArray符合条件的转发规则的详细信息。详见下表 Rules 。-

Rules

参数类型参数说明示例值
RuleId
String
转发规则ID。
rule-****
DomainString转发规则的域名。www.test.com
UrlString转发规则的URL。/

RuleAction

String

转发规则动作，目前支持：

  • 为空：默认转发至服务器组。
  • Redirect：重定向。

Redirect

ServerGroupIdString转发规则关联的后端服务器组ID。rsp-2fel9y8pxr56o5oxruuuu****

TrafficLimitEnabled

String

转发规则 QPS 限速开关：

  • on：开启。

  • off：关闭。

on

TrafficLimitQPS

Integer

每秒请求数。取值范围：100～150000。

100

DescriptionString转发规则的描述。rule1

RewriteEnabled

String

转发规则重写配置开关：

  • on：开启。

  • off：关闭。

on

RedirectConfigArray重定向相关配置信息。具体参见下表 RedirectConfig。-
RewriteConfigArray重定向相关配置信息。具体参见下表 RewriteConfig。-

RedirectConfig

参数类型参数说明示例值

RedirectDomain

String

重定向的域名。
若创建/修改重定向类型的转发规则时，重定向域名设置为空，接口会返回${host}，该变量含义为重定向域名与请求域名保持一致，但不支持创建/修改时，将重定向域名设置为${host}.

www.test.com

RedirectUri

String

重定向的URI。
若创建/修改重定向类型的转发规则时，重定向uri设置为空，接口会返回${request_uri}，该变量含义为重定向uri与请求uri保持一致，但不支持创建/修改时，将重定向uri设置为${request_uri}.

/

RedirectPort

String

重定向的端口。
若创建/修改重定向类型的转发规则时，重定向端口设置为空，接口会返回${port}，该变量含义为重定向端口与请求端口（监听器端口）保持一致，但不支持创建/修改时，将重定向端口设置为${port}.

80

RedirectHttpCode		String重定向状态码。支持301（默认），302，307，308。301
RedirectProtocol		String重定向使用的协议。支持HTTP，HTTPS（默认）。HTTP

RewriteConfig

参数类型参数说明示例值

RewritePath

String

重写路径。

/abc

示例

请求示例

GET /?Action=DescribeRules&ListenerId=lsn-1g0puwcxu****8ibuxxw2pmf7&Version=2020-04-01 HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
ServiceName: alb

响应示例

{
    "ResponseMetadata": {
        "RequestId": "20210813182653****2514214204001104",
        "Action": "DescribeRules",
        "Version": "2020-04-01",
        "Service": "alb",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "20210813182653****2514214204001104",
        "Rules": [
            {
                "RuleId": "rule-2fegss1cplxxc5oxruvvqzvyu",
                "Domain": "%abc.com",
                "Url": "/abcc",
                "ServerGroupId": "rsp-3ciynvqsspiww6c6rrsz73tzn",
                "Description": "TEST"
            }
        ]
    }
}

错误码

如果响应正文包含 Error 字段，则表示 API 请求失败。此处仅展示当前 API 的错误码，更多错误码请参见公共错误码。

HTTP Code错误码错误信息错误描述
404InvalidListener.NotFoundThe specified Listener does not exist.指定的监听器不存在。