status resource
Use the status resource to get the status of a streaming ingestion job.
GET request
To request the status of a streaming ingestion job, use the following URL:
<server URI>/sisvc/monitor/v1/status/dataflows/<dataflow ID>
GET request example
To get the status of a streaming ingestion job, you might send a request similar to the following example:
POST https://usw1-ing.dm2-us.informaticacloud.com/sisvc/monitor/v1/status/dataflows/1948938e-3923-4602-aba8-f122e3d66faf
Content-Type: application/json
Accept:application/json
IDS-SESSION-ID:2l0oeVx22Rujiej7yTokmT
GET response
Returns the job status object if successful or an error object if an error occurs.
If successful, the response includes the following information about the status of a streaming ingestion job:
Parameter | Type | Description |
|---|
dataflowName | String | Name of the streaming ingestion job. |
dataflowId | Integer | ID of the streaming ingestion job. |
status | String | The status of the streaming ingestion job. A job can be in one of the following status: - - Deploying. The job is being deployed.
- - Up and Running. The job is running.
- - Running with Warning. The job is running with warnings.
- - Running with Error. The job is running with error.
- - Undeployed. The job is undeployed.
- - Stopped. The job was intentionally stopped.
|
timestamp | Integer | Time, in milliseconds, when the Secure Agent records the status of the streaming ingestion job. |
reports | Array | Status details of each node. |
graph | String | The throughput information for the source and target of the job. |
runId | Integer | Run ID of the streaming ingestion job. The ID changes for every deployment. |
GET response example
If the request to get the status of a streaming ingestion job is successful, you might receive a response similar to the following example:
{
"dataflowName": "testmonitor",
"dataflowId": "1948938e-3923-4602-aba8-f122e3d66faf",
"status": "Running",
"timestamp": 1644839755000,
"reports": [
{
"name": "testmonitor_testmonitor_source",
"id": "a5684428-f41f-4d24-b73f-33c232314a91",
"status": "Running",
"timestamp": 1644839756000,
"message": null
},
{
"name": "testmonitor_testmonitor_target",
"id": "4f59b5fb-b5b2-4b83-994b-0d3e56f67e22",
"status": "Running",
"timestamp": 1644839756000,
"message": null
}
],
"graph": "{\"agentId\":\"011ZFB0800000000000N\",\"nodes\":[{\"id\":\"a5684428-f41f-4d24-b73f-33c232314a91\",\"name\":\"testmonitor_source\",\"serviceType\":\"source\",\"config\":[{\"key\":\"_nativeName\",\"value\":\"src\"},{\"key\":\"consumerProperties\",\"value\":null}],\"connectionId\":\"011ZFB0B0000000000KJ\",\"type\":\"\",\"metaMetadata\":\"\"},{\"id\":\"4f59b5fb-b5b2-4b83-994b-0d3e56f67e22\",\"name\":\"testmonitor_target\",\"serviceType\":\"target\",\"config\":[{\"key\":\"_nativeName\",\"value\":\"trgt\"},{\"key\":\"batchSize\",\"value\":\"1048576\"},{\"key\":\"mdFetchTimeout\",\"value\":\"5000\"},{\"key\":\"producerProperties\",\"value\":null}],\"connectionId\":\"011ZFB0B0000000000KJ\",\"type\":\"\",\"metaMetadata\":\"\"}],\"edges\":[{\"id\":\"6ae185ea-7e6e-4bf6-bd9e-0be5ef3a8e78\",\"name\":\"testmonitor_source_testmonitor_target\",\"from\":\"testmonitor_source\",\"to\":\"testmonitor_target\",\"type\":\"success\",\"config\":[],\"metaMetadata\":\"\"}],\"runtimeOptions\":null}",
"version": 1,
"runId": 42563
}