Avi AutoScaleLaunchConfig Object API

##CLI## ``` - configure autoscalelaunchconfig - show autoscalelaunchconfig ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 17.2.4
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

  1. get /autoscalelaunchconfig
  2. post /autoscalelaunchconfig
  3. delete /autoscalelaunchconfig/{uuid}
  4. get /autoscalelaunchconfig/{uuid}
  5. patch /autoscalelaunchconfig/{uuid}
  6. put /autoscalelaunchconfig/{uuid}
Up
get /autoscalelaunchconfig
( autoscalelaunchconfigGet)

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

AutoScaleLaunchConfigApiResponse

Example data

Content-Type: application/json
{
  "count" : 123,
  "results" : [ {
    "mesos" : {
      "force" : true
    },
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "description" : "aeiou",
    "openstack" : {
      "heat_scale_down_url" : "aeiou",
      "heat_scale_up_url" : "aeiou"
    },
    "image_id" : "aeiou",
    "use_external_asg" : true,
    "uuid" : "aeiou",
    "url" : "aeiou"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AutoScaleLaunchConfigApiResponse

401

log in failed

Up
post /autoscalelaunchconfig
( autoscalelaunchconfigPost)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — AutoScaleLaunchConfig object creation

Return type

AutoScaleLaunchConfig

Example data

Content-Type: application/json
{
  "mesos" : {
    "force" : true
  },
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "openstack" : {
    "heat_scale_down_url" : "aeiou",
    "heat_scale_up_url" : "aeiou"
  },
  "image_id" : "aeiou",
  "use_external_asg" : true,
  "uuid" : "aeiou",
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AutoScaleLaunchConfig

401

log in failed

Up
delete /autoscalelaunchconfig/{uuid}
( autoscalelaunchconfigUuidDelete)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name

Return type

String

Example data

Content-Type: application/json
"aeiou"

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

object deleted String

404

not found

Up
get /autoscalelaunchconfig/{uuid}
( autoscalelaunchconfigUuidGet)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Query parameters

name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

AutoScaleLaunchConfig

Example data

Content-Type: application/json
{
  "mesos" : {
    "force" : true
  },
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "openstack" : {
    "heat_scale_down_url" : "aeiou",
    "heat_scale_up_url" : "aeiou"
  },
  "image_id" : "aeiou",
  "use_external_asg" : true,
  "uuid" : "aeiou",
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AutoScaleLaunchConfig

401

log in failed

Up
patch /autoscalelaunchconfig/{uuid}
( autoscalelaunchconfigUuidPatch)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — AutoScaleLaunchConfig object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

AutoScaleLaunchConfig

Example data

Content-Type: application/json
{
  "mesos" : {
    "force" : true
  },
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "openstack" : {
    "heat_scale_down_url" : "aeiou",
    "heat_scale_up_url" : "aeiou"
  },
  "image_id" : "aeiou",
  "use_external_asg" : true,
  "uuid" : "aeiou",
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AutoScaleLaunchConfig

401

log in failed

Up
put /autoscalelaunchconfig/{uuid}
( autoscalelaunchconfigUuidPut)

Path parameters

uuid (required)
Path Parameter — UUID of the object to fetch

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body (required)
Body Parameter — AutoScaleLaunchConfig object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

AutoScaleLaunchConfig

Example data

Content-Type: application/json
{
  "mesos" : {
    "force" : true
  },
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "openstack" : {
    "heat_scale_down_url" : "aeiou",
    "heat_scale_up_url" : "aeiou"
  },
  "image_id" : "aeiou",
  "use_external_asg" : true,
  "uuid" : "aeiou",
  "url" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

OK AutoScaleLaunchConfig

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. AutoScaleLaunchConfig
  2. AutoScaleLaunchConfigApiResponse
  3. AutoScaleMesosSettings
  4. AutoScaleOpenStackSettings

AutoScaleLaunchConfig Up

description (optional)
String User defined description for the object.
image_id (optional)
String Unique ID of the Amazon Machine Image (AMI) or OpenStack VM ID.
mesos (optional)
AutoScaleMesosSettings Placeholder for description of property mesos of obj type AutoScaleLaunchConfig field type str type object
name
String Name of the object.
openstack (optional)
AutoScaleOpenStackSettings Placeholder for description of property openstack of obj type AutoScaleLaunchConfig field type str type object
tenant_ref (optional)
String It is a reference to an object of type Tenant.
url (optional)
String url
use_external_asg (optional)
Boolean If set to True, ServerAutoscalePolicy will use the autoscaling group (external_autoscaling_groups) from Pool to perform scale up and scale down. Pool should have single autoscaling group configured. Field introduced in 17.2.3.
uuid (optional)
String Unique object identifier of the object.

AutoScaleLaunchConfigApiResponse Up

count
Integer format: int32
results

AutoScaleMesosSettings Up

force (optional)
Boolean Apply scaleout even when there are deployments inprogress.

AutoScaleOpenStackSettings Up

heat_scale_down_url (optional)
String Avi Controller will use this URL to scale downthe pool. Cloud connector will automatically update the membership. This is an alpha feature. Field introduced in 17.1.1.
heat_scale_up_url (optional)
String Avi Controller will use this URL to scale upthe pool. Cloud connector will automatically update the membership. This is an alpha feature. Field introduced in 17.1.1.