Get Avi Lb Cloud Account

Get Avi Lb Cloud Account
Get an AVI Load Balancer cloud account

Get an AVI Load Balancer with a given id

Request
URI
GET
https://vcfa-10-162-161-9.vcfd.broadcom.net/iaas/api/cloud-accounts-avilb/{id}
COPY
Path Parameters
string
id
Required

The ID of the Cloud Account

Query Parameters
string
apiVersion
Optional

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

Authentication
This operation uses the following authentication methods.
Responses
200

Successful operation

Returns CloudAccountAviLb of type(s) application/json 
{
    "id": "9.0E49",
    "createdAt": "2012-09-27",
    "updatedAt": "2012-09-27",
    "owner": "[email protected]",
    "ownerType": "ad_group",
    "orgId": "42413b31-1716-477e-9a88-9dc1c3cb1cdf",
    "_links": {
        "empty": false
    },
    "name": "my-name",
    "description": "my-description",
    "hostName": "avilb.vmware.com",
    "username": "[email protected]",
    "customProperties": {
        "cloud": "vsphere-cloud"
    },
    "tags": [
        {
            "key": "env",
            "value": "dev"
        }
    ]
}
string
id
Required

The id of this resource instance

string
createdAt
Optional

Date when the entity was created. The date is in ISO 8601 and UTC.

string
updatedAt
Optional

Date when the entity was last updated. The date is ISO 8601 and UTC.

string
owner
Optional

Email of the user or display name of the group that owns the entity.

string
ownerType
Optional

Type of a owner(user/ad_group) that owns the entity.

string
orgId
Optional

The id of the organization this entity belongs to.

object
_links
Required

HATEOAS of the entity

string
name
Optional

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 cloud account

string
username
Required

Username to authenticate with the cloud account

object
customProperties
Optional

Additional properties that may be used to extend the base type.

array of object
tags
Optional

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


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


404

Not Found

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 -H 'Authorization: <value>' https://{api_host}/iaas/api/cloud-accounts-avilb/{id}
On This Page
Cloud Account Operations
POST
Enumerate Private Images
POST
Run Endpoint Health Check
POST
Enumerate Regions Async
POST
Enumerate Private Images V Sphere
POST
Enumerate V Sphere Regions Async
GET
Get V Sphere Cloud Accounts
POST
Create V Sphere Cloud Account Async
POST
Enumerate Private Images VMC
POST
Enumerate Vmc Regions Async
GET
Get Vmc Cloud Accounts
POST
Create Vmc Cloud Account Async
POST
Enumerate Private Images VCF
POST
Enumerate Vcf Regions Async
GET
Get Vcf Cloud Accounts
POST
Create Vcf Cloud Account Async
GET
Get Nsx T Cloud Accounts
POST
Create Nsx T Cloud Account Async
POST
Enumerate Private Images Gcp
POST
Enumerate Gcp Regions Async
GET
Get Gcp Cloud Accounts
POST
Create Gcp Cloud Account Async
POST
Enumerate Private Images Azure
POST
Enumerate Azure Regions Async
GET
Get Azure Cloud Accounts
POST
Create Azure Cloud Account Async
POST
Enumerate Private Images AWS
POST
Enumerate Aws Regions Async
GET
Get Aws Cloud Accounts
POST
Create Aws Cloud Account Async
GET
Get Avi Lb Cloud Accounts
POST
Create Avi Lb Cloud Account Async
GET
Get Cloud Accounts
POST
Create Cloud Account Async
GET
Get Cloud Account
DELETE
Delete Cloud Account
PATCH
Update Cloud Account Async
GET
Get V Sphere Cloud Account
DELETE
Delete V Sphere Cloud Account
PATCH
Update V Sphere Cloud Account Async
GET
Get Vmc Cloud Account
DELETE
Delete Vmc Cloud Account
PATCH
Update VMC Cloud Account Async
GET
Get Vcf Cloud Account
DELETE
Delete Vcf Cloud Account
PATCH
Update Vcf Cloud Account Async
GET
Get Nsx T Cloud Account
DELETE
Delete Cloud Account Nsx T
PATCH
Update Nsx T Cloud Account Async
GET
Get Gcp Cloud Account
DELETE
Delete Gcp Cloud Account
PATCH
Update Gcp Cloud Account Async
GET
Get Azure Cloud Account
DELETE
Delete Azure Cloud Account
PATCH
Update Azure Cloud Account Async
GET
Get Aws Cloud Account
DELETE
Delete Aws Cloud Account
PATCH
Update AWS Cloud Account Async
GET
Get Avi Lb Cloud Account
DELETE
Delete Avi Lb Account Async
PATCH
Update Avi Lb Cloud Account Async
GET
Get Region Enumeration Result