Table of Contents

Search

  1. Preface
  2. Informatica Intelligent Cloud Services REST API
  3. Platform REST API version 2 resources
  4. Platform REST API version 3 resources
  5. Data Integration REST API
  6. Mass Ingestion Files REST API
  7. Mass Ingestion Streaming REST API
  8. RunAJob utility
  9. ParamSetCli utility
  10. REST API codes
  11. REST API resource quick references

REST API Reference

REST API Reference

statistics resource

statistics resource

Use the
statistics
resource to get the statistics of a
streaming ingestion
job.
The streaming ingestion job should be in one of the following status before you can view its statistics:
  • Deploying
  • Up and Running
  • Running with Warning
  • Running with Error
  • Stopped

GET request

To request the statistics of a
streaming ingestion
job, use the following URL:
<server URI>/sisvc/monitor/v1/statistics/dataflows/<dataflow ID>
You can include the following query parameters in the URI:
Parameter
Type
Required
Description
intervals
Integer
Yes
Time, in seconds, to display statistics for a streaming ingestion job. For example, if you specify 30 seconds, the response displays job statistics for the last 30 seconds.
overall
Boolean
No
Displays the statistics from the time the job is deployed.

GET request example

To request the statistics 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/statistics/dataflows/7f1daca9-3983-4677-930f-a9529802c56b?intervals=30&overall=true Content-Type: application/json Accept:application/json IDS-SESSION-ID:2l0oeVx22Rujiej7yTokmT

GET response

Returns the statistics object if successful or an error object if an error occurs.
If successful, the response includes the following information about the statistics of a
streaming ingestion
job:
Parameter
Type
Description
dataflowId
String
ID of the
streaming ingestion
job.
dataflowRunId
Integer
Run ID of the
streaming ingestion
job.
startTime
Integer
Start time of the streaming ingestion job, in milliseconds.
stopTime
Integer
Stop time of the streaming ingestion job, in milliseconds.
inMessages
Integer
The number of messages that arrive at a node. A node is a source, transformation, or target, that is used in the streaming ingestion task.
The value is zero for a source node.
outMessages
Integer
The number of messages that transfer from a node.
The value is zero for a target node.
inBytes
Integer
The total size of incoming messages in bytes.
The value is zero for a source node.
outBytes
Integer
The total size of outgoing messages in bytes.
The value is zero for a target node.
nodes
Array
Information about streaming data in the source and the target used in the task.
intervals
Integer
The statistics of the job for the time interval you specify in the request. Applies when you set an interval.

GET response example

If the request to get the statistics of a
streaming ingestion
job is successful, you might receive a response similar to the following example:
{ "dataflowId": "7f1daca9-3983-4677-930f-a9529802c56b", "dataflowName": "newnew", "dataflowVersion": 1, "dataflowRunId": 54231, "snapshotCount": 171, "overall": { "dataflowId": "7f1daca9-3983-4677-930f-a9529802c56b", "dataflowName": "newnew", "dataflowVersion": 1, "dataflowRunId": 54231, "traits": {}, "interval": 6007, "startTime": 1646649995000, "stopTime": 1646656000000, "nodes": [ { "name": "newnew_newnew_source", "id": "17a51cdf-1f27-481e-81b8-d2e8ff60ec28", "inMessages": 0, "outMessages": 0, "inBytes": 0, "outBytes": 0, "nodeType": "Unknown" }, { "name": "newnew_newnew_target", "id": "c30d6db4-6a3b-40d3-adfb-88779a972098", "inMessages": 0, "outMessages": 0, "inBytes": 0, "outBytes": 0, "nodeType": "Unknown" } ] }, "intervals": { "30": { "dataflowId": "7f1daca9-3983-4677-930f-a9529802c56b", "dataflowName": "newnew", "dataflowVersion": null, "dataflowRunId": 54231, "traits": {}, "interval": 30, "startTime": 1646655972683, "stopTime": 1646656002683, "nodes": [] } } }

0 COMMENTS

We’d like to hear from you!