Avi AvailabilityZone Object API

CLI ``` - configure availabilityzone - show availabilityzone ```
More information: https://avinetworks.com/contact-us
Contact Info: support@avinetworks.com
Version: 20.1.2
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 /availabilityzone
  2. post /availabilityzone
  3. delete /availabilityzone/{uuid}
  4. get /availabilityzone/{uuid}
  5. patch /availabilityzone/{uuid}
  6. put /availabilityzone/{uuid}
Up
get /availabilityzone
(availabilityzoneGet)

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.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
cloud_uuid (optional)
Query Parameter — Filter to get objects that belongs to a specific cloud using its uuid. Eg. cloud_uuid=cloud-xyz.
cloud_ref.name (optional)
Query Parameter — Filter to get objects that belongs to a specific cloud usings its name. This uses cloud name rather than uuid. Eg. cloud_ref.name=Default-Cloud.

Return type

AvailabilityZoneApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "cloud_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "uuid" : "aeiou",
    "url" : "aeiou",
    "vcenter_refs" : [ "aeiou" ],
    "_last_modified" : "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 AvailabilityZoneApiResponse

401

log in failed

Up
post /availabilityzone
(availabilityzonePost)

Consumes

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

Request body

body (required)
Body Parameter — AvailabilityZone object creation

Return type

AvailabilityZone

Example data

Content-Type: application/json
{
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "vcenter_refs" : [ "aeiou" ],
  "_last_modified" : "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 AvailabilityZone

401

log in failed

Up
delete /availabilityzone/{uuid}
(availabilityzoneUuidDelete)

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 /availabilityzone/{uuid}
(availabilityzoneUuidGet)

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.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Return type

AvailabilityZone

Example data

Content-Type: application/json
{
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "vcenter_refs" : [ "aeiou" ],
  "_last_modified" : "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 AvailabilityZone

401

log in failed

Up
patch /availabilityzone/{uuid}
(availabilityzoneUuidPatch)

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 — AvailabilityZone object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

AvailabilityZone

Example data

Content-Type: application/json
{
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "vcenter_refs" : [ "aeiou" ],
  "_last_modified" : "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 AvailabilityZone

401

log in failed

Up
put /availabilityzone/{uuid}
(availabilityzoneUuidPut)

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 — AvailabilityZone object creation

Query parameters

name (optional)
Query Parameter — object name

Return type

AvailabilityZone

Example data

Content-Type: application/json
{
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "vcenter_refs" : [ "aeiou" ],
  "_last_modified" : "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 AvailabilityZone

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. AvailabilityZone
  2. AvailabilityZoneApiResponse

AvailabilityZone Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
cloud_ref (optional)
String Availability zone belongs to cloud. It is a reference to an object of type Cloud. Field introduced in 20.1.1.
name
String Availabilty zone where VCenter list belongs to. Field introduced in 20.1.1.
tenant_ref (optional)
String Availabilityzone belongs to tenant. It is a reference to an object of type Tenant. Field introduced in 20.1.1.
url (optional)
String url
uuid (optional)
String Availability zone config UUID. Field introduced in 20.1.1.
vcenter_refs (optional)
array[String] Group of VCenter list belong to availabilty zone. It is a reference to an object of type VCenterServer. Field introduced in 20.1.1.

AvailabilityZoneApiResponse Up

count
Integer format: int32
results
next (optional)