Create ALB Cluster

Create NSX ALB cluster

Request

URI

POST

https://{api_host}/v1/nsx-alb-clusters

COPY

Query Parameters

boolean

skipCompatibilityCheck

Optional

Constraints: default: false

Pass an optional Skip compatibility checks

Request Body

NsxAlbControllerClusterSpec of type(s) application/json

Required

Show optional properties

{
    "domainIds": [
        {}
    ],
    "clusterName": "string",
    "clusterFqdn": "string",
    "clusterIpAddress": "string",
    "formFactor": "One among: LARGE, MEDIUM, SMALL",
    "adminPassword": "string"
}

{
    "domainIds": [
        "string"
    ],
    "clusterName": "string",
    "clusterFqdn": "string",
    "clusterIpAddress": "string",
    "formFactor": "One among: LARGE, MEDIUM, SMALL",
    "adminPassword": "string",
    "nodes": [
        {
            "ipAddress": "string"
        }
    ],
    "bundleId": "string"
}

array of string

domainIds

Required

IDs of the workload Domains where NSX Advanced Load Balancer Cluster will be deployed

string

clusterName

Required

Constraints: minLength: 0 maxLength: 80

Name of NSX Advanced Load Balancer Cluster

string As ^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$

clusterFqdn

Required

NSX Advanced Load Balancer Cluster fully qualified domain name

string As ^([01]?\d\d?|2[0-4]\d|25[0-5])\.([01]?\d\d?|2[0-4]\d|25[0-5])\.([01]?\d\d?|2[0-4]\d|25[0-5])\.([01]?\d\d?|2[0-4]\d|25[0-5])$

clusterIpAddress

Required

NSX Advanced Load Balancer Cluster Virtual IPv4 address of format 'x.x.x.x'

string As (LARGE|MEDIUM|SMALL)

formFactor

Required

Size of NSX ALB cluster

string

adminPassword

Required

Admin user password of NSX Advanced Load Balancer Cluster

array of object

nodes

Optional

Constraints: minItems: 3 maxItems: 3

NSX Advanced Load Balancer Cluster Controller Nodes

string

bundleId

Optional

NSX Advanced Load Balancer Bundle ID

Responses

202

Returns Task of type(s) application/json

"Task Object"

string

Required

Task ID

string

name

Required

Task name

object

localizableDescriptionPack

Optional

A message pack representing a localizable message and suitable for machine processing. Contains a message key unique in the scope of the specified component, as well as the arguments needed to generate the localized message.

string

type

Optional

Operation that is represented by the Task in machine readable format. The value is controlled by the owners/producers of the Task. The convention is _

string

status

Required

Task status

string

creationTimestamp

Required

Task creation timestamp

string

completionTimestamp

Optional

Task completion timestamp

array of object

subTasks

Optional

List of sub-tasks of the task

array of object

errors

Optional

List of errors in case of a failure

array of object

resources

Optional

List of resources associated with task

string

resolutionStatus

Optional

Resolution state

boolean

isCancellable

Optional

Represents task can be cancellable or not.

boolean

isRetryable

Optional

Indicates whether a task is eligible for retry or not.

400

Bad Request

Returns Error of type(s) application/json

"Error Object"

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

array of string

arguments

Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object

context

Optional

The error context (e.g. the component where it occurred).

string

message

Optional

The localized error message

string

remediationMessage

Optional

The localized remediation error message

array of object

causes

Optional

The underlying cause exceptions.

array of Error

nestedErrors

Optional

The nested errors when the error is a composite one

string

referenceToken

Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

500

InternalServerError

Returns Error of type(s) application/json

"Error Object"

string

errorCode

Optional

The minor error code

string

errorType

Optional

The error type

array of string

arguments

Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object

context

Optional

The error context (e.g. the component where it occurred).

string

message

Optional

The localized error message

string

remediationMessage

Optional

The localized remediation error message

array of object

causes

Optional

The underlying cause exceptions.

array of Error

nestedErrors

Optional

The nested errors when the error is a composite one

string

referenceToken

Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"adminPassword:"string","clusterFqdn:"string","clusterIpAddress:"string","clusterName:"string","domainIds":["string"],"formFactor:"string"}' https://{api_host}/v1/nsx-alb-clusters

On This Page

Description

Request

Query Parameters

Request Body

Response

202 Response Body

Errors

Nsx Albclusters Operations

GET

Get ALB Clusters

POST