Get activated service

GET

https://device.example.com/cluster1/vos-api/monitor/v1/services/:id

GET

/cluster1/vos-api/monitor/v1/services/:id

curl https://device.example.com/cluster1/vos-api/monitor/v1/services/id \
     -H "Authorization: Bearer <token>"

{
  "activeInstanceId": "string",
  "destinationStatus": {
    "destinationStatistics": {
      "outputStatIn12h": {
        "packetsCount": 1,
        "recoveredPacketCount": 1,
        "time": "2024-01-15T09:30:00Z",
        "unrecoveredPacketCount": 1
      },
      "outputStatIn1h": {
        "packetsCount": 1,
        "recoveredPacketCount": 1,
        "time": "2024-01-15T09:30:00Z",
        "unrecoveredPacketCount": 1
      },
      "outputStatIn24h": {
        "packetsCount": 1,
        "recoveredPacketCount": 1,
        "time": "2024-01-15T09:30:00Z",
        "unrecoveredPacketCount": 1
      }
    },
    "id": "string",
    "name": "string",
    "outputStatus": [
      {
        "id": "string",
        "outputDeliveryStatus": [
          {
            "deliveryType": "string",
            "outputDeliveryIndex": 1,
            "outputStatistic": [
              {
                "outputBitrate": 1,
                "recoveredPacketCount": 1,
                "time": "2024-01-15T09:30:00Z",
                "unrecoveredPacketCount": 1,
                "usageCategory": "IP",
                "sdiStatistic": {
                  "phaseOffset": 1
                }
              }
            ],
            "status": "ACTIVE"
          }
        ]
      }
    ]
  },
  "downlinkOutputStatus": {
    "downlinkOutputStatistic": [
      {
        "outputId": "string",
        "outputStatistic": [
          {
            "outputBitrate": 1,
            "recoveredPacketCount": 1,
            "time": "2024-01-15T09:30:00Z",
            "unrecoveredPacketCount": 1,
            "usageCategory": "IP",
            "sdiStatistic": {
              "phaseOffset": 1
            }
          }
        ],
        "addressAndPort": "string"
      }
    ]
  },
  "id": "string",
  "muteOperationData": {
    "enabled": true,
    "endTime": "string",
    "startTime": "string"
  },
  "name": "string",
  "originStatus": {
    "originStatistic": [
      {
        "originStatisticEntryList": [
          {
            "pullBitrate": 1,
            "time": "2024-01-15T09:30:00Z"
          }
        ],
        "packagingFormat": "string"
      }
    ]
  },
  "outputTsStatus": [
    {
      "outputPids": [
        {
          "inputPids": [
            {
              "inputPidConfigured": 1,
              "inputPidUsed": 1
            }
          ],
          "outputPid": 1
        }
      ]
    }
  ],
  "outputVideoPorfileStatus": [
    {
      "framerateDenominator": 1,
      "framerateNumerator": 1,
      "interlaced": true,
      "resolutionHeight": 1,
      "resolutionWidth": 1
    }
  ],
  "processingDockerImage": "string",
  "processingEngine": "string",
  "processingStatus": {
    "enableScte104Oob": true,
    "outputAudioProfileStatus": {},
    "outputDataProfileStatus": {},
    "outputVideoCodec": "MULTISCREEN_HEVC",
    "processingAudioLanguages": [
      "string"
    ],
    "processingStatistic": [
      {
        "processingBitrate": 1,
        "time": "2024-01-15T09:30:00Z"
      }
    ],
    "speechToTextStatus": {
      "audioCount": 1
    }
  },
  "sourceStatus": [
    {
      "ccErrorStatistic": [
        {
          "ccErrorStatisticEntryList": [
            {
              "ccErrCount": 1,
              "hasPCR": "string",
              "packetCount": 1,
              "pid": "string",
              "pidType": "VIDEO",
              "time": "2024-01-15T09:30:00Z"
            }
          ],
          "resetInMs": 1,
          "time": "2024-01-15T09:30:00Z"
        }
      ],
      "id": "string",
      "inputStatus": [
        {
          "id": "string",
          "inputDeliveryStatus": [
            {
              "inputAddressPort": "string",
              "inputIndex": 1,
              "inputStatistic": [
                {
                  "inputBitrate": 1,
                  "recoveredPacketCount": 1,
                  "time": "2024-01-15T09:30:00Z",
                  "unrecoveredPacketCount": 1,
                  "usageCategory": "IP",
                  "ccErrorCount": 1,
                  "pathIndex": 1,
                  "receivedPacketCount": 1,
                  "rtpInputStatistics": {
                    "lostPackets": 1,
                    "orderErrors": 1
                  },
                  "smpte2022_1Fec": {
                    "columnsL": 1,
                    "rowsD": 1
                  },
                  "smpte2022_7TsInput": {
                    "lostRtpPrimary": 1,
                    "lostRtpSecondary": 1
                  },
                  "srtInputStatistics": {
                    "ackPacketCount": 1,
                    "bandwidth": 1.1,
                    "belatedPacketCount": 1,
                    "connectionAge": 1,
                    "nackPacketCount": 1,
                    "negociatedLatency": 1,
                    "receivedPacketTotal": 1,
                    "recoveredPacketTotal": 1,
                    "retransPacketCount": 1,
                    "rtt": 1.1,
                    "srtReconnectionCount": 1,
                    "unrecoveredPacketTotal": 1
                  }
                }
              ]
            }
          ],
          "inputStatistic": [
            {
              "inputBitrate": 1,
              "recoveredPacketCount": 1,
              "time": "2024-01-15T09:30:00Z",
              "unrecoveredPacketCount": 1,
              "usageCategory": "IP",
              "ccErrorCount": 1,
              "pathIndex": 1,
              "receivedPacketCount": 1,
              "rtpInputStatistics": {
                "lostPackets": 1,
                "orderErrors": 1
              },
              "smpte2022_1Fec": {
                "columnsL": 1,
                "rowsD": 1
              },
              "smpte2022_7TsInput": {
                "lostRtpPrimary": 1,
                "lostRtpSecondary": 1
              },
              "srtInputStatistics": {
                "ackPacketCount": 1,
                "bandwidth": 1.1,
                "belatedPacketCount": 1,
                "connectionAge": 1,
                "nackPacketCount": 1,
                "negociatedLatency": 1,
                "receivedPacketTotal": 1,
                "recoveredPacketTotal": 1,
                "retransPacketCount": 1,
                "rtt": 1.1,
                "srtReconnectionCount": 1,
                "unrecoveredPacketTotal": 1
              }
            }
          ],
          "status": "ACTIVE",
          "defaultInput": true,
          "resetDateStatistic": "2024-01-15T09:30:00Z"
        }
      ],
      "name": "string",
      "sourceHeight": 1,
      "sourceVideoCodec": "MP2",
      "sourceWidth": 1,
      "status": "ACTIVE"
    }
  ]
}

Get activated service.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Response

activeInstanceIdstring

The active instance ID of service

destinationStatusobject

downlinkOutputStatusobject

idstring

Unique identifier of a service in UUID format

muteOperationDataobject

namestring

Display name of a service

originStatusobject

outputTsStatuslist of objects

Display output PIDs and related input PIDs

outputVideoPorfileStatuslist of objects

The processing profile

processingDockerImagestring

Custom processing docker image using by the service.

processingEnginestring

App key of the processing engine used by the service.

processingStatusobject

sourceStatuslist of objects

The status of source

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error