创建负载均衡实例--边缘计算节点-火山引擎

文档中心

立即注册

导航

边缘计算节点

创建负载均衡实例

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

本接口用于创建七层负载均衡实例。

使用说明

使用限制：

该接口创建的七层负载均衡实例的后端服务器须为边缘实例。如果您想创建的七层负载均衡实例的后端服务器为边缘容器，请使用 CreateLB7ForVeecc 接口。
一个私有网络中，只能创建一个七层负载均衡实例。
一个七层负载均衡实例最多可与 5 个弹性公网 IP 绑定。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
name	String	是	`lb-veen01`	负载均衡实例的名称。命名规则如下：允许 5~20 个字符。支持汉字、英文大小写字母、数字。支持特殊字符 ()`~!@#$%^&*-+=_\|{}[]:;'<>,.?/。 \| 不能包含双引号（"）、反斜线（ \）和空格，且不能以正斜线（/）开头。
rs_type	Integer	是	`1`	后端服务器的类型。取值范围： 1：边缘实例。
vpc_identity	String	是	`vpc-pv5vj2****`	负载均衡实例所属的私有网络的 ID。您可以通过 ListVPCInstances 接口查询私有网络 ID。
network_type	Integer	是	`1`	负载均衡实例的网络类型。取值范围： 1：公网。
eip_type	Integer	是	`1`	负载均衡实例绑定的弹性公网 IP 的类型。取值范围： 1：IPv4。
eip_identity_list	[]String	是	`["eip-6nbh6l****"]`	弹性公网 IP 的 ID 的列表。您可以通过 ListEIPInstances 接口查询弹性公网 IP 的 ID。后端服务器是边缘实例时，一个负载均衡实例最多可以绑定 5 个弹性公网IP。
qps	Integer	是	`2000`	每秒能够处理的请求的数量（QPS）。取值范围： 2000。 5000。 10000。如果您需要更高的 QPS，请提交工单进行申请。
billing_mode	Integer	否	`-`	带宽计费方式。该参数无需指定。默认传入负载均衡实例绑定的弹性公网 IP 的带宽计费方式。
payment_method	Integer	是	`1`	负载均衡实例的付费方式。取值范围： 1：后付费。
desc	String	否	`dev`	负载均衡实例的描述。最多可输入 80 个字符。

返回参数

参数	类型	示例值	描述
lb_identity	String	`veew-lb79442102222490330****`	负载均衡实例的 ID。

请求示例

POST https://veenedge.volcengineapi.com/?Action=CreateLB7&Version=2021-04-30
{
    "name": "lb-veen01",
    "rs_type": 1,
    "vpc_identity": "vpc-8w7kvb****",
    "network_type": 1,
    "eip_type": 1,
    "eip_identity_list": [
        "eip-7cjc6q****"
    ],
    "qps": 2000,
    "payment_method": 1,
    "desc": "dev"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20240614144406E1DFF8317BABF114****",
        "Action": "CreateLB7",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "lb_identity": "veew-lb7020410044401207****"
    }
}

错误码

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