Get Cleanable Batch Report
Retrieves a report about a historic batch operations relevant to history cleanup (see History cleanup) so that you can tune the history time to live. These reports include the count of the finished batches, cleanable batches and type of the batch. The size of the result set can be retrieved by using the Get Cleanable Batch Report Count method.
Please note: The history time to live for batch operations does not support Multi-Tenancy. The report will return an information for all batch operations (for all tenants) if you have permissions to see the history.
Method
GET /history/batch/cleanable-batch-report
Parameters
Query Parameters
| Name | Description |
|---|---|
| sortBy | Sort the results by a given criterion. Valid value is finished.
Must be used in conjunction with the sortOrder parameter. |
| sortOrder | Sort the results in a given order. Values may be asc for ascending order or desc for descending order.
Must be used in conjunction with the sortBy parameter. |
| firstResult | Pagination of results. Specifies the index of the first result to return. |
| maxResults | Pagination of results. Specifies the maximum number of results to return. Will return less results if there are no more results left. |
Result
A JSON array containing finished batches information relevant to history cleanup. Each report result has the following properties:
| Name | Value | Description |
|---|---|---|
| batchType | String | The type of the batch operation. |
| historyTimeToLive | Number | The history time to live of the batch operation. |
| finishedBatchesCount | Number | The count of the finished batch operations. |
| cleanableBatchesCount | Number | The count of the cleanable historic batch operations, referring to history time to live. |
Response Codes
| Code | Media type | Description |
|---|---|---|
| 200 | application/json | Request successful. |
| 500 | application/json | See the Introduction for the error response format. |
Examples
Request
GET /history/batch/cleanable-batch-report
Response
[
{
"batchType":"instance-modification",
"historyTimeToLive":5,
"finishedBatchCount":100,
"cleanableBatchCount":53
},
{
"batchType":"instance-deletion",
"historyTimeToLive":5,
"finishedBatchCount":1000,
"cleanableBatchCount":13
}
]