Retrieve Monitoring Data for Integrations
/ic/api/integration/v1/monitoring/integrations
Request
-
integrationInstance(required): string
This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.
-
limit: integer(int32)
Number of integrations to fetch.
-
offset: integer(int32)
Start index for pagination support. Default value is 0.
-
orderBy: string
Valid values:
- 'name': Results will be ordered by Integration name.
- 'time': Results will be ordered by last updated time.
Example:
To order the records by name
orderBy='name'
-
q: string
Filter parameters.
- timewindow: 1h, 6h, 1d, 2d, 3d, RETENTIONPERIOD. Default value is 1h.
- status: CONFIGURED, ACTIVATION_INPROGRESS, FAILEDACTIVATION, ACTIVATED, ALL. Default value is ACTIVATED.
- startdate: Custom time range start date/time in UTC format for filtering integrations.
- enddate: Custom time range end date/time in UTC format for filtering integrations.
- name: Integration name - Both complete and partial name search is supported.
- style: Style of integration
- 'freeform_mapmydata' - App Driven Orchestration
- 'freeform_scheduled' - Scheduled Orchestration
- 'template_mapmydata' - Basic Routing
- 'template_subscribetooic' - Subscribe to OIC
- 'template_publishtooic' - Publish to OIC
Example:
{timewindow:'2d', status:'CONFIGURED', style:'freeform_scheduled'}
-
return: string
Type of records to return.
There's no request body for this operation.
Back to TopResponse
- application/json; charset=utf-8
200 Response
object
-
data-fetch-time: string
(date-time)
Data Fetch Time
-
items: array
items
List of Monitoring Integration
-
time-window: string
Time Window
-
total-results: integer
(int64)
Total Results
object
-
flowStatus: string
-
lastUpdated: string
(date-time)
-
lastUpdatedString: string
-
mepType: string
-
nextRunDateString: string
-
noOfAborted: integer
-
noOfErrors: integer
-
noOfMsgsProcessed: integer
-
noOfMsgsReceived: integer
-
noOfSuccess: integer
-
optimizedVersion: string
-
scheduleApplicable: boolean
-
scheduleDefined: boolean
-
scheduleStatus: string
-
successRate: number
400 Response
500 Response
Examples
The following examples show how to retrieve monitoring details about activated and integrations 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 activated integrations
curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/integrations?integrationInstance=service-instance
Example: Get monitoring data for all activated integrations for the past day
curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" --data-urlencode "q={timewindow: '1d'}" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/integrations?integrationInstance=service-instance
Example: Get monitoring data for all activated integrations by integration name in alphabetical order
curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "orderBy=name" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/integrations?integrationInstance=service-instance
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://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/integrations?integrationInstance=service-instance
Example: Combine parameters - get monitoring data for the past day by integration name in alphabetical order
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: '1d'}" -d "orderBy=name" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/monitoring/integrations?integrationInstance=service-instance