更新时间:2024-04-08 GMT+08:00

创建负载均衡器(废弃)

功能介绍

创建负载均衡器。

URI

POST /v1.0/{project_id}/elbaas/loadbalancers

表1 参数说明

参数

是否必选

参数类型

描述

project_id

String

操作用户的项目ID。

请求消息

  • 请求参数
    表2 请求参数

    参数

    是否必选

    参数类型

    描述

    name

    String

    • 负载均衡器的名称。
    • 取值范围:1-64个字符,中英文、数字、下划线、中划线。

    description

    String

    • 描述。
    • 取值范围:0-128个字符,不能输入<>。

    vpc_id

    String

    vpc的ID。

    bandwidth

    Integer

    • 带宽大小。type为External时该字段必选,type为Internal时无效。
    • 取值范围:默认1Mbit/s~1000Mbit/s

      (具体范围以各Region配置为准,请参见控制台对应页面显示)。

    type

    String

    • 负载均衡器的类型,私网还是公网。
    • 取值范围: Internal或External。

    admin_state_up

    Integer/Boolean

    • 弹性负载均衡器的管理状态,
    • 取值范围:

      0或false:停用。该值只支持由用户传入。

      1或true:正常。

      2或false:冻结。该值只支持由管理员传入。

    vip_subnet_id

    String

    要加入的私网ID,type为Internal时该字段必选,type为External时无效。只支持指定为ipv4的子网。

    az

    String

    type为External时该字段无效,type为Internal时该字段可选。type为Internal时,若指定az,则指定的az必须要支持私网elb,否则返回错误信息。有关公有云的区域和终端节点的更多信息,请参阅地区和终端节点

    charge_mode

    String

    • 该参数为预留字段,支持流量计费后设置此字段,则弹性IP将采用流量统计模式。
    • 取值范围:bandwidth、traffic。
    • 取值范围:取值为traffic。

    eip_type

    String

    • 该参数为预留字段

    security_group_id

    String

    • 字段含义:安全组的ID。
    • 取值范围:1到200个字节,字符串由大小写字母、数字和中划线组合。
    • 说明:参数type的值为Internal时,该字段为必选字段;参数type的值为External,该字段会被忽略。

    vip_address

    String

    • 字段含义:ELB提供服务的IP。参数type的值为External时,该字段为弹性IP;参数type的值为Internal时,该字段为私网IP。
    • 用户可以选择已有弹性IP创建公网ELB。当传此参数时,bandwidth、charge_mode以及eip_type没有意义,不需要再传这些参数。

    tenantId

    String

    • 字段含义:操作用户的项目ID。
    • 说明:参数type的值为Internal时,该字段为必选字段。
  • 请求样例1
    {
        "name": "loadbalancer1",
        "description": "simple lb",
        "vpc_id": "f54a3ffd-7a55-4568-9e3d-f0ff2d46a107",
        "bandwidth": 200,
        "type": "External",
        "admin_state_up": true
    }
  • 请求样例2
    {
        "name": "loadbalancer1",
        "description": "simple lb",
        "vpc_id": "f54a3ffd-7a55-4568-9e3d-f0ff2d46a107",
        "vip_address": "192.144.164.74",
        "type": "External",
        "admin_state_up": true
    }

响应消息

  • 响应参数
    表3 响应参数

    参数

    参数类型

    描述

    uri

    String

    创建ELB这个任务下发成功后,组合API返回该任务的URI。

    job_id

    String

    组合API唯一标识创建ELB这个任务的任务号。

  • 响应样例
    {
        "uri": "/v1/73cd9140bec7427ab9952b4ed75924e0/jobs/4010b39b4fbb4645014fcfc8f2d178d1",
        "job_id": "4010b39b4fbb4645014fcfc8f2d178d1"
    }

状态码

  • 正常

    200

  • 异常

    状态码

    编码

    错误码说明

    400

    badRequest

    请求错误

    401

    unauthorized

    鉴权失败

    403

    userDisabled

    没有权限

    404

    Not Found

    请求的页面不存在

    500

    authFault

    内部错误

    503

    serviceUnavailable

    服务不可用