Avi SCVsStateInfo Object API

CLI ``` - show vsstateinfo ```

More information: https://avinetworks.com/contact-us

Contact Info: support@avinetworks.com

Version: 20.1.9

BasePath:/api

http://apache.org/licenses/LICENSE-2.0.html

Access

HTTP Basic Authentication

Methods

[ Jump to Models ]

get /scvsstateinfo
post /scvsstateinfo
delete /scvsstateinfo/{uuid}
get /scvsstateinfo/{uuid}
patch /scvsstateinfo/{uuid}
put /scvsstateinfo/{uuid}

get /scvsstateinfo

(scvsstateinfoGet)

Consumes

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

application/json

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

SCVsStateInfoApiResponse

Example data

Content-Type: application/json

{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "tenant_ref" : "aeiou",
    "vs_id" : "aeiou",
    "vip_id" : "aeiou",
    "oper_status" : {
      "reason_code" : 123456789,
      "reason" : [ "aeiou" ],
      "last_changed_time" : {
        "usecs" : 123456789,
        "secs" : 123456789
      },
      "state" : "aeiou",
      "reason_code_string" : "aeiou"
    },
    "uuid" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou"
  } ]
}

Produces

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

application/json

Responses

200

OK SCVsStateInfoApiResponse

401

post /scvsstateinfo

(scvsstateinfoPost)

Consumes

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

application/json

Request body

body (required)

Body Parameter — SCVsStateInfo object creation

Return type

SCVsStateInfo

Example data

Content-Type: application/json

{
  "tenant_ref" : "aeiou",
  "vs_id" : "aeiou",
  "vip_id" : "aeiou",
  "oper_status" : {
    "reason_code" : 123456789,
    "reason" : [ "aeiou" ],
    "last_changed_time" : {
      "usecs" : 123456789,
      "secs" : 123456789
    },
    "state" : "aeiou",
    "reason_code_string" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou"
}

Produces

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

application/json

Responses

200

OK SCVsStateInfo

401

delete /scvsstateinfo/{uuid}

(scvsstateinfoUuidDelete)

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:

application/json

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 request header; the media type will be conveyed by the Content-Type response header.

application/json

Responses

204

object deleted String

404

not found

get /scvsstateinfo/{uuid}

(scvsstateinfoUuidGet)

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:

application/json

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

SCVsStateInfo

Example data

Content-Type: application/json

{
  "tenant_ref" : "aeiou",
  "vs_id" : "aeiou",
  "vip_id" : "aeiou",
  "oper_status" : {
    "reason_code" : 123456789,
    "reason" : [ "aeiou" ],
    "last_changed_time" : {
      "usecs" : 123456789,
      "secs" : 123456789
    },
    "state" : "aeiou",
    "reason_code_string" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou"
}

Produces

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

application/json

Responses

200

OK SCVsStateInfo

401

patch /scvsstateinfo/{uuid}

(scvsstateinfoUuidPatch)

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:

application/json

Request body

body (required)

Body Parameter — SCVsStateInfo object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

SCVsStateInfo

Example data

Content-Type: application/json

{
  "tenant_ref" : "aeiou",
  "vs_id" : "aeiou",
  "vip_id" : "aeiou",
  "oper_status" : {
    "reason_code" : 123456789,
    "reason" : [ "aeiou" ],
    "last_changed_time" : {
      "usecs" : 123456789,
      "secs" : 123456789
    },
    "state" : "aeiou",
    "reason_code_string" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou"
}

Produces

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

application/json

Responses

200

OK SCVsStateInfo

401

put /scvsstateinfo/{uuid}

(scvsstateinfoUuidPut)

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:

application/json

Request body

body (required)

Body Parameter — SCVsStateInfo object creation

Query parameters

name (optional)

Query Parameter — object name

Return type

SCVsStateInfo

Example data

Content-Type: application/json

{
  "tenant_ref" : "aeiou",
  "vs_id" : "aeiou",
  "vip_id" : "aeiou",
  "oper_status" : {
    "reason_code" : 123456789,
    "reason" : [ "aeiou" ],
    "last_changed_time" : {
      "usecs" : 123456789,
      "secs" : 123456789
    },
    "state" : "aeiou",
    "reason_code_string" : "aeiou"
  },
  "uuid" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou"
}

Produces

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

application/json

Responses

200

OK SCVsStateInfo

401

Models

[ Jump to Methods ]

OperationalStatus
SCVsStateInfo
SCVsStateInfoApiResponse
TimeStamp

OperationalStatus Up

last_changed_time (optional)

TimeStamp Placeholder for description of property last_changed_time of obj type OperationalStatus field type str type object

reason (optional)

array[String] reason of OperationalStatus.

reason_code (optional)

Long Number of reason_code. format: int64

reason_code_string (optional)

String reason_code_string of OperationalStatus.

state (optional)

String Enum options - OPER_UP, OPER_DOWN, OPER_CREATING, OPER_RESOURCES, OPER_INACTIVE, OPER_DISABLED, OPER_UNUSED, OPER_UNKNOWN, OPER_PROCESSING, OPER_INITIALIZING, OPER_ERROR_DISABLED, OPER_AWAIT_MANUAL_PLACEMENT, OPER_UPGRADING, OPER_SE_PROCESSING, OPER_PARTITIONED, OPER_DISABLING, OPER_FAILED, OPER_UNAVAIL.

SCVsStateInfo Up

_last_modified (optional)

String UNIX time since epoch in microseconds. Units(MICROSECONDS).

oper_status (optional)

OperationalStatus Field introduced in 17.1.1.

tenant_ref (optional)

String It is a reference to an object of type Tenant. Field introduced in 17.1.1.

url (optional)

String url

uuid (optional)

String Field introduced in 17.1.1.

vip_id (optional)

String Field introduced in 17.1.1.

vs_id (optional)

String Field introduced in 17.1.1.

SCVsStateInfoApiResponse Up

count

Integer format: int32

results

array[SCVsStateInfo]

next (optional)

String

TimeStamp Up

secs

Long Number of secs. format: int64

usecs

Long Number of usecs. format: int64

Avi SCVsStateInfo Object API

Access

Methods

Table of Contents

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Consumes

Request body

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

204

404

Path parameters

Consumes

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Path parameters

Consumes

Request body

Query parameters

Return type

Example data

Produces

Responses

200

401

Models

Table of Contents

OperationalStatus Up

SCVsStateInfo Up

SCVsStateInfoApiResponse Up

TimeStamp Up