获取转发规则列表--边缘计算节点-火山引擎

文档中心

立即注册

导航

获取转发规则列表

最近更新时间：2024.07.18 11:03:33首次发布时间：2024.07.02 10:22:48

本接口用于获取一个监听器下的转发规则的列表。

请求说明

请求方式：POST
请求地址：https://veenedge.volcengineapi.com/?Action=ListRule&Version=2021-04-30

请求参数

下表列出了接口特定的请求参数以及公共请求参数 Action 和 Version。其他公共参数，请参见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListRule`	接口名称。当前 API 的名称为 `ListRule`。
Version	String	是	`2021-04-30`	接口版本。当前 API 的版本为 `2021-04-30`。

Body

参数	类型	是否必选	示例值	描述
lb7_identity	String	是	`veew-lb79442102222490330****`	负载均衡实例的 ID。您可以调用 ListLB7Instances 接口查询负载均衡实例的 ID。
listener_identity	String	是	`res-0094030018300329****`	监听器的 ID。您可以调用 ListLB7Listener 接口查询监听器的 ID。
name	String	否	`rule-01`	转发规则的名称。支持模糊查询。
pagination	Pagination	否	`见下文说明`	分页查询配置。

Pagination

参数类型是否必选示例值描述

参数	类型	是否必选	示例值	描述
page	Integer	否	`1`	转发规则列表的页码。如果 page 和 limit 参数都不指定，将返回全量数据；如果仅指定 limit，不指定 page ，将返回第 1 页数据；如果仅指定 page，不指定 limit，将返回全量数据；如果 page 和 limit 都指定，将返回符合条件的数据。
limit	Integer	否	`10`	分页查询时设置的每页行数。如果 page 和 limit 参数都不指定，将返回全量数据；如果仅指定 limit，不指定 page ，将返回第 1 页数据；如果仅指定 page，不指定 limit，将返回全量数据；如果 page 和 limit 都指定，将返回符合条件的数据。
order_by	Integer	否	`1`	查询出来的转发规则的排列顺序，按照创建时间排序。取值范围： 1（默认值）：按照降序排列。 2：按照升序排列。

page

Integer

否

1

转发规则列表的页码。
如果 page 和 limit 参数都不指定，将返回全量数据；如果仅指定 limit，不指定 page ，将返回第 1 页数据；如果仅指定 page，不指定 limit，将返回全量数据；如果 page 和 limit 都指定，将返回符合条件的数据。

limit

Integer

否

10

分页查询时设置的每页行数。
如果 page 和 limit 参数都不指定，将返回全量数据；如果仅指定 limit，不指定 page ，将返回第 1 页数据；如果仅指定 page，不指定 limit，将返回全量数据；如果 page 和 limit 都指定，将返回符合条件的数据。

order_by

Integer

否

1

查询出来的转发规则的排列顺序，按照创建时间排序。取值范围：

1（默认值）：按照降序排列。
2：按照升序排列。

返回参数

参数	类型	示例值	描述
forwarding_rule_list	[]ForwardingRuleList	`见下文说明`	转发规则的列表。
total_count	Long	`2`	转发规则的数量。

ForwardingRuleList

参数	类型	示例值	描述
identity	String	`res-6226330220230000****`	转发规则的 ID。
name	String	`rule_01`	转发规则的名称。
enable	Boolean	`true`	转发规则是否已启用： true：转发规则已启用。 false：转发规则已禁用。
domain	String	`www.example.com`	域名。
ssl_type	Integer	`1`	SSL 解析方式： 1：单向认证。仅验证服务器身份。 2：双向认证。验证服务器身份和客户端身份。说明该参数仅适用于 HTTPS 监听器。
client_cert_ref	String	`cert-f8791e48c42e4f199b7d70be4****`	客户端 CA 证书的 ID。说明该参数仅适用于 HTTPS 监听器。
custom_param	CustomParam	`见下文说明`	自定义参数。说明该参数仅适用于以下场景：后端服务器为边缘容器。
custom_retry_list	[]CustomRetryList	`见下文说明`	自定义重试规则。说明该参数仅适用于以下场景：后端服务器为边缘容器。
server_cert_ref_list	[]String	`[cert-f8791e48c42e4f199b7d70be4****]`	服务器证书的 ID。说明该参数仅适用于 HTTPS 监听器。
create_time	Long	`1635327375`	转发规则的创建时间，以 UNIX 时间戳形式显示。单位：秒。
update_time	Long	`1635327375`	转发规则的更新时间，以 UNIX 时间戳格式显示。单位：秒。

CustomParam

参数类型示例值描述

proxy_body_size String 1024k 代理服务器接收的请求体大小。取值范围：1~1024。取值需要包含单位：k/K，m/M 或 g/G。

参数	类型	示例值	描述
proxy_body_size	String	`1024k`	代理服务器接收的请求体大小。取值范围：1~1024。取值需要包含单位：k/K，m/M 或 g/G。
ssl_buffer_size	String	`16k`	缓冲区大小。取值范围： 1~32（带单位 k/K 时） 1~1024（不带单位 k/K 时）说明该参数仅适用于 HTTPS 监听器。

ssl_buffer_size

String

16k

缓冲区大小。取值范围：

1~32（带单位 k/K 时）
1~1024（不带单位 k/K 时）

说明

该参数仅适用于 HTTPS 监听器。

CustomRetryList

参数	类型	示例值	描述
status_code	String	`500`	状态码。多个状态码之间使用半角逗号（,）分隔。最多允许 5 个状态码。取值范围：300~599。
application_identity	String	`veecc-255622122036230****`	边缘应用 ID。
workload_identity	String	`res-4201065452244652****`	工作负载 ID。
port	Integer	`80`	Service 端口。
workload_name	String	`default`	工作负载名称。

请求示例

POST https://veenedge.volcengineapi.com/?Action=ListRule&Version=2021-04-30
{
    "lb7_identity": "veew-lb70204100444012074****",
    "listener_identity": "res-4044414421464414****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202406171559116BD974DA64475301****",
        "Action": "ListRule",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "forwarding_rule_list": [
            {
                "identity": "res-424641328112144****",
                "name": "rule_01",
                "enable": true,
                "domain": "www.example.com",
                "cname": "",
                "path_list": null,
                "ssl_type": null,
                "client_cert_ref": "",
                "server_cert_ref": "",
                "custom_param": null,
                "custom_retry_list": null,
                "server_cert_ref_list": null,
                "create_time": 1718356399,
                "update_time": 1718356494
            }
        ],
        "total_count": 1
    }
}

错误码

如果响应正文中包含 Error 字段，则表示 API 请求失败。关于错误码的更多信息，参见错误码。