Avi JobEntry Object API

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

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

JobEntryApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "expires_at" : "aeiou",
    "obj_key" : "aeiou",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "subjobs" : [ {
      "metadata" : "aeiou",
      "expires_at" : "aeiou",
      "type" : "aeiou",
      "num_retries" : 123
    } ],
    "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 JobEntryApiResponse

401

log in failed

Up
post /jobs
(jobsPost)

Consumes

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

Request body

body (required)
Body Parameter — JobEntry object creation

Return type

JobEntry

Example data

Content-Type: application/json
{
  "expires_at" : "aeiou",
  "obj_key" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "subjobs" : [ {
    "metadata" : "aeiou",
    "expires_at" : "aeiou",
    "type" : "aeiou",
    "num_retries" : 123
  } ],
  "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 JobEntry

401

log in failed

Up
delete /jobs/{uuid}
(jobsUuidDelete)

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 /jobs/{uuid}
(jobsUuidGet)

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

JobEntry

Example data

Content-Type: application/json
{
  "expires_at" : "aeiou",
  "obj_key" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "subjobs" : [ {
    "metadata" : "aeiou",
    "expires_at" : "aeiou",
    "type" : "aeiou",
    "num_retries" : 123
  } ],
  "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 JobEntry

401

log in failed

Up
patch /jobs/{uuid}
(jobsUuidPatch)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

JobEntry

Example data

Content-Type: application/json
{
  "expires_at" : "aeiou",
  "obj_key" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "subjobs" : [ {
    "metadata" : "aeiou",
    "expires_at" : "aeiou",
    "type" : "aeiou",
    "num_retries" : 123
  } ],
  "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 JobEntry

401

log in failed

Up
put /jobs/{uuid}
(jobsUuidPut)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

JobEntry

Example data

Content-Type: application/json
{
  "expires_at" : "aeiou",
  "obj_key" : "aeiou",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "subjobs" : [ {
    "metadata" : "aeiou",
    "expires_at" : "aeiou",
    "type" : "aeiou",
    "num_retries" : 123
  } ],
  "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 JobEntry

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. JobEntry
  2. JobEntryApiResponse
  3. SubJob

JobEntry Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
expires_at
String expires_at of JobEntry.
name
String Field introduced in 18.1.2.
obj_key
String obj_key of JobEntry.
subjobs (optional)
array[SubJob] Field introduced in 18.1.1.
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.

JobEntryApiResponse Up

count
Integer format: int32
results
next (optional)

SubJob Up

expires_at
String Field introduced in 18.1.1.
metadata (optional)
String Field introduced in 18.1.1.
num_retries (optional)
Integer Number of times the sub job is rescheduled. Field introduced in 20.1.1. format: int32
type
String Enum options - JOB_TYPE_VS_FULL_LOGS, JOB_TYPE_VS_UDF, JOB_TYPE_VS_METRICS_RT, JOB_TYPE_SSL_CERT, JOB_TYPE_DEBUGVS_PKT_CAPTURE, JOB_TYPE_CONSISTENCY_CHECK, JOB_TYPE_TECHSUPPORT, JOB_TYPE_PKI_PROFILE, JOB_TYPE_NSP_RULE, JOB_TYPE_SEGROUP_METRICS_RT, JOB_TYPE_POSTGRES_STATUS, JOB_TYPE_VS_ROTATE_KEYS, JOB_TYPE_POOL_DNS, JOB_TYPE_GSLB_SERVICE, JOB_TYPE_APP_PERSISTENCE, JOB_TYPE_PROCESS_LOCKED_USER_ACCOUNTS, JOB_TYPE_SESSION, JOB_TYPE_AUTHTOKEN, JOB_TYPE_CLUSTER, JOB_TYPE_SE_SECURE_CHANNEL_CLEANUP, JOB_TYPE_OCSP_STAPLE_STATUS, JOB_TYPE_FILE_OBJECT_CLEANUP. Field introduced in 18.1.1.