Get Job
You can get a resource representation of a job with the specified UID.
Required Privileges
To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator, Company Owner, Company Administrator.
Request
To get a representation of a job, send the GET HTTP request to the URL of the /infrastructure/backupServers/jobs/{jobUid} resource.
HTTP Request
GET https://<hostname>:1280/api/v3/infrastructure/backupServers/jobs/{jobUid} |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Accept | Optional | application/json | Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request parameters
A list of parameters that are applicable for this operation:
Name | In | Type | Required | Default | Description |
---|---|---|---|---|---|
jobUid | Path | String (uuid) | Yes | — | Job UID |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message: application/json; charset=utf-8 |
Response Body
In the response body, Veeam Service Provider Console returns a resource representation based on the BackupServerJob schema.
Example
The following request returns a representation of a job with UID bc04d2e5-dd4c-4f85-af0e-424106a32a75.
Request: GET https://localhost:1280/api/v3/infrastructure/backupServers/jobs/bc04d2e5-dd4c-4f85-af0e-424106a32a75
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "data": { "instanceUid": "bc04d2e5-dd4c-4f85-af0e-424106a32a75", "name": "Backup Job 2 - 2 VMs", "backupServerUid": "d6b2c9fd-3ba4-4a6f-8a31-6099ce8af6da", "organizationUid": "c647bff1-7faf-4672-9e31-e37c3a0c2fd0", "status": "success", "type": "backupVm", "lastRun": "2019-02-20T10:45:52.3600000+00:00", "lastEndTime": "2019-02-20T11:05:01.3500000+00:00", "lastDuration": 1148, "processingRate": 0, "avgDuration": 0, "transferredData": 0, "bottleneck": "none", "isEnabled": true, "scheduleType": "continuously", "failureMessage": null, "targetType": "local", "destination": "Backup Repository 2 disk D" } } |