Validate ALB Cluster Creation Spec

Perform validiation of the NsxAlbControllerClusterSpec specification

Request

URI

POST

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

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

200

Returns Validation of type(s) application/json

"Validation Object"

string

Required

ID of the validation

string

description

Required

Description of the validation

string

executionStatus

Required

Execution status of the validation. One among: IN_PROGRESS, FAILED, COMPLETED, UNKNOWN, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS

string

resultStatus

Required

Result status of the validation after it has completed its execution. One among: SUCCEEDED, FAILED, FAILED_WITH_WARNINGS, UNKNOWN, CANCELLATION_IN_PROGRESS

array of object

validationChecks

Optional

List of one or more validation checks that are performed as part of the validation

object

additionalProperties

Optional

additionalProperties

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/validations

On This Page

Description

Request

Query Parameters

Request Body

Response

200 Response Body

Errors

Nsx Albclusters Operations

GET

Get ALB Clusters

POST