Avi MicroService Object API

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

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.

Return type

MicroServiceApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "application_name" : "aeiou",
    "orchestrator_name" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "description" : "aeiou",
    "containers" : [ {
      "port" : 123,
      "ip" : {
        "addr" : "aeiou",
        "type" : "aeiou"
      },
      "host" : "aeiou",
      "task_id" : "aeiou",
      "container_id" : "aeiou"
    } ],
    "cloud_config_cksum" : "aeiou",
    "ip_list" : true,
    "created_by" : "aeiou",
    "uuid" : "aeiou",
    "url" : "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 MicroServiceApiResponse

401

log in failed

Up
post /microservice
(microservicePost)

Consumes

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

Request body

body (required)
Body Parameter — MicroService object creation

Return type

MicroService

Example data

Content-Type: application/json
{
  "application_name" : "aeiou",
  "orchestrator_name" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "containers" : [ {
    "port" : 123,
    "ip" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    },
    "host" : "aeiou",
    "task_id" : "aeiou",
    "container_id" : "aeiou"
  } ],
  "cloud_config_cksum" : "aeiou",
  "ip_list" : true,
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "url" : "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 MicroService

401

log in failed

Up
delete /microservice/{uuid}
(microserviceUuidDelete)

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 /microservice/{uuid}
(microserviceUuidGet)

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

MicroService

Example data

Content-Type: application/json
{
  "application_name" : "aeiou",
  "orchestrator_name" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "containers" : [ {
    "port" : 123,
    "ip" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    },
    "host" : "aeiou",
    "task_id" : "aeiou",
    "container_id" : "aeiou"
  } ],
  "cloud_config_cksum" : "aeiou",
  "ip_list" : true,
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "url" : "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 MicroService

401

log in failed

Up
patch /microservice/{uuid}
(microserviceUuidPatch)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

MicroService

Example data

Content-Type: application/json
{
  "application_name" : "aeiou",
  "orchestrator_name" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "containers" : [ {
    "port" : 123,
    "ip" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    },
    "host" : "aeiou",
    "task_id" : "aeiou",
    "container_id" : "aeiou"
  } ],
  "cloud_config_cksum" : "aeiou",
  "ip_list" : true,
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "url" : "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 MicroService

401

log in failed

Up
put /microservice/{uuid}
(microserviceUuidPut)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

MicroService

Example data

Content-Type: application/json
{
  "application_name" : "aeiou",
  "orchestrator_name" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "containers" : [ {
    "port" : 123,
    "ip" : {
      "addr" : "aeiou",
      "type" : "aeiou"
    },
    "host" : "aeiou",
    "task_id" : "aeiou",
    "container_id" : "aeiou"
  } ],
  "cloud_config_cksum" : "aeiou",
  "ip_list" : true,
  "created_by" : "aeiou",
  "uuid" : "aeiou",
  "url" : "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 MicroService

401

log in failed

Up
get /microservice/{uuid}/runtime/detail/
(microserviceUuidRuntimeDetailGet)

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:

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

200

OK String

401

log in failed

Up
get /microservice/{uuid}/runtime/internal/
(microserviceUuidRuntimeInternalGet)

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:

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

200

OK String

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. IpAddr
  2. MicroService
  3. MicroServiceApiResponse
  4. MicroServiceContainer

IpAddr Up

addr
String IP address.
type
String Enum options - V4, DNS, V6.

MicroService Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
application_name
String application_name of MicroService.
cloud_config_cksum (optional)
String Checksum of cloud configuration for Microservice. Internally set by cloud connector. Field introduced in 17.2.8.
containers (optional)
array[MicroServiceContainer] The list of containers for this microservice.
created_by (optional)
String Creator name.
description (optional)
String User defined description for the object.
ip_list (optional)
Boolean Flag to indicate if container IP list is provided by cloud connectorThis is applicable for overlay cases.
name
String Name of the object.
orchestrator_name
String orchestrator_name of MicroService.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
url (optional)
String url
uuid (optional)
String Unique object identifier of the object.

MicroServiceApiResponse Up

count
Integer format: int32
results
next (optional)

MicroServiceContainer Up

container_id (optional)
String ID of the container.
host (optional)
String ID or name of the host where the container is.
ip
IpAddr IP Address of the container.
port (optional)
Integer Port nunber of the instance. format: int32
task_id (optional)
String Marathon Task ID of the instance.