- API >
- Public API Resources >
- Log Collection Jobs >
- Get All Log Collection Jobs for One Project
Get All Log Collection Jobs for One Project¶
On this page
Note
Groups and projects are synonymous terms. Your {PROJECT-ID}
is the
same as your project id. For existing groups, your group/project id
remains the same. This page uses the more familiar term group when
referring to descriptions. The endpoint remains as stated in the
document.
When you create a log collection job, Ops Manager starts a background job to download the logs from the specified Ops Manager deployment. Use this endpoint to retrieve all log collection jobs for a specified Ops Manager project.
Base URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
Resource¶
Request Path Parameters¶
Name | Type | Description |
---|---|---|
PROJECT-ID |
string | Unique identifier of the project for which to retrieve log collection jobs. |
Request Query Parameters¶
Name | Type | Description | Default |
---|---|---|---|
pageNum |
number | One-based integer that returns a subsection of results. | 1 |
itemsPerPage |
number | Number of items to return per page, up to a maximum of 500. | 100 |
pretty |
boolean | Flag that indicates whether the response body should be in a prettyprint format. | false |
envelope |
boolean | Flag that indicates whether or not to wrap the response in an envelope. Some API clients cannot access the HTTP response headers or
status code. To remediate this, set For endpoints that return a list of results, the |
false |
verbose |
Boolean | If true, returns all child jobs in the response. Each log collection job contains child jobs for each log type and MongoDB process included in the request. | false |
---|
Request Body Parameters¶
This endpoint does not use HTTP request body parameters.
Response¶
Response Document¶
The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.
Name | Type | Description |
---|---|---|
results |
array | Array includes one object for each item detailed in the results Embedded Document section. |
links |
array | Array includes one or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification. |
totalCount |
number | Integer count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated. |
results Embedded Document¶
Each result is one log collection job.
Name | Type | Description |
---|---|---|
id |
string | Unique identifier of the log collection request job. |
groupId |
string | Unique identifier of the project that the log collection request is associated with. |
userId |
string | Unique identifier of the user executing the request. |
creationDate |
string | Timestamp, in the number of seconds that have elapsed since the UNIX epoch when the log collection request job was created. |
expirationDate |
string | Timestamp, in the number of seconds that have elapsed since the UNIX epoch when the log collection request job expires. |
status |
string | Status of the log collection request job. Will be one of the following values:
|
sizeRequestedPerFileBytes |
number | Size for each log file in bytes. |
resourceType |
string | Type of resource for which logs were requested. Will be one of the following values:
|
resourceName |
string | Name of the resource for which logs were requested. |
redacted |
boolean | If true , emails, hostnames, IP addresses, and namespaces
in the response are replaced with random string values. |
rootResourceName |
string | If the request is made to a part of a deployment, such as one replica set in a cluster, this is the name of the complete deployment. |
rootResourceType |
string | If the request is made to a part of a deployment, such as one replica set in a cluster, this is the type of the complete deployment. Will be one of the following values:
|
uncompressedSizeTotalBytes |
number | Total uncompressed size of the log data returned by this request in bytes. |
logTypes |
array | Array of log types included in this request. Will contain one or more of the following values:
|
url |
string | URL to download the logs from this request. |
childJobs |
array | Array of child jobs associated with this request. Included
in the response if the verbose query parameter is set
to true . |
childJobs[n] .uncompressedDiskSpaceBytes |
number | Total uncompressed disk space in bytes used by this child job. |
childJobs[n] .status |
string | Status of this child job. Returns one of the following values:
|
childJobs[n] .startDate |
date | Timestamp in ISO 8601 date and time format in UTC when this child job started. |
childJobs[n] .finishDate |
date | Timestamp in ISO 8601 date and time format in UTC when this child job finished. |
childJobs[n] .hostName |
string | Name of the host from whom the child job collects the logs. job. |
childJobs[n] .logCollectionType |
string | The type of log this child job collects. Returns one of the following values:
|
childJobs[n] .errorMessage |
string | Error message showing why this child job failed, if applicable. |
childJobs[n] .path |
string | Path to the process in the deployment for which this child job collects logs. |