You need to enable JavaScript to run this app.
导航

DescribeRules

最近更新时间2023.11.16 15:51:42

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

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

调试

请求参数

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

返回数据

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

Rules

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

请求示例

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"
            }
        ]
    }
}

错误码

此处仅展示当前API的错误码,更多错误码请参见公共错误码

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.指定的监听器不存在。