CreateLoadBalancerVIPs

1. API Description

The API is used to create one or more IPs to be associated with a load balancer.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name
Required
Type
Description

loadBalancerId

Yes

String

Load balancer instance ID.

count

Yes

Integer

Quantity of IPs to be associated. Only the IP type supported by the load balancer is available.

3. Output Parameters

Parameter Name
Type
Description

requestId

String

The unique request ID, which is returned for each request. RequestId is required for locating a problem.

orderNumber

String

Number of order. For a load balancer working with IPv6 addresses, the value is empty.

vipIdSet

Array of String

Information on IP IDs.

4. Code Example

Create VIPs to be associated with a load balancer.

POST / HTTP/1.1
Host: console.harmonynetworks.net/api/v2/bmc
Content-Type: application/json
X-ZC-Action: CreateLoadBalancerVIPs
<Common Request Params>

Request:
{
  "loadBalancerId": "xxxx",
  "count": 2
}

Response:
{
  "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
  "response": {
    "requestId": "TEEFDCA5B-76FB-4E91-A18E-DF7F5D2CE41F",
    "orderNumber": "xxxx",
    "ipIdSet": ["xxxx","xxxx"]
  }
}

5. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.​

Last updated