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

文档中心

立即注册

导航

边缘计算节点

创建私网负载均衡实例

最近更新时间：2024.11.29 15:37:36首次发布时间：2024.02.04 17:16:42

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

说明

当前，如需使用私网负载均衡功能，请提交工单进行申请。

使用说明

使用限制：

后端服务器类型只能是边缘实例。
单个私网负载均衡实例只能拥有一个私网IP地址。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
name	String	是	lb-test	负载均衡实例的名称。命名规则如下：允许 5~256 个字符。支持中文、大写字母、小写字母、数字。支持特殊字符 ()`~!@#$%^&*-+=_\|{}[]:;'<>,.?/。 \| 不能包含双引号（"）、反斜线（ \）和空格，且不能以正斜线（/）开头。
vpc_identity	String	是	vpc-sbjngs****	负载均衡实例所属的私有网络的 ID。您可以通过 ListVPCInstances 接口查询私有网络 ID。
subnet_identity	String	否	subnet-2nngjr468x****	负载均衡实例所属的子网的 ID：当负载均衡实例归属于一个默认私有网络时，您无需指定该参数。系统会自动分配一个子网。当负载均衡实例归属于一个自定义私有网络时，您必须指定该参数。
desc	String	否	Description of testing	负载均衡实例的描述。最多可输入 256 个字符。
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_type	String	是	IPv4	负载均衡实例的 IP 类型。取值范围： IPv4

返回参数

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

请求示例

POST https://veenedge.volcengineapi.com/?Action= CreateIntraTobLB&Version=2021-04-30
&<其他公共参数>
{
  "name": "lb-test",
  "vpc_identity": "vpc-sbjngs****",
  "lb_type": "IPv4",
  "subnet_identity":"subnet-2nngjr468x****",
  "package_name": "lb_standard1"
}

返回示例

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

错误码

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