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

DescribeRules

最近更新时间：2024.02.05 10:29:57

首次发布时间：2021.08.31 10:37:28

我的收藏

调用 DescribeRules 接口查询指定HTTP/HTTPS监听器中的转发规则列表。

调试

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

请求参数

名称类型是否必填示例值
描述
ActionString是DescribeRules要执行的操作，取值为DescribeRules。
VersionString是2020-04-01API版本信息，当前版本为：2020-04-01。
ListenerIdString是lsn-2fea4ayvu2g3k5oxruuz****监听器ID。您可以调用DescribeListeners接口获取监听器ID。

返回参数

字段类型示例值
描述
RequestIdString20210811152539010225146063030****请求ID。
RulesArray of Struct-符合条件的转发规则的详细信息。具体请参见下表“Rules”。

Rules

字段类型示例值
描述
RuleIdStringrule-2fegss1cplxxc5oxruvvq****转发规则ID。
DomainStringwww.test.com转发规则的域名。
UrlString/转发规则的URL。
ServerGroupIdStringrsp-2fel9y8pxr56o5oxruuuu****转发规则关联的后端服务器组ID。
DescriptionStringrule1转发规则的描述。

ActionType

String

Redirect

转发规则的转发动作。

  • Forward：转发至。
  • Redirect：重定向至。

RedirectConfig

Array of Struct

-

重定向相关配置信息。具体参见下表“RedirectConfig”。

说明

仅当ActionType取值为Redirect时，返回该参数。

RedirectConfig

参数名称类型示例值说明
ProtocolStringHTTP重定向的协议。
HostStringwww.test.com重定向的域名。
PortString80重定向的端口。
PathString/重定向的路径。
StatusCodeString301重定向状态码。

请求示例

GET /?Action=DescribeRules&Version=2020-04-01&ListenerId=lsn-2fea4ayvu2g3k5oxruuz**** HTTP/1.1
Host: open.volcengineapi.com
Region: cn-beijing
Service: clb

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20210811152539010225146063030****",
        "Action": "DescribeRules",
        "Version": "2020-04-01",
        "Service": "clb",
        "Region": "cn-beijing"
    },
    "Result": {
        "RequestId": "20210811152539010225146063030****",
        "Rules": [
            {
                "RuleId": "rule-2fegss1cplxxc5oxruvvq****",
                "Domain": "abc.com",
                "Url": "/abcc",
                "ServerGroupId": "rsp-3ciynvqsspiww6c6rrsz7****",
                "Description": "TEST",
                "ActionType": "Forward"
            },
            {
                "RuleId": "rule-img9v6c9vsao8gbssz4l****",
                "Domain": "www.test.com",
                "Url": "/",
                "ServerGroupId": "",
                "Description": "111",
                "ActionType": "Redirect",
                "RedirectConfig": {
                    "Host": "",
                    "Path": "",
                    "Protocol": "HTTPS",
                    "Port": "",
                    "StatusCode": "301"
                }
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

HttpCode错误码错误信息描述

400

MissingParameter

The request is missing a required parameter. Ensure that you have supplied all the required parameters for the request; for example, the 'XXX'.

该请求缺少必要参数。请确保发起请求已提供全部必要参数，比如XXX。

说明

其中，XXX表示缺少的参数名称。

404InvalidListener.NotFoundThe specified Listener does not exist.指定的监听器不存在。