Avi ALBServicesJob Object API

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

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

ALBServicesJobApiResponse

Example data

Content-Type: application/json
{
  "next" : "aeiou",
  "count" : 123,
  "results" : [ {
    "end_time" : {
      "usecs" : 123456789,
      "secs" : 123456789
    },
    "pulse_sync_status" : true,
    "pulse_job_id" : "aeiou",
    "params" : [ {
      "value" : "aeiou",
      "key" : "aeiou"
    } ],
    "uuid" : "aeiou",
    "command" : "aeiou",
    "url" : "aeiou",
    "_last_modified" : "aeiou",
    "token" : "aeiou",
    "result" : "aeiou",
    "start_time" : "",
    "tenant_ref" : "aeiou",
    "name" : "aeiou",
    "configpb_attributes" : {
      "version" : 123
    },
    "status" : "aeiou",
    "status_update_time" : ""
  } ]
}

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 ALBServicesJobApiResponse

401

log in failed

Up
post /albservicesjob
(albservicesjobPost)

Consumes

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

Request body

body (required)
Body Parameter — ALBServicesJob object creation

Return type

ALBServicesJob

Example data

Content-Type: application/json
{
  "end_time" : {
    "usecs" : 123456789,
    "secs" : 123456789
  },
  "pulse_sync_status" : true,
  "pulse_job_id" : "aeiou",
  "params" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "uuid" : "aeiou",
  "command" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "token" : "aeiou",
  "result" : "aeiou",
  "start_time" : "",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "status" : "aeiou",
  "status_update_time" : ""
}

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 ALBServicesJob

401

log in failed

Up
delete /albservicesjob/{uuid}
(albservicesjobUuidDelete)

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 /albservicesjob/{uuid}
(albservicesjobUuidGet)

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

ALBServicesJob

Example data

Content-Type: application/json
{
  "end_time" : {
    "usecs" : 123456789,
    "secs" : 123456789
  },
  "pulse_sync_status" : true,
  "pulse_job_id" : "aeiou",
  "params" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "uuid" : "aeiou",
  "command" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "token" : "aeiou",
  "result" : "aeiou",
  "start_time" : "",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "status" : "aeiou",
  "status_update_time" : ""
}

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 ALBServicesJob

401

log in failed

Up
patch /albservicesjob/{uuid}
(albservicesjobUuidPatch)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

ALBServicesJob

Example data

Content-Type: application/json
{
  "end_time" : {
    "usecs" : 123456789,
    "secs" : 123456789
  },
  "pulse_sync_status" : true,
  "pulse_job_id" : "aeiou",
  "params" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "uuid" : "aeiou",
  "command" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "token" : "aeiou",
  "result" : "aeiou",
  "start_time" : "",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "status" : "aeiou",
  "status_update_time" : ""
}

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 ALBServicesJob

401

log in failed

Up
put /albservicesjob/{uuid}
(albservicesjobUuidPut)

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

Query parameters

name (optional)
Query Parameter — object name

Return type

ALBServicesJob

Example data

Content-Type: application/json
{
  "end_time" : {
    "usecs" : 123456789,
    "secs" : 123456789
  },
  "pulse_sync_status" : true,
  "pulse_job_id" : "aeiou",
  "params" : [ {
    "value" : "aeiou",
    "key" : "aeiou"
  } ],
  "uuid" : "aeiou",
  "command" : "aeiou",
  "url" : "aeiou",
  "_last_modified" : "aeiou",
  "token" : "aeiou",
  "result" : "aeiou",
  "start_time" : "",
  "tenant_ref" : "aeiou",
  "name" : "aeiou",
  "configpb_attributes" : {
    "version" : 123
  },
  "status" : "aeiou",
  "status_update_time" : ""
}

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 ALBServicesJob

401

log in failed

Up

Models

[ Jump to Methods ]

Table of Contents

  1. ALBServicesJob
  2. ALBServicesJobApiResponse
  3. ALBServicesJobParam
  4. ConfigPbAttributes
  5. TimeStamp

ALBServicesJob Up

_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
command
String The command to be triggered by the albservicesjob. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
configpb_attributes (optional)
ConfigPbAttributes Protobuf versioning for config pbs. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.
end_time (optional)
TimeStamp The time at which the albservicesjob is ended. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
name
String The name of the albservicesjob. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
params (optional)
array[ALBServicesJobParam] Job params. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
pulse_job_id (optional)
String A unique identifier for this job entry on the Pulse portal. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
pulse_sync_status (optional)
Boolean Status of sync to pulse(result uploads/state updates). Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
result (optional)
String Job result. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
start_time (optional)
TimeStamp The time at which the albservicesjob is started. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
status (optional)
String The status of the albservicesjob. Enum options - UNDETERMINED, PENDING, IN_PROGRESS, COMPLETED, FAILED, NOT_ENABLED. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
status_update_time (optional)
TimeStamp Time at which the status of albservicesjob updated. Field introduced in 22.1.6. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
tenant_ref (optional)
String The unique identifier of the tenant to which this albservicesjob belongs. It is a reference to an object of type Tenant. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
token (optional)
String Job token. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
url (optional)
String url
uuid (optional)
String A unique identifier for this albservicesjob entry. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

ALBServicesJobApiResponse Up

count
Integer format: int32
results
next (optional)

ALBServicesJobParam Up

key (optional)
String Parameter name. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.
value (optional)
String Parameter value. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

ConfigPbAttributes Up

version (optional)
Integer Protobuf version number. Gets incremented if there is se Diff of federated diff in config pbs.This field will be a monotonically increasing number indicating the number of Config Update operations. Field introduced in 21.1.1. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition. format: int32

TimeStamp Up

secs
Long Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int64
usecs
Long Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition. format: int64