You need to enable JavaScript to run this app.
导航
边缘计算节点
  • 文档首页
    • /边缘计算节点/边缘计算节点/API 参考/七层负载均衡/获取转发路径列表
获取转发路径列表
最近更新时间：2024.07.18 11:03:33首次发布时间：2024.07.02 10:22:48
我的收藏

本接口用于获取转发路径的列表。

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是ListRulePath接口名称。当前 API 的名称为 ListRulePath。
VersionString是2021-04-30接口版本。当前 API 的版本为 2021-04-30。

Body

参数类型是否必选示例值描述
lb_identityString是veew-lb79442102222490330****负载均衡实例的 ID。您可以调用 ListLB7Instances 接口查询负载均衡实例的 ID。
rule_identityString否res-0094030018300329****转发规则的 ID。您可以调用 ListRule 接口查询转发规则的 ID。
paginationPagination否见下文说明分页查询配置。

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：按照升序排列。

返回参数

参数类型示例值描述
path_list[]PathList见下文说明转发路径的列表。
total_countLong2转发路径的数量。

PathList

参数类型示例值描述
identityStringres-6303301011212010****转发路径 ID。
pathString/path转发路径。
rs_groupRsGroup见下文说明后端服务器组的信息。

RsGroup

参数类型示例值描述
identityStringres-0990754908540871****后端服务器组的 ID。
nameStringdefault后端服务器组的名称。该名称由系统自动生成。

loadbalance_strategy

String

wrr

负载均衡策略：

  • wrr：轮询。
  • wlc：最小连接数。
  • sh：源IP一致性哈希。
  • sph：源IP+端口一致性哈希。
health_checkHealthCheck见下文说明健康检查配置。
sticky_sessionStickySession见下文说明会话保持配置。
rs_list[]RsList见下文说明后端服务器的列表。

HealthCheck

参数类型示例值描述

protocol

String

HTTP

健康检查协议：

  • TCP
  • HTTP

port

Integer

80

健康检查端口。
如果返回值为 0，代表使用后端服务器端口作为健康检查端口。

intervalInteger2健康检查间隔。
response_timeoutInteger5响应超时时间。
unhealth_thresholdInteger3不健康阈值，即连续健康检查失败的次数上限。超过这个阈值，后端服务器将被认定为异常，然后会被从服务器池中移除。
health_thresholdInteger3健康阈值，即连续健康检查成功的次数上限。超过这个阈值，后端服务器将被认定为正常，然后会被重新添加到服务器池。

http_host

String

www.example.com

健康检查域名。

说明

该参数仅适用于 HTTP 健康检查。

http_path

String

/test

检查路径。

说明

该参数仅适用于 HTTP 健康检查。

http_success_codes

String

Code2xx

表示健康检查成功的状态码。

说明

该参数仅适用于 HTTP 健康检查。

http_method_type

String

GET

健康检查方法。

说明

该参数仅适用于 HTTP 健康检查。

http_version

String

1.1

HTTP 协议版本。

说明

该参数仅适用于 HTTP 健康检查。

StickySession

参数类型示例值描述

cookie_deal_type

Integer

1

Cookie 处理方式。取值范围：

  • 1：植入Cookie。负载均衡实例收到来自客户端的首次请求时，会根据调度算法选择一个后端服务器，并在响应中植入Cookie（即在HTTP或HTTPS响应报文中插入SERVERID）。当后续的客户端请求携带此Cookie时，负载均衡实例会将请求转发给对应的后端服务器。
  • 2：重写Cookie。用户可以自定义Cookie。当负载均衡实例发现用户自定义了Cookie时，会对原来的Cookie进行改写。当后续的客户端请求携带改写后的Cookie时，负载均衡实例会将请求转发给对应的后端服务器。
cookie_timeoutInteger120会话保持超时时间。单位：秒。
cookie_nameStringcustomCookie 名称。

RsList

参数类型示例值描述
identityStringveen1283900037022992****后端服务器的 ID。
nameStringveen01后端服务器的名称。
portInteger80后端服务器的端口。
weightInteger50后端服务器的权重。单位：%。

healthy_status

Boolean

true

后端服务器的健康状态：

  • true：正常。
  • false：异常。

enable

Boolean

true

后端服务器是否已启用：

  • true：已启用。
  • false：已禁用。
    启用后端服务器后，负载均衡将根据域名及权重转发流量至该后端服务器。禁用后端服务器后，负载均衡将不再转发任何流量至该后端服务器。
internal_ipv4String192.**.**.2后端服务器的私网 IPv4 地址。
internal_ipv6Stringfdbd:dc04:**:**::139后端服务器的私网 IPv6 地址。

请求示例

POST https://veenedge.volcengineapi.com/?Action=ListRulePath&Version=2021-04-30
{
    "lb_identity": "veew-lb70204100444012074****",
    "rule_identity": "res-0444414400190294****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240619153414192F2BCF1FFD6800****",
        "Action": "ListRulePath",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "path_list": [
            {
                "identity": "res-0106212001614949****",
                "path": "/test",
                "custom_header": null,
                "custom_param": null,
                "custom_retry_list": null,
                "rs_group": {
                    "identity": "res-9011226100624420****",
                    "name": "default",
                    "loadbalance_strategy": "wrr",
                    "health_check": {
                        "protocol": "HTTP",
                        "port": 80,
                        "interval": 2,
                        "response_timeout": 5,
                        "unhealth_threshold": 3,
                        "health_threshold": 3,
                        "http_host": "www.example.com",
                        "http_path": "/test",
                        "http_success_codes": "Code2xx",
                        "http_method_type": "GET",
                        "http_version": "1.1"
                    },
                    "sticky_session": {
                        "cookie_deal_type": 1,
                        "cookie_timeout": 120,
                        "cookie_name": null
                    },
                    "rs_list": [
                        {
                            "identity": "veen0642211172016766****",
                            "name": "test-lb7",
                            "internal_ip": null,
                            "port": 80,
                            "weight": 50,
                            "healthy_status": true,
                            "enable": true,
                            "internal_ipv4": "192.**.**.2",
                            "internal_ipv6": ""
                        }
                    ]
                }
            }
        ],
        "total_count": 1
    }
}

错误码

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