GET /query?type=ObjectInJob
Returns a list of VMs and VM containers processed by jobs. For details, see /jobs/{ID}/includes.
Request
To get a list of all VMs and VM containers processed by jobs, send the GET HTTP request to the query with the type parameter set to ObjectInJob.
HTTP Request
GET https://<Enterprise-Manager>:9398/api/query?type=ObjectInJob |
Request Headers
The request contains the following headers:
Header | Required | Description |
|---|
X-RestSvcSessionId | True | The request requires authorization. In the header, the client must send a session ID copied from the server reply to the request creating a new logon session. For details, see Authentication and Security. |
Accept | False | Identifies the format of the response. Possible values: - application/xml — the client can send this value in the header to accept response in the XML format.
- application/json — the client must send this value in the header to accept the request in the JSON format.
If the request does not contain the header, the server will return the response in the XML format. |
Request Body
None.
Optional Parameters
In the query, you can use the following parameters for filtering and sorting.
Parameter | Type | Description |
|---|
UID | String | ID of the VM or VM container processed by the job, for example: e310aa12-eff2-41f4-97c8-631b677fc17f. |
Name | String | Name of the VM or VM container processed by the job, for example: DC-SRV. |
JobUid | UidType | UID of the backup or replication job parent to the VM or VM container resource, for example: urn:veeam:Job:da736815-4fea-4c8e-b0e1-5ecdbca1c512. |
JobName | String | Name of the backup or replication job parent to the VM or VM container resource, for example: DC Backup. |
BackupServerUid | UidType | UID of the backup server to which the hierarchy root parent for the VM or VM container resource has been added, for example: urn:veeam:BackupServer:15942270-fb56-4dcc-96e9-5f80e4725a15. |
BackupServerName | String | Name of the backup server to which the hierarchy root parent for the VM or VM container resource has been added, for example: BACKUPSERVER. |
Response
The server returns the following response to the client.
Response Codes
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. Possible values: - application/xml
- application/json
|
Response Body
In the response body, the REST API returns a representation of the /jobs/{ID}/includes resource collection.
Example
The example below returns an entity resource representation of a collection of objects that have the ubuntu88 name and that are processed by jobs created on the enterprise06.tech.local backup server. The results are ordered in the acceding order by the JobName parameter.
Request: GET https://localhost:9398/api/query?type=ObjectInJob&format=Entities&sortAsc=JobName&filter=BackupServerName=="enterprise06.tech.local";Name==ubuntu88 Request Header: X-RestSvcSessionId NDRjZmJkYmUtNWE5NS00MTU2LTg4NjctOTFmMDY5YjdjMmNj Response: 200 OK Response Body: <QueryResult xmlns="http://www.veeam.com/ent/v1.0">
<Resources>
<ObjectsInJob>
<ObjectInJob Type="ObjectInJob" Href="https://localhost:9398/api/jobs/c05dfa57-f59a-4e90-8065-b7f5d3276406/includes/efc75e40-4ac8-4221-bba1-8d8a81171530">
<Links>
<Link Rel="Delete" Href="https://localhost:9398/api/jobs/c05dfa57-f59a-4e90-8065-b7f5d3276406/includes/efc75e40-4ac8-4221-bba1-8d8a81171530" />
<Link Rel="Up" Type="Job" Href="https://localhost:9398/api/jobs/c05dfa57-f59a-4e90-8065-b7f5d3276406?format=Entity" Name="Backup Job 1" />
</Links>
<ObjectInJobId>efc75e40-4ac8-4221-bba1-8d8a81171530</ObjectInJobId>
<HierarchyObjRef>urn:VMware:Vm:de28dc43-b8ee-4e17-8e63-3d38b6604033.vm-85541</HierarchyObjRef>
<Name>ubuntu88</Name>
<DisplayName>ubuntu88</DisplayName>
<GuestProcessingOptions>
<VssSnapshotOptions>
<VssSnapshotMode>RequireSuccess</VssSnapshotMode>
<IsCopyOnly>false</IsCopyOnly>
</VssSnapshotOptions>
<WindowsGuestFSIndexingOptions>
<FileSystemIndexingMode>ExceptSpecifiedFolders</FileSystemIndexingMode>
<IncludedIndexingFolders />
<ExcludedIndexingFolders>
<Path>%windir%</Path>
<Path>%ProgramFiles%</Path>
<Path>%ProgramFiles(x86)%</Path>
<Path>%ProgramW6432%</Path>
<Path>%TEMP%</Path>
</ExcludedIndexingFolders>
</WindowsGuestFSIndexingOptions>
<LinuxGuestFSIndexingOptions>
<FileSystemIndexingMode>EveryFolders</FileSystemIndexingMode>
<IncludedIndexingFolders />
<ExcludedIndexingFolders>
<Path>/cdrom</Path>
<Path>/dev</Path>
<Path>/media</Path>
<Path>/mnt</Path>
<Path>/proc</Path>
<Path>/tmp</Path>
<Path>/lost+found</Path>
</ExcludedIndexingFolders>
</LinuxGuestFSIndexingOptions>
<SqlBackupOptions>
<TransactionLogsProcessing>OnlyOnSuccessJob</TransactionLogsProcessing>
<BackupLogsFrequencyMin>15</BackupLogsFrequencyMin>
<UseDbBackupRetention>true</UseDbBackupRetention>
<RetainDays>15</RetainDays>
</SqlBackupOptions>
<WindowsCredentialsId />
<LinuxCredentialsId />
</GuestProcessingOptions>
</ObjectInJob>
<ObjectInJob Type="ObjectInJob" Href="https://localhost:9398/api/jobs/1aa9734e-60e1-4fb6-87df-bbaa9bf38de8/includes/03a81f69-2350-46c6-a157-814e53d12c53">
<Links>
<Link Rel="Delete" Href="https://localhost:9398/api/jobs/1aa9734e-60e1-4fb6-87df-bbaa9bf38de8/includes/03a81f69-2350-46c6-a157-814e53d12c53" />
<Link Rel="Up" Type="Job" Href="https://localhost:9398/api/jobs/1aa9734e-60e1-4fb6-87df-bbaa9bf38de8?format=Entity" Name="Replication Job 1" />
</Links>
<ObjectInJobId>03a81f69-2350-46c6-a157-814e53d12c53</ObjectInJobId>
<HierarchyObjRef>urn:VMware:Vm:de28dc43-b8ee-4e17-8e63-3d38b6604033.vm-85541</HierarchyObjRef>
<Name>ubuntu88</Name>
<DisplayName>ubuntu88</DisplayName>
<GuestProcessingOptions>
<VssSnapshotOptions>
<VssSnapshotMode>RequireSuccess</VssSnapshotMode>
<IsCopyOnly>true</IsCopyOnly>
</VssSnapshotOptions>
<WindowsGuestFSIndexingOptions>
<FileSystemIndexingMode>ExceptSpecifiedFolders</FileSystemIndexingMode>
<IncludedIndexingFolders />
<ExcludedIndexingFolders>
<Path>%windir%</Path>
<Path>%ProgramFiles%</Path>
<Path>%ProgramFiles(x86)%</Path>
<Path>%ProgramW6432%</Path>
<Path>%TEMP%</Path>
</ExcludedIndexingFolders>
</WindowsGuestFSIndexingOptions>
<LinuxGuestFSIndexingOptions>
<FileSystemIndexingMode>ExceptSpecifiedFolders</FileSystemIndexingMode>
<IncludedIndexingFolders />
<ExcludedIndexingFolders>
<Path>/cdrom</Path>
<Path>/dev</Path>
<Path>/media</Path>
<Path>/mnt</Path>
<Path>/proc</Path>
<Path>/tmp</Path>
<Path>/lost+found</Path>
</ExcludedIndexingFolders>
</LinuxGuestFSIndexingOptions>
<SqlBackupOptions>
<TransactionLogsProcessing>Never</TransactionLogsProcessing>
<BackupLogsFrequencyMin>15</BackupLogsFrequencyMin>
<UseDbBackupRetention>true</UseDbBackupRetention>
<RetainDays>15</RetainDays>
</SqlBackupOptions>
<WindowsCredentialsId />
<LinuxCredentialsId />
</GuestProcessingOptions>
</ObjectInJob>
</ObjectsInJob>
</Resources>
<PagingInfo PagesCount="1" PageSize="100" PageNum="1">
<Links>
<Link Rel="First" Href="https://localhost:9398/api/query?type=ObjectInJob&format=Entities&sortAsc=JobName&filter=BackupServerName=="enterprise06.tech.local";Name==ubuntu88&pageSize=100&page=1" />
<Link Rel="Last" Href="https://localhost:9398/api/query?type=ObjectInJob&format=Entities&sortAsc=JobName&filter=BackupServerName=="enterprise06.tech.local";Name==ubuntu88&pageSize=100&page=1" />
</Links>
</PagingInfo>
</QueryResult> |