Create Avi Lb Cloud Account Async

Create an AVI Load Balancer cloud account

Create an AVI Load Balancer cloud account in the current organization

Request

URI

POST

https://vcfa-10-162-161-9.vcfd.broadcom.net/iaas/api/cloud-accounts-avilb

COPY

Query Parameters

string

apiVersion

Required

The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about

Request Body

Cloud account AVI Load Balancer specification

CloudAccountAviLbSpecification of type(s) application/json

Required

Show optional properties

{
    "name": "string",
    "hostName": "avilb.mycompany.com",
    "username": "[email protected]",
    "password": "cndhjslacd90ascdbasyoucbdh",
    "regions": [
        {
            "name": "europe-west2",
            "externalRegionId": "europe-west2"
        }
    ]
}

{
    "name": "string",
    "description": "string",
    "hostName": "avilb.mycompany.com",
    "username": "[email protected]",
    "password": "cndhjslacd90ascdbasyoucbdh",
    "acceptSelfSignedCertificate": false,
    "tags": [
        {
            "key": "env",
            "value": "dev"
        }
    ],
    "certificateInfo": {
        "certificate": "-----BEGIN CERTIFICATE-----\nMIIDHjCCAoegAwIBAgIBATANBgkqhkiG9w0BAQsFADCBpjEUMBIGA1UEChMLVk13\nYXJlIEluYAAc1pw18GT3iAqQRPx0PrjzJhgjIJMla\n/1Kg4byY4FPSacNiRgY/FG2bPCqZk1yRfzmkFYCW/vU+Dg==\n-----END CERTIFICATE-----\n-"
    },
    "cloudAccountProperties": {
        "cloud": "cloud-vsphere-connector",
        "tenant": "mytenant",
        "apiVersion": "22.0.1"
    },
    "createDefaultZones": false,
    "regions": [
        {
            "name": "europe-west2",
            "externalRegionId": "europe-west2"
        }
    ]
}

string

name

Required

A human-friendly name used as an identifier in APIs that support this option.

string

description

Optional

A human-friendly description.

string

hostName

Required

Host name for the AVI Load Balancer endpoint

string

username

Required

Username to authenticate with the cloud account

string

password

Required

Password for the user used to authenticate with the cloud Account

boolean

acceptSelfSignedCertificate

Optional

Accept self signed certificate when connecting.

array of object

tags

Optional

A set of tag keys and optional values to set on the Cloud Account

object

certificateInfo

Optional

Specification for certificate for a cloud account.

object

cloudAccountProperties

Optional

Cloud Account specific properties supplied in as name value pairs

boolean

createDefaultZones

Optional

Create default zones for the enabled regions

array of object

regions

Required

A set of regions to enable provisioning on.Refer to /iaas/api/cloud-accounts/region-enumeration.

Authentication

This operation uses the following authentication methods.

Authorization

Responses

202

Accepted

Returns RequestTracker of type(s) application/json

{
    "progress": 90,
    "message": "In Progress",
    "status": "FINISHED",
    "resources": [
        "/resources/i-0be3655a12fd28e8e",
        "/resources/i-0be234a15ft8det3"
    ],
    "name": "Power-off",
    "id": "we655aew4e8e",
    "selfLink": "/.../request-tracker/we655aew4e8e",
    "deploymentId": "123e4567-e89b-12d3-a456-426614174000"
}

integer As int32 As int32

progress

Required

Progress of the request as percentage.

string

message

Optional

Status message of the request.

string

status

Required

Status of the request.

Possible values are : FINISHED, INPROGRESS, FAILED,

array of string

resources

Optional

Collection of resources.

string

name

Optional

Name of the operation.

string

Required

ID of this request.

string

selfLink

Required

Self link of this request.

string

deploymentId

Optional

ID of the deployment, this request is connected to.

400

Invalid Request - bad data

Returns ServiceErrorResponse of type(s) application/json

{
    "message": "string",
    "messageId": "string",
    "stackTrace": [
        "string"
    ],
    "statusCode": 0,
    "errorCode": 0,
    "details": [
        "string"
    ],
    "serverErrorId": "string",
    "documentKind": "string",
    "internalErrorCode": 0
}

string

message

Optional

message

string

messageId

Optional

messageId

array of string

stackTrace

Optional

stackTrace

integer As int32 As int32

statusCode

Optional

statusCode

integer As int32 As int32

errorCode

Optional

errorCode

array of string

details

Optional

details

string

serverErrorId

Optional

serverErrorId

string

documentKind

Optional

documentKind

integer As int32 As int32

internalErrorCode

Optional

internalErrorCode

403

Forbidden

Returns ServiceErrorResponse of type(s) application/json

{
    "message": "string",
    "messageId": "string",
    "stackTrace": [
        "string"
    ],
    "statusCode": 0,
    "errorCode": 0,
    "details": [
        "string"
    ],
    "serverErrorId": "string",
    "documentKind": "string",
    "internalErrorCode": 0
}

string

message

Optional

message

string

messageId

Optional

messageId

array of string

stackTrace

Optional

stackTrace

integer As int32 As int32

statusCode

Optional

statusCode

integer As int32 As int32

errorCode

Optional

errorCode

array of string

details

Optional

details

string

serverErrorId

Optional

serverErrorId

string

documentKind

Optional

documentKind

integer As int32 As int32

internalErrorCode

Optional

internalErrorCode

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"hostName":"string","name":"string","password":"string","regions":["object"],"username":"string"}' https://{api_host}/iaas/api/cloud-accounts-avilb

On This Page

Description

Request

Query Parameters

Request Body

Authentication

Response

202 Response Body

Errors

Cloud Account Operations

POST

Enumerate Private Images