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

本接口用于获取负载均衡实例的列表。

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
cluster_nameString否****-zzcu01负载均衡实例所在节点的名称。
nameString否lb-test负载均衡实例的名称。支持模糊查询。
regionString否EastChina负载均衡实例所在的区域。
lb7_identityString否veew-lb72131011027612112****负载均衡实例的 ID。您可以调用 ListLB7Instances 接口查询负载均衡实例的 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：按照升序排列。

返回参数

参数类型示例值描述
lb7_list[]Lb7List见下文说明负载均衡实例的列表。
total_countLong2负载均衡实例的数量。

Lb7List

参数类型示例值描述
identityStringveew-lb72422242200104404****负载均衡实例的 ID。
nameStringlb-veen01负载均衡实例的名称。

rs_type

Integer

1

后端服务器的类型：

  • 1：边缘实例。
  • 2：边缘容器。

status

Integer

2

负载均衡实例的状态：

  • 1：变更中。
  • 2：运行中。
  • 3：删除中。

vpc_identity

String

vpc-5blrzz****

负载均衡实例所属私有网络的 ID。
该参数只适用于以下场景：后端服务器为边缘实例。

vpc_name

String

郑州联通01-默认VPC

负载均衡实例所属私有网络的名称。
该参数只适用于以下场景：后端服务器为边缘实例。

eip_type

Integer

1

负载均衡实例绑定的弹性公网 IP 的类型：

  • 1：IPv4。

billing_mode

Integer

255

带宽计费方式。
后端服务器为边缘实例：

  • 255：按照绑定的弹性公网 IP 计费。
    后端服务器为边缘容器：
  • 1：按月 95 峰值计费。
  • 2：按日峰值计费。
descStringlb-veen负载均衡实例的描述。

network_type

Integer

1

负载均衡实例的网络类型：

  • 1：公网。
eips[]Eips见下文说明绑定的弹性公网 IP 的列表。
qpsInteger2000每秒能够处理的请求的数量（QPS）。

is_empty

Boolean

false

负载均衡实例下是否存在监听器：

  • true：不存在监听器。
  • false：存在监听器。

application_identity

String

veecc-255622122036230****

边缘应用的 ID。
该参数只适用于以下场景：后端服务器为边缘容器。

application_name

String

app01

边缘应用的名称。
该参数只适用于以下场景：后端服务器为边缘容器。

create_timeLong1635327375负载均衡实例的创建时间，以 UNIX 时间戳格式显示。单位：秒。
update_timeLong1635327375负载均衡实例的更新时间，以 UNIX 时间戳格式显示。单位：秒。

clusters

[]Clusters

见下文说明

后端服务器为边缘实例时，该参数指负载均衡实例所在的节点。
后端服务器为边缘容器时，该参数指边缘应用的部署节点。

bandwidth_peak

Long

1000

带宽峰值。单位：Mbps。
该参数只适用于以下场景：后端服务器为边缘容器。

Eips

参数类型示例值描述
identityStringeip-wqjgxf****弹性公网 IP 的 ID。
eip_addrString123.**.**.158弹性公网 IP 地址。
bandwidth_peakLong500弹性公网 IP 的带宽峰值。单位：Mbps。
cluster_nameString****-zzcu01弹性公网 IP 所在的节点。

Clusters

参数类型示例值描述
cluster_nameString****-zzcu01节点的名称。
cluster_aliasString郑州联通01节点的中文名称。
regionStringCentralChina区域。
cityString330200城市。
ispStringCUCC运营商。

请求示例

POST https://veenedge.volcengineapi.com/?Action=ListLB7Instances&Version=2021-04-30
{
    "cluster_name": "**ct05"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024061817291753F12E6F6F1F1B16****",
        "Action": "ListLB7Instances",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "lb7_list": [
            {
                "identity": "veew-lb76265442116406600****",
                "name": "lb-veecc",
                "country": null,
                "region": null,
                "province": null,
                "city": null,
                "isp": null,
                "alias": null,
                "rs_type": 2,
                "status": 2,
                "vpc_identity": "",
                "vpc_name": "",
                "eip_type": 1,
                "billing_mode": 1,
                "payment_method": 0,
                "desc": "dev",
                "network_type": 1,
                "listeners": [],
                "eips": [
                    {
                        "identity": "eip-8gjhw7****",
                        "eip_addr": "9.**.**.220",
                        "bandwidth_peak": 1000,
                        "cluster_name": "**ct05",
                        "name": null,
                        "eip_type": null,
                        "region": null,
                        "city": null,
                        "isp": null,
                        "cluster_alias": null,
                        "status": null
                    }
                ],
                "qps": 2000,
                "is_empty": false,
                "application_identity": "veecc-1362132470401420****",
                "application_name": "test-lb7",
                "create_time": 1718351206,
                "update_time": 1718623423,
                "clusters": [
                    {
                        "cluster_name": "**ct05",
                        "cluster_alias": "**电信05",
                        "region": "EastChina",
                        "city": "330200",
                        "isp": "CTCC"
                    }
                ],
                "bandwidth_peak": 1000
            },
            {
                "identity": "veew-lb71170205630412571****",
                "name": "lb-veen",
                "country": null,
                "region": null,
                "province": null,
                "city": null,
                "isp": null,
                "alias": null,
                "rs_type": 1,
                "status": 2,
                "vpc_identity": "vpc-bq4nzx****",
                "vpc_name": "**ct05-默认VPC",
                "eip_type": 1,
                "billing_mode": 255,
                "payment_method": 0,
                "desc": "",
                "network_type": 1,
                "listeners": [],
                "eips": [
                    {
                        "identity": "eip-c5mq7w****",
                        "eip_addr": "9.**.**.192",
                        "bandwidth_peak": 50,
                        "cluster_name": "**ct05",
                        "name": null,
                        "eip_type": null,
                        "region": null,
                        "city": null,
                        "isp": null,
                        "cluster_alias": null,
                        "status": null
                    }
                ],
                "qps": 2000,
                "is_empty": false,
                "application_identity": "",
                "application_name": "",
                "create_time": 1718337457,
                "update_time": 1718463753,
                "clusters": [
                    {
                        "cluster_name": "**05",
                        "cluster_alias": "**电信05",
                        "region": "EastChina",
                        "city": "330200",
                        "isp": "CTCC"
                    }
                ],
                "bandwidth_peak": 0
            }
        ],
        "total_count": 2
    }
}

错误码

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