Get Load Balancer
Get load balancer with a given id
The ID of the load balancer.
The version of the API in yyyy-MM-dd format (UTC). For versioning information refer to /iaas/api/about
Successful operation
{
"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",
"externalId": "i-cfe4-e241-e53b-756a9a2e25d2",
"projectId": "9.0E49",
"externalZoneId": "us-east-1a",
"externalRegionId": "us-east-1",
"cloudAccountIds": [
9e+49
],
"deploymentId": "123e4567-e89b-12d3-a456-426655440000",
"provisioningStatus": "string",
"tags": [
{
"key": "ownedBy",
"value": "Rainpole"
}
],
"customProperties": {
"property": "value"
},
"address": "lb-123456789.eu-west-1.elb.amazonaws.com",
"type": "Azure: BASIC, or STANDARD, AWS: Application, Network, or Classic, NSX: SMALL, MEDIUM, LARGE, EXTRA_LARGE",
"loggingLevel": "ERROR, WARNING, INFO, DEBUG",
"routes": [
{
"protocol": "TCP, UDP",
"port": "80",
"memberProtocol": "TCP, UDP",
"memberPort": "80",
"algorithm": "ROUND_ROBIN",
"algorithmParameters": "uriLength=10\nurlParam=section",
"healthCheckConfiguration": {
"protocol": "HTTP, HTTPS",
"port": "80",
"urlPath": "/index.html",
"intervalSeconds": 60,
"timeoutSeconds": 5,
"unhealthyThreshold": 5,
"healthyThreshold": 2,
"httpMethod": "GET, OPTIONS, POST, HEAD, PUT",
"requestBody": "http_request.body",
"responseBody": "http_response.body",
"passiveMonitor": false
}
}
]
}
The id of this resource instance
Date when the entity was created. The date is in ISO 8601 and UTC.
Date when the entity was last updated. The date is ISO 8601 and UTC.
Email of the user or display name of the group that owns the entity.
Type of a owner(user/ad_group) that owns the entity.
The id of the organization this entity belongs to.
HATEOAS of the entity
A human-friendly name used as an identifier in APIs that support this option.
A human-friendly description.
External entity Id on the provider side.
The id of the project this resource belongs to.
The external zoneId of the resource.
The external regionId of the resource.
Set of ids of the cloud accounts this resource belongs to.
Deployment id that is associated with this resource.
The provisioning status of the resource. One of three provisioning statuses.
PROVISIONING
: The resource is being provisioned.
READY
: The resource is already provisioned.
SUSPEND
: The resource is being destroyed.
A set of tag keys and optional values that were set on this resource.
Additional properties that may be used to extend the base resource.
Primary address allocated or in use by this load balancer. The address could be an in the form of a publicly resolvable DNS name or an IP address.
Define the type/variant of load balancer numbers e.g.for NSX the number virtual servers and pool members load balancer can host
Defines logging level for collecting load balancer traffic logs.
The load balancer route configuration regarding ports and protocols.
Forbidden
"ServiceErrorResponse Object"
message
messageId
stackTrace
statusCode
errorCode
details
serverErrorId
documentKind
internalErrorCode
Not Found
"ServiceErrorResponse Object"
message
messageId
stackTrace
statusCode
errorCode
details
serverErrorId
documentKind
internalErrorCode
curl -H 'Authorization: <value>' https://{api_host}/iaas/api/load-balancers/{id}