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

文档中心

立即注册

导航

边缘计算节点

创建公网负载均衡实例

最近更新时间：2024.08.28 18:01:47首次发布时间：2022.02.25 18:58:31

本接口用于创建公网负载均衡实例。

使用说明

前提条件：

您已创建弹性公网 IP，且弹性公网 IP 未绑定任何云资源。

使用限制：

该接口创建的负载均衡实例的后端服务器须为边缘实例。
一个私有网络中，默认仅支持创建一个四层负载均衡实例。
后端服务器是边缘实例时，一个负载均衡实例最多可与 5 个弹性公网 IP 绑定。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	CreateLB	公共参数。该参数表示接口名称。取值：CreateLB。
Version	String	是	2021-04-30	公共参数。该参数表示接口版本。取值：2021-04-30。

Body

参数	类型	是否必选	示例值	描述
name	String	是	lb-test	负载均衡实例的名称。命名规则如下：允许 5~20 个字符。支持中文、大写字母、小写字母、数字。支持特殊字符 ()`~!@#$%^&*-+=_\|{}[]:;'<>,.?/。 \| 不能包含双引号（"）、反斜线（ \）和空格，且不能以正斜线（/）开头。
vpc_identity	String	是	vpc-sbjngs****	负载均衡实例所属的私有网络的 ID。您可以通过 ListVPCInstances 接口查询私有网络 ID。
ip_identities	[]String	是	["eip-wqjgxfh****"]	弹性公网 IP 的 ID 的列表。您可以通过 ListEIPInstances 接口查询弹性公网 IP 的 ID。
lb_type	String	是	IPv4	负载均衡实例的公网类型。取值范围： IPv4：IPv4 实例。 IPv4,IPv6：IPv4/IPv6 双栈实例。
desc	String	否	Description of testing	负载均衡实例的描述。最多可输入 256 个字符。
billing_method	String	否	MonthlyPeak	计费方式。取值范围： MonthlyPeak：按月计费。该参数值仅针对以下火山引擎账号有效：未开启基于负载均衡实例规格计费。对于此类账号，该参数的默认值为MonthlyPeak。 Monthly：按月计费。该参数值仅针对以下火山引擎账号有效：已开启基于负载均衡实例规格计费。对于此类账号，该参数的默认值为Monthly。
package_name	String	是	lb_standard1	负载均衡实例的规格。取值范围： lb_standard1：标准型1。 lb_standard2：标准型2。 lb_advanced1：高阶型1。 lb_advanced2：高阶型2。 lb_super1：超强型1。 lb_super2：超强型2。说明该参数值仅针对以下火山引擎账号有效：已开启基于负载均衡实例规格计费。关于负载均衡实例规格的更多信息，请参考四层负载均衡概述。如需使用超强型1和超强型2规格的实例，请提交工单申请。

返回参数

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

请求示例

POST https://veenedge.volcengineapi.com/?Action=CreateLB&Version=2021-04-30
&<其他公共参数>
{
  "name": "lb-test",
  "vpc_identity": "vpc-sbjngs****",
  "ip_identities": [
    "eip-wqjgxf****"
  ],
  "lb_type": "IPv4",
  "package_name": "lb_standard1"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230530184650FDB50A934948C3DE****",
        "Action": "CreateLB",
        "Version": "2021-04-30",
        "Service": "veenedge",
        "Region": "cn-north-1"
    },
    "Result": {
        "lb_identity": "veew-lb2063021453005555****"
    }
}

错误码

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