Avi PriorityLabels Object API

CLI ``` - configure prioritylabels - show prioritylabels ```
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 /prioritylabels
  2. post /prioritylabels
  3. delete /prioritylabels/{uuid}
  4. get /prioritylabels/{uuid}
  5. patch /prioritylabels/{uuid}
  6. put /prioritylabels/{uuid}
Up
get /prioritylabels
(prioritylabelsGet)

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

PriorityLabelsApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "equivalent_labels" : [ {
      "labels" : [ "aeiou" ]
    } ],
    "cloud_ref" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "description" : "aeiou",
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou",
    "labels" : [ {
      "value" : "aeiou",
      "key" : "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 PriorityLabelsApiResponse

401

log in failed

Up
post /prioritylabels
(prioritylabelsPost)

Consumes

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

Request body

body (required)
Body Parameter — PriorityLabels object creation

Return type

PriorityLabels

Example data

Content-Type: application/json
{
  "equivalent_labels" : [ {
    "labels" : [ "aeiou" ]
  } ],
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "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 PriorityLabels

401

log in failed

Up
delete /prioritylabels/{uuid}
(prioritylabelsUuidDelete)

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 /prioritylabels/{uuid}
(prioritylabelsUuidGet)

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

PriorityLabels

Example data

Content-Type: application/json
{
  "equivalent_labels" : [ {
    "labels" : [ "aeiou" ]
  } ],
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "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 PriorityLabels

401

log in failed

Up
patch /prioritylabels/{uuid}
(prioritylabelsUuidPatch)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

PriorityLabels

Example data

Content-Type: application/json
{
  "equivalent_labels" : [ {
    "labels" : [ "aeiou" ]
  } ],
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "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 PriorityLabels

401

log in failed

Up
put /prioritylabels/{uuid}
(prioritylabelsUuidPut)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

PriorityLabels

Example data

Content-Type: application/json
{
  "equivalent_labels" : [ {
    "labels" : [ "aeiou" ]
  } ],
  "cloud_ref" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "description" : "aeiou",
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "labels" : [ {
    "value" : "aeiou",
    "key" : "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 PriorityLabels

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. EquivalentLabels
  2. KeyValue
  3. PriorityLabels
  4. PriorityLabelsApiResponse

EquivalentLabels Up

labels (optional)
array[String] Equivalent labels.

KeyValue Up

key
String Key.
value (optional)
String Value.

PriorityLabels Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
cloud_ref (optional)
String It is a reference to an object of type Cloud.
description (optional)
String A description of the priority labels.
equivalent_labels (optional)
array[EquivalentLabels] Equivalent priority labels in descending order.
labels (optional)
array[KeyValue] Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field introduced in 20.1.2.
name
String The name of the priority labels.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
url (optional)
String url
uuid (optional)
String UUID of the priority labels.

PriorityLabelsApiResponse Up

count
Integer format: int32
results
next (optional)