Get activated service's status by service Id

GET

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

GET

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

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

{
  "audioOnlyService": true,
  "cloudlinkGroupIds": [
    "string"
  ],
  "configureServiceType": "LIVE",
  "controlState": "ACTIVATED",
  "id": "string",
  "labels": [
    "string"
  ],
  "name": "string",
  "priority": "LOW",
  "serviceType": "OTT",
  "liveEventStatus": {
    "confidenceMonitoring": true,
    "endTimeInUtc": "string",
    "esamPoisOobPosted": true,
    "playlistEndSignaled": true,
    "prepared": true,
    "prerollDuration": 1,
    "prerollSlate": "string",
    "recording": true,
    "signalProcessingNotification": {
      "slateOff": {
        "acquisitionPointId": "string",
        "acquisitionSignalId": "string",
        "action": "string",
        "altContentIdentity": "string",
        "utcPoint": {
          "chronology": {
            "calendarType": "string",
            "id": "string"
          },
          "dayOfMonth": 1,
          "dayOfWeek": "MONDAY",
          "dayOfYear": 1,
          "hour": 1,
          "minute": 1,
          "month": "JANUARY",
          "monthValue": 1,
          "nano": 1,
          "second": 1,
          "year": 1
        },
        "zoneIdentity": "string"
      },
      "slateOn": {
        "acquisitionPointId": "string",
        "acquisitionSignalId": "string",
        "action": "string",
        "altContentIdentity": "string",
        "utcPoint": {
          "chronology": {
            "calendarType": "string",
            "id": "string"
          },
          "dayOfMonth": 1,
          "dayOfWeek": "MONDAY",
          "dayOfYear": 1,
          "hour": 1,
          "minute": 1,
          "month": "JANUARY",
          "monthValue": 1,
          "nano": 1,
          "second": 1,
          "year": 1
        },
        "zoneIdentity": "string"
      }
    },
    "slateEnabled": true,
    "startTimeInUtc": "string",
    "state": "OFFLINE",
    "uoeNotified": true
  },
  "muteOperationData": {
    "enabled": true,
    "endTime": "string",
    "startTime": "string"
  },
  "operationalState": "OFFLINE",
  "serviceStartTime": "2024-01-15T09:30:00Z"
}

Get service status in the system by service Id.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

Success

audioOnlyServiceboolean

Indication of an audio-only service

cloudlinkGroupIdslist of strings

List of CloudlinkGroups used in service.

configureServiceTypeenum

The type of the service from service configure

Allowed values:

controlStateenum

The service's control state

Allowed values:

idstring

Unique identifier of a service in UUID format

labelslist of strings

List of labels.

namestring

Display name of a service

priorityenum

The service's priority

Allowed values:

serviceTypeenum

Display type of the service

Allowed values:

liveEventStatusobjectOptional

muteOperationDataobjectOptional

operationalStateenumOptional

The state of operation

Allowed values:

serviceStartTimedatetimeOptional

The last start/restart time of the RmpWorker datapath. Null when the service is stopped.

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error