Retrieve Errored Instances
/ic/api/integration/v1/monitoring/errors
Request
- application/json; charset=utf-8
-
expand: string
- Includes additional details in the response about integrations, or about connections. Valid values: integration, connection.
Default Value:integration
-
groupBy: string
- Groups results by messages, integration name, or connection name. Valid values: messages, integration, connection.
-
limit: integer(int32)
Use with the offset parameter for paginating through the returned results. The limit is the maximum number of items to return at one time. For example, offset=3&limit=16 indicates to list error integration instances starting at the 4th item, and the list will contain 16 items.
-
offset: integer(int32)
Use with the limit parameter for paginating through the returned results. Default is 0. The offset is the starting point from which to return records. For example, offset=3&limit=16 indicates to list connections starting at the 4th item, and the list will contain 16 items.
-
q: string
Filter parameters.
- timewindow: 1h, 6h, 1d, 2d, 3d, RETENTIONPERIOD. Default value is 1h. Oracle recommends to specify the time window as close as possible to the requirement.
- code: Integration identifier.
- version: Integration version.
- startdate: Custom time range start date/time in UTC format for filtering instances. Oracle recommends to specify the start date as close as possible to the requirement.
- enddate: Custom time range end date/time in UTC format for filtering instances. Oracle recommends to specify the end date as close as possible to the requirement.
- id: Integration instance identifier.
- primaryValue: Value of primary tracking variable.
- secondaryValue: Value of secondary tracking variable.
- tertiaryValue: Value of tertiary tracking variable.
- recoverable: Indicates whether to fetch recoverable or non-recoverable instances. Valid values are true/false.
Example:
{startdate:'2020-07-09 07:00:00', enddate:'2020-07-09 21:25:00', code:'ERROR', version:'01.00.0000', recoverable:'true', id:'118'}
Response
- application/json; charset=utf-8
200 Response
object
-
connection:
object ConnectionErrorRs
-
creationDate:
string(date-time)
-
errorDetails:
string
-
errorMessage:
string
-
faultId:
string
-
id:
string
-
integration:
object IntegrationBaseRs
-
integrationDeleted:
boolean
Default Value:
false
-
isDataAccurate:
boolean
Default Value:
false
-
lastTrackedTime:
string(date-time)
-
links:
array links
-
primaryName:
string
-
primaryValue:
string
-
recoverable:
boolean
Default Value:
false
-
retryCount:
integer(int32)
-
runId:
string
-
status:
string
Allowed Values:
[ "IN_PROGRESS", "FAILED", "COMPLETED", "ABORTED", "RECOVERING", "UNKNOWN", "RESUBMITTED" ]
400 Response
401 Response
403 Response
500 Response
Examples
The following examples show how to retrieve monitoring details for error integration instances by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, see Send Requests.
Example: Get monitoring data for all error integration instances
curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://integration.us.oraclecloud.com/ic/api/integration/v1/monitoring/errors
Example: Get monitoring data for all error integration instances and include additional information about integrations
curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "expand=integration" https://integration.us.oraclecloud.com/ic/api/integration/v1/monitoring/errors
Example: Get monitoring data for all error integration instances grouped by integration name
curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "groupBy=integration" https://integration.us.oraclecloud.com/ic/api/integration/v1/monitoring/errors
Example: Get monitoring data for error instances for integration SC2RNSYNC version 01.00.0000 for the past 3 days
curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" --data-urlencode "q={timewindow: '3d', code: 'SC2RNSYNC', version: '01.00.0000'}" https://integration.us.oraclecloud.com/ic/api/integration/v1/monitoring/errors
Example: Paginate through returned results
Pagination is done with limit
and offset
. In this example, we list integrations starting at the fourth item. The list contains 16 items.
curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "offset=3&limit=16" https://integration.us.oraclecloud.com/ic/api/integration/v1/monitoring/errors
Example: Combine Parameters
To combine query parameters, use q
with the --data-urlencode
option. The other parameters can be added after the -d
option.
curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" --data-urlencode "q={timewindow: '3d}" -d "expand=integration&offset=3&limit=16" https://integration.us.oraclecloud.com/ic/api/integration/v1/monitoring/errors