Creating a Load Balancer

Function

This API is used to create a private network load balancer. After the load balancer is created, its details, such as load balancer ID, IP address, and subnet ID, are returned.

To create a public network load balancer, you also need to call the API for assigning an EIP and associate this IP address to the port bound to the IP address of the private network load balancer.

You can set the enterprise_project_id parameter to perform fine-grained authorization for resources.

URI

POST /v2/{project_id}/elb/loadbalancers

Request

Response

Example Request

• Example request 1: Creating a private network load balancer

  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" 
      }
  }

• Example request 2: Creating a public network load balancer

  (Bind an EIP to the port that has been bound to the load balancer's private IP address. For details about the parameters, see Table 8.)

  Table 8 Request parameters

  Parameter	Mandatory	Type	Description
  publicip	Yes	Object	Specifies the EIP. For details, see Table 9.
  bandwidth	Yes	Object	Specifies the bandwidth. For details, see Table 10.
  enterprise_project_id	No	String	Specifies the enterprise project ID. The value is 0 or a UUID that can contain a maximum of 36 characters, including hyphens (-). When assigning an EIP, you need to bind an enterprise project ID to the EIP. If this parameter is not specified, the default value is 0. NOTE: For more information about enterprise projects and how to obtain enterprise project IDs, see Enterprise Management User Guide.

  Table 9 publicip parameter description

  Parameter	Mandatory	Type	Description
  type	Yes	String	Specifies the EIP type. Note: The configured value must be supported by the system. publicip_id is an IPv4 port. If publicip_type is not specified, the default value is 5_bgp.
  ip_version	No	Integer	Specifies the EIP version. The value can be 4 and 6. 4 indicates an IPv4 address, and 6 indicates an IPv6 address. Note: The configured value must be supported by the system. If this parameter is left blank or is an empty string, an IPv4 address is assigned by default.
  ip_address	No	String	Specifies the EIP to be assigned. The system automatically assigns an EIP if you do not specify it. The value must be a valid IPv4 address in the available IP address range.

  Table 10 bandwidth parameter description

  Parameter	Mandatory	Type	Description
  name	Yes	String	Specifies the bandwidth name. The value can contain 1 to 64 characters that can contain letters, digits, underscores (_), hyphens (-), and periods (.). This parameter is mandatory when share_type is set to PER. This parameter will be ignored when share_type is set to WHOLE with an ID specified.
  size	Yes	Integer	Specifies the bandwidth (Mbit/s). The value ranges from 1 to 3001 to 100 by default. (The range may vary depending on the configuration in each region. You can see the bandwidth range of each region on the management console.) This parameter is mandatory when share_type is set to PER. This parameter will be ignored when share_type is set to WHOLE with an ID specified. The minimum unit for bandwidth adjustment varies depending on the bandwidth range. The details are as follows: The minimum increment is 1 Mbit/s if the allowed bandwidth ranges from 0 to 300 Mbit/s. The minimum increment is 50 Mbit/s if the allowed bandwidth ranges from 301 Mbit/s to 1000 Mbit/s. The minimum increment is 500 Mbit/s if the allowed bandwidth is greater than 1000 Mbit/s.
  id	No	String	Specifies the bandwidth ID. You can specify an existing shared bandwidth when assigning an EIP. The value can be the ID of the shared bandwidth whose type is set to WHOLE.
  share_type	Yes	String	Specifies the bandwidth type. The value is PER, indicating that the bandwidth is dedicated.
  charge_mode	No	String	If the value is traffic, the bandwidth is billed by traffic.

  • Step 1: Apply for an EIP.

    POST https://{VPCEndpoint}/v1/8b7e35ad379141fc9df3e178bd64f55c/publicips
    
    {
        "publicip": {
            "type": "5_bgp",
            "ip_version": 4
        },
        "bandwidth": {
            "name": "bandwidth123",
            "size": 10,
            "share_type": "PER"
        }
    }

  • Example response

    {
        "publicip": {
            "id": "f588ccfa-8750-4d7c-bf5d-2ede24414706",
            "status": "PENDING_CREATE",
            "type": "5_bgp",
            "public_ip_address": "139.9.204.183",
            "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
            "ip_version": 4,
            "create_time": "2019-06-29 06:45:32",
            "bandwidth_size": 1
            
        }
    }

  • Step 2: Bind the EIP. (The value of public_id is the same as that in the ▪ Example response, and the value of port_id is the same as that of vip_port_id in Example response 1.)

    PUT /v1/8b7e35ad379141fc9df3e178bd64f55c/publicips/f588ccfa-8750-4d7c-bf5d-2ede24414706
    
    {
        "publicip": {
            "port_id": "a7ecbdb5-5a63-41dd-a830-e16c0a7e04a7"
        }
    }

  • Example response

    {
      "publicip": {
        "id": "f588ccfa-8750-4d7c-bf5d-2ede24414706",
        "status": "ACTIVE",
        "type": "5_bgp",
        "port_id": "a7ecbdb5-5a63-41dd-a830-e16c0a7e04a7",
        "public_ip_address": "139.9.204.183",
        "private_ip_address": "192.168.1.131",
        "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
        "create_time": "2019-06-29 07:33:18",
        "bandwidth_size": 1,
        "ip_version": 4
      }
    }

  • After the preceding steps are complete, the load balancer has the capability of accessing the public network. You can access the load balancer using 139.9.204.183, the value of parameter public_ip_address.

Example Response

• Example response 1

  {
      "loadbalancer": {
          "description": "",
          "admin_state_up": true,
          "tenant_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" 
      }
  }

• Example response 2

  {
    "publicip": {
      "id": "f588ccfa-8750-4d7c-bf5d-2ede24414706",
      "status": "ACTIVE",
      "type": "5_bgp",
      "port_id": "a7ecbdb5-5a63-41dd-a830-e16c0a7e04a7",
      "public_ip_address": "139.9.204.183",
      "private_ip_address": "192.168.1.131",
      "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c",
      "create_time": "2019-06-29 07:33:18",
      "bandwidth_size": 1,
      "ip_version": 4
    }
  }

  After the preceding steps are complete, the load balancer has the capability of accessing the public network. You can access the load balancer using 139.9.204.183, the value of parameter public_ip_address.

Status Code

For details, see Status Codes.