DescribeRules--负载均衡-火山引擎

文档中心

立即注册

导航

DescribeRules

最近更新时间：2024.10.21 14:07:13首次发布时间：2021.08.31 10:37:28

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

调试

API Explorer

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

去调试

请求参数

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

返回参数

名称	类型	示例值	描述
RequestId	String	20210811152539010225146063030****	请求ID。
Rules	Array of Struct	-	符合条件的转发规则的详细信息。具体请参见下表“Rules”。

Rules

名称	类型	示例值	描述
RuleId	String	rule-2fegss1cplxxc5oxruvvq****	转发规则ID。
Domain	String	www.test.com	转发规则的域名。
Url	String	/	转发规则的URL。
ServerGroupId	String	rsp-2fel9y8pxr56o5oxruuuu****	转发规则关联的后端服务器组ID。
Description	String	rule1	转发规则的描述。
ActionType	String	Redirect	转发规则的转发动作。 Forward：转发至。 Redirect：重定向至。
RedirectConfig	Array of Struct	-	重定向相关配置信息。具体参见下表“RedirectConfig”。说明仅当`ActionType`取值为`Redirect`时，返回该参数。

RedirectConfig

名称	类型	示例值	描述
Protocol	String	HTTP	重定向的协议。
Host	String	www.test.com	重定向的域名。
Port	String	80	重定向的端口。
Path	String	/	重定向的路径。
StatusCode	String	301	重定向状态码。

请求示例

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	错误码	错误信息	描述
404	InvalidListener.NotFound	The specified Listener does not exist.	指定的监听器不存在。