華為云計(jì)算 云知識(shí) 創(chuàng)建負(fù)載均衡器CreateLoadbalancer
創(chuàng)建負(fù)載均衡器CreateLoadbalancer

 

功能介紹

創(chuàng)建私網(wǎng)類(lèi)型的 負(fù)載均衡 器。創(chuàng)建成功后,該接口會(huì)返回創(chuàng)建的負(fù)載均衡器的ID、所屬子網(wǎng)ID、負(fù)載均衡器內(nèi)網(wǎng)IP等詳細(xì)信息。

若要?jiǎng)?chuàng)建公網(wǎng)類(lèi)型的負(fù)載均衡器,還需調(diào)用創(chuàng)建浮動(dòng)IP的接口,將浮動(dòng)IP與私網(wǎng)負(fù)載均衡器的vip_port_id綁定。

可以通過(guò)設(shè)置enterprise_project_id字段,對(duì)資源進(jìn)行細(xì)粒度授權(quán)。

調(diào)試

您可以在API Explorer中直接運(yùn)行調(diào)試該接口。

URI

POST /v2/{project_id}/elb/loadbalancers

表1 參數(shù)說(shuō)明

參數(shù)

是否必選

參數(shù)類(lèi)型

描述

project_id

String

操作用戶(hù)的項(xiàng)目ID。

獲取方法詳見(jiàn)獲取項(xiàng)目ID。

請(qǐng)求消息

表2 請(qǐng)求參數(shù)

參數(shù)

是否必選

參數(shù)類(lèi)型

描述

loadbalancer

Loadbalancer object

負(fù)載均衡器對(duì)象。詳見(jiàn)表3。

表3 loadbalancer字段說(shuō)明

參數(shù)

是否必選

參數(shù)類(lèi)型

描述

name

String

負(fù)載均衡器名稱(chēng)。

支持的最大字符長(zhǎng)度:255

description

String

負(fù)載均衡器的描述信息。

支持的最大字符長(zhǎng)度:255

tenant_id

String

負(fù)載均衡器所在的項(xiàng)目ID。

支持的最大字符長(zhǎng)度:255

獲取方法詳見(jiàn)獲取項(xiàng)目ID。

需要和token中的project_id一致。

vip_subnet_id

String

負(fù)載均衡器所在的子網(wǎng)IPv4子網(wǎng)ID??赏ㄟ^(guò)查詢(xún)子網(wǎng)列表獲?。ㄗ侄问莕eutron_subnet_id)。vip_address將從該子網(wǎng)中產(chǎn)生。

只支持指定IPv4子網(wǎng)。暫不支持IPv6。

provider

String

負(fù)載均衡器的生產(chǎn)者。

取值范圍:vlb。

vip_address

String

負(fù)載均衡器的內(nèi)網(wǎng)IP。

該IP必須為vip_subnet_id字段指定的子網(wǎng)網(wǎng)段中的IP。若不指定,自動(dòng)從vip_subnet_id字段指定的子網(wǎng)網(wǎng)段中生成一個(gè)IP地址。

支持的最大字符長(zhǎng)度:64

包周期實(shí)例不支持指定IP地址,會(huì)自動(dòng)從子網(wǎng)分配。

admin_state_up

Boolean

負(fù)載均衡器的管理狀態(tài)。

該字段為預(yù)留字段,暫未啟用。默認(rèn)為true。

enterprise_project_id

String

企業(yè)項(xiàng)目ID。創(chuàng)建負(fù)載均衡器時(shí),給負(fù)載均衡器綁定企業(yè)項(xiàng)目ID。

取值范圍:帶“-”連字符的UUID格式,或者是字符串“0”?!?”表示默認(rèn)企業(yè)項(xiàng)目。

默認(rèn)值:"0"。

說(shuō)明:

關(guān)于企業(yè)項(xiàng)目ID的獲取及企業(yè)項(xiàng)目特性的詳細(xì)信息,請(qǐng)參見(jiàn)《企業(yè)管理用戶(hù)指南》。

響應(yīng)消息

表4 響應(yīng)參數(shù)

參數(shù)

參數(shù)類(lèi)型

描述

loadbalancer

Loadbalancer object

負(fù)載均衡器對(duì)象。詳見(jiàn)表5。

表5 loadbalancer字段說(shuō)明

參數(shù)

參數(shù)類(lèi)型

描述

id

String

負(fù)載均衡器ID。

project_id

String

負(fù)載均衡器所在項(xiàng)目的ID。

tenant_id

String

負(fù)載均衡器所在項(xiàng)目的ID。

支持的最大字符長(zhǎng)度:255

name

String

負(fù)載均衡器名稱(chēng)。

支持的最大字符長(zhǎng)度:255

description

String

負(fù)載均衡器的描述信息。

支持的最大字符長(zhǎng)度:255

vip_subnet_id

String

負(fù)載均衡器所在的子網(wǎng)IPv4子網(wǎng)ID。

vip_port_id

String

負(fù)載均衡器內(nèi)網(wǎng)IP對(duì)應(yīng)的端口ID。

provider

String

負(fù)載均衡器的生產(chǎn)者名稱(chēng)。

vip_address

String

負(fù)載均衡器的內(nèi)網(wǎng)IP。

支持的最大字符長(zhǎng)度:64

listeners

Array of Listeners objects

負(fù)載均衡器關(guān)聯(lián)監(jiān)聽(tīng)器ID的列表。詳見(jiàn)表6

pools

Array of Pools objects

負(fù)載均衡器關(guān)聯(lián)后端服務(wù)器組ID的列表。詳見(jiàn)表7

operating_status

String

負(fù)載均衡器的操作狀態(tài)。取值范圍:可以為ONLINE和FROZEN。

provisioning_status

String

該字段為預(yù)留字段,暫未啟用。

負(fù)載均衡器的配置狀態(tài)。取值范圍:可以為ACTIVE。

admin_state_up

Boolean

負(fù)載均衡器的管理狀態(tài)。

該字段為預(yù)留字段,暫未啟用。取值范圍:true/false。

  • true表示開(kāi)啟。
  • false表示關(guān)閉。

tags

Array

負(fù)載均衡器的標(biāo)簽列表。

created_at

String

負(fù)載均衡器的創(chuàng)建時(shí)間。

格式為UTC時(shí)間:YYYY-MM-DDTHH:MM:SS

支持的最大字符長(zhǎng)度:19

updated_at

String

負(fù)載均衡器的更新時(shí)間。

格式為UTC時(shí)間:YYYY-MM-DDTHH:MM:SS

支持的最大字符長(zhǎng)度:19

enterprise_project_id

String

企業(yè)項(xiàng)目ID。創(chuàng)建負(fù)載均衡器時(shí),給負(fù)載均衡器綁定企業(yè)項(xiàng)目ID。

取值范圍:帶“-”連字符的UUID格式,或者是字符串“0”?!?”表示默認(rèn)企業(yè)項(xiàng)目。

說(shuō)明:

關(guān)于企業(yè)項(xiàng)目ID的獲取及企業(yè)項(xiàng)目特性的詳細(xì)信息,請(qǐng)參見(jiàn)《企業(yè)管理用戶(hù)指南》。

表6 listeners字段說(shuō)明

參數(shù)

參數(shù)類(lèi)型

描述

id

String

關(guān)聯(lián)的監(jiān)聽(tīng)器id

表7 pools字段說(shuō)明

參數(shù)

參數(shù)類(lèi)型

描述

id

String

關(guān)聯(lián)的后端服務(wù)器組id

請(qǐng)求示例

  • 請(qǐng)求樣例1 創(chuàng)建私網(wǎng)負(fù)載均衡器
    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" 
        }
    }

響應(yīng)示例

  • 響應(yīng)樣例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" 
        }
    }

返回碼

請(qǐng)參見(jiàn)狀態(tài)碼。