功能介绍
创建私网类型的 负载均衡 器。创建成功后，该接口会返回创建的负载均衡器的ID、所属子网ID、负载均衡器内网IP等详细信息。
若要创建公网类型的负载均衡器，还需调用创建浮动IP的接口，将浮动IP与私网负载均衡器的vip_port_id绑定。
可以通过设置ent erp rise_project_id字段，对资源进行细粒度授权。
URI
POST /v2/{project_id}/elb/loadbalancers
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
操作用户的项目ID。 获取方法详见获取项目ID。 |
请求消息
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
否 |
String |
负载均衡器名称。 支持的最大字符长度：255 |
|
description |
否 |
String |
负载均衡器的描述信息。 支持的最大字符长度：255 |
|
tenant_id |
否 |
String |
负载均衡器所在的项目ID。 支持的最大字符长度：255 获取方法详见获取项目ID。 需要和token中的project_id一致。 |
|
vip_subnet_id |
是 |
String |
负载均衡器所在的子网IPv4子网ID。可通过查询子网列表获取（字段是neutron_subnet_id）。vip_address将从该子网中产生。 只支持指定IPv4子网。暂不支持IPv6。 |
|
provider |
否 |
String |
负载均衡器的生产者。 取值范围：vlb。 |
|
vip_address |
否 |
String |
负载均衡器的内网IP。 该IP必须为vip_subnet_id字段指定的子网网段中的IP。若不指定，自动从vip_subnet_id字段指定的子网网段中生成一个IP地址。 支持的最大字符长度：64 包周期实例不支持指定IP地址，会自动从子网分配。 |
|
admin_state_up |
否 |
Boolean |
负载均衡器的管理状态。 该字段为预留字段，暂未启用。默认为true。 |
|
enterprise_project_id |
否 |
String |
企业项目ID。创建负载均衡器时，给负载均衡器绑定企业项目ID。 取值范围：带“-”连字符的UUID格式，或者是字符串“0”。“0”表示默认企业项目。 默认值："0"。 说明：
关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。 |
响应消息
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
负载均衡器ID。 |
|
project_id |
String |
负载均衡器所在项目的ID。 |
|
tenant_id |
String |
负载均衡器所在项目的ID。 支持的最大字符长度：255 |
|
name |
String |
负载均衡器名称。 支持的最大字符长度：255 |
|
description |
String |
负载均衡器的描述信息。 支持的最大字符长度：255 |
|
vip_subnet_id |
String |
负载均衡器所在的子网IPv4子网ID。 |
|
vip_port_id |
String |
负载均衡器内网IP对应的端口ID。 |
|
provider |
String |
负载均衡器的生产者名称。 |
|
vip_address |
String |
负载均衡器的内网IP。 支持的最大字符长度：64 |
|
listeners |
||
|
pools |
||
|
operating_status |
String |
负载均衡器的操作状态。取值范围：可以为ONLINE和FROZEN。 |
|
provisioning_status |
String |
该字段为预留字段，暂未启用。 负载均衡器的配置状态。取值范围：可以为ACTIVE。 |
|
admin_state_up |
Boolean |
负载均衡器的管理状态。 该字段为预留字段，暂未启用。取值范围：true/false。
|
|
tags |
Array |
负载均衡器的标签列表。 |
|
created_at |
String |
负载均衡器的创建时间。 格式为UTC时间：YYYY-MM-DDTHH:MM:SS 支持的最大字符长度：19 |
|
updated_at |
String |
负载均衡器的更新时间。 格式为UTC时间：YYYY-MM-DDTHH:MM:SS 支持的最大字符长度：19 |
|
enterprise_project_id |
String |
企业项目ID。创建负载均衡器时，给负载均衡器绑定企业项目ID。 取值范围：带“-”连字符的UUID格式，或者是字符串“0”。“0”表示默认企业项目。 说明：
关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。 |
请求示例
- 请求样例1 创建私网负载均衡器
POST https://{Endpoint}/v2/1867112d054b427e808cc6096d8193a1/elb/loadbalancers { "loadbalancer": { "name": "loadbalancer1", "description": "simple lb", "tenant_id": "1867112d054b427e808cc6096d8193a1", "vip_subnet_id": "58077bdb-d470-424b-8c45-2e3c65060a5b", "vip_address": "10.0.0.4", "admin_state_up": true, "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2" } }
响应示例
- 响应样例1
{ "loadbalancer": { "description": "", "admin_state_up": true, "tenant_id": "1867112d054b427e808cc6096d8193a1", "project_id": "1867112d054b427e808cc6096d8193a1", "provisioning_status": "ACTIVE", "vip_subnet_id": "58077bdb-d470-424b-8c45-2e3c65060a5b", "listeners": [], "vip_address": "10.0.0.4", "vip_port_id": "519f6af5-74aa-4347-9dba-84c440192877", "provider": "vlb", "pools": [], "tags": [], "id": "b0657373-0c68-41d1-980f-1a44d9e3ff01", "operating_status": "ONLINE", "name": "loadbalancer1", "created_at": "2018-07-25T01:54:13", "updated_at": "2018-07-25T01:54:14", "enterprise_project_id": "0aad99bc-f5f6-4f78-8404-c598d76b0ed2" } }
返回码
请参见状态码。
