This API returns a detailed summary of optimizer statistics collection operations.
GET {{baseUrl}}/managedDatabases/:managedDatabaseId/optimizerStatisticsCollectionOperations?startTimeGreaterThanOrEqualTo=<string>&endTimeLessThanOrEqualTo=<string>&taskType=ALL&limit=10&page=<string>&filterBy=<string>&sortBy=START_TIME&sortOrder=ASC
Lists the Optimizer Statistics Collection (Auto and Manual) task operation summary for the specified Managed Database. The summary includes the details of each operation and the number of tasks grouped by status: Completed, In Progress, Failed, and so on. Optionally, you can specify a date-time range (of seven days) to obtain the list of operations that fall within the specified time range. If the date-time range is not specified, then the operations in the last seven days are listed. This API also enables the pagination of results and the opc-next-page response header indicates whether there is a next page. If you use the same header value in a consecutive request, the next page records are returned. To obtain the required results, you can apply the different types of filters supported by this API.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
startTimeGreaterThanOrEqualTo | string | The start time of the time range to retrieve the optimizer statistics of a Managed Database | |
| in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'". | |||
endTimeLessThanOrEqualTo | string | The end time of the time range to retrieve the optimizer statistics of a Managed Database | |
| in UTC in ISO-8601 format, which is "yyyy-MM-dd'T'hh:mm:ss.sss'Z'". | |||
taskType | string | The filter types of the optimizer statistics tasks. | |
limit | number | The maximum number of records returned in the paginated response. | |
page | string | The page token representing the page from where the next set of paginated results | |
| are retrieved. This is usually retrieved from a previous list call. | |||
filterBy | string | The parameter used to filter the optimizer statistics operations. | |
| Any property of the OptimizerStatisticsCollectionOperationSummary can be used to define the filter condition. | |||
| The allowed conditional operators are AND or OR, and the allowed binary operators are are >, < and =. Any other operator is regarded invalid. | |||
| Example: jobName=<replace with job name> AND status=<replace with status> | |||
sortBy | string | Sorts the list of optimizer statistics operations based on a specific attribute. | |
sortOrder | string | The option to sort information in ascending (‘ASC’) or descending (‘DESC’) order. Ascending order is the default order. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
opc-request-id | string | The client request ID for tracing. | |
opc-named-credential-id | string | The OCID of the Named Credential. | |
Accept | string |
RESPONSES
status: OK
{"items":[{"id":"\u003cinteger\u003e","operationName":"\u003cstring\u003e","target":"\u003cstring\u003e","jobName":"\u003cstring\u003e","status":"COMPLETED","startTime":"\u003cstring\u003e","endTime":"\u003cstring\u003e","durationInSeconds":"\u003cnumber\u003e","completedCount":"\u003cinteger\u003e","failedCount":"\u003cinteger\u003e","inProgressCount":"\u003cinteger\u003e","timedOutCount":"\u003cinteger\u003e","totalObjectsCount":"\u003cinteger\u003e"},{"id":"\u003cinteger\u003e","operationName":"\u003cstring\u003e","target":"\u003cstring\u003e","jobName":"\u003cstring\u003e","status":"FAILED","startTime":"\u003cstring\u003e","endTime":"\u003cstring\u003e","durationInSeconds":"\u003cnumber\u003e","completedCount":"\u003cinteger\u003e","failedCount":"\u003cinteger\u003e","inProgressCount":"\u003cinteger\u003e","timedOutCount":"\u003cinteger\u003e","totalObjectsCount":"\u003cinteger\u003e"}]}