GET /albservicesjob/{uuid}

GET /albservicesjob/{uuid}

/albservicesjob/{uuid}

Request
URI
GET
https://{api_host}/api/albservicesjob/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

string
fields
Optional

List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

boolean
include_name
Optional

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.

boolean
skip_default
Optional

Default values are not set.

string
join_subresources
Optional

It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-Avi-Version
Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string
X-CSRFToken
Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.

Responses
200

OK

Returns ALBServicesJob of type(s) application/json 
{
    "_last_modified": "string",
    "command": "string",
    "configpb_attributes": {
        "version": 0
    },
    "end_time": {
        "secs": 0,
        "usecs": 0
    },
    "name": "string",
    "params": [
        {
            "key": "string",
            "value": "string"
        }
    ],
    "pulse_job_id": "string",
    "pulse_sync_status": false,
    "result": "string",
    "start_time": {
        "secs": 0,
        "usecs": 0
    },
    "status": "string",
    "status_update_time": {
        "secs": 0,
        "usecs": 0
    },
    "tenant_ref": "string",
    "token": "string",
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Optional

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

string
command
Required

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.

object
configpb_attributes
Optional

configpb_attributes

object
end_time
Optional

end_time

string
name
Required

The name of the albservicesjob. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of object
params
Optional

Job params. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
pulse_job_id
Optional

A unique identifier for this job entry on the Pulse Cloud Services. Field introduced in 21.1.3. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

boolean
pulse_sync_status
Optional

Status of sync to Pulse Cloud Services(result uploads/state updates). Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
result
Optional

Job result. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

object
start_time
Optional

start_time

string
status
Optional
Constraints: default: PENDING

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.

object
status_update_time
Optional

status_update_time

string
tenant_ref
Optional

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.

string
token
Optional

Job token. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

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.


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -H 'Authorization: <value>' https://{api_host}/api/albservicesjob/{uuid}
On This Page
Albservices Job Operations
GET
GET /albservicesjob
POST
POST /albservicesjob
GET
GET /albservicesjob/{uuid}
PUT
PUT /albservicesjob/{uuid}
PATCH
PATCH /albservicesjob/{uuid}
DELETE
DELETE /albservicesjob/{uuid}