RENDERSTREAM API

• GET assigners
• POST failover
• GET layerconfig
• GET layers
• GET layerstatus
• GET pools
• POST restartlayers
• POST startlayers
• POST stoplayers
• POST synclayers
• POST failoverpool

GET assigners

Summary

Returns the RenderStream assigners list

URL

GET    /api/session/renderstream/assigners

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  },
  "result": [
    {
      "uid": "",
      "name": "",
      "transport": {
        "type": "",
        "format": "",
        "bitDepth": 0
      },
      "alpha": false,
      "overlapPixels": 0,
      "paddingPixels": 0,
      "preferredNetwork": {
        "ip": "",
        "name": ""
      }
    }
  ]
}

POST failover

Summary

Fail over a single machine

URL

POST    /api/session/renderstream/failover

Request

{
  "machine": {
    "uid": "",
    "name": ""
  }
}

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  }
}

GET layerconfig

Summary

Returns config information for the selected layer

URL

GET    /api/session/renderstream/layerconfig

Query Params

uid    uint64    

name    string    

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  },
  "result": {
    "framerateFractionDivisor": 0,
    "asset": {
      "uid": "",
      "name": ""
    },
    "pool": {
      "uid": "",
      "name": ""
    },
    "channelMappings": [
      {
        "channel": "",
        "mapping": {
          "uid": "",
          "name": ""
        },
        "assigner": {
          "uid": "",
          "name": ""
        }
      }
    ],
    "defaultAssigner": {
      "uid": "",
      "name": ""
    }
  }
}

GET layers

Summary

Returns the RenderStream layer list

URL

GET    /api/session/renderstream/layers

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  },
  "result": [
    {
      "uid": "",
      "name": ""
    }
  ]
}

GET layerstatus

Summary

Returns status information for the selected layer

URL

GET    /api/session/renderstream/layerstatus

Query Params

uid    uint64    

name    string    

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  },
  "result": {
    "reference": {
      "tNow": 0
    },
    "workload": {
      "uid": "",
      "name": "",
      "instances": [
        {
          "machineUid": "",
          "machineName": "",
          "state": "",
          "healthMessage": "",
          "healthDetails": ""
        }
      ]
    },
    "streams": [
      {
        "uid": "",
        "name": "",
        "sourceMachine": "",
        "receiverMachine": "",
        "status": {
          "subscriptionWanted": false,
          "subscribeSuccessful": false,
          "tLastDropped": 0,
          "tLastError": 0,
          "lastErrorMessage": ""
        },
        "statusString": ""
      }
    ],
    "assetErrors": [
      ""
    ]
  }
}

GET pools

Summary

Returns the RenderStream pools list

URL

GET    /api/session/renderstream/pools

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  },
  "result": [
    {
      "uid": "",
      "name": "",
      "machines": [
        {
          "uid": "",
          "name": "",
          "preferredSyncAdapter": "",
          "adapters": [
            {
              "name": "",
              "ipAddress": "",
              "subnet": ""
            }
          ]
        }
      ],
      "understudies": [
        {
          "uid": "",
          "name": "",
          "preferredSyncAdapter": "",
          "adapters": [
            {
              "name": "",
              "ipAddress": "",
              "subnet": ""
            }
          ]
        }
      ]
    }
  ]
}

POST restartlayers

Summary

Restarts a workload for the selected layer

URL

POST    /api/session/renderstream/restartlayers

Request

{
  "layers": [
    {
      "uid": "",
      "name": ""
    }
  ]
}

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  }
}

POST startlayers

Summary

Starts a workload for the selected layer

URL

POST    /api/session/renderstream/startlayers

Request

{
  "layers": [
    {
      "uid": "",
      "name": ""
    }
  ]
}

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  }
}

POST stoplayers

Summary

Stops a workload for the selected layer

URL

POST    /api/session/renderstream/stoplayers

Request

{
  "layers": [
    {
      "uid": "",
      "name": ""
    }
  ]
}

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  }
}

POST synclayers

Summary

Syncs a workload for the selected layer

URL

POST    /api/session/renderstream/synclayers

Request

{
  "layers": [
    {
      "uid": "",
      "name": ""
    }
  ]
}

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  }
}

POST failoverpool

Summary

Updates a cluster pool and restarts a workload for the selected layer.

Checks all machines in the Cluster pool’s machines list. If some machines fail, it replaces them with the Understudies from the same pool.

It allows to replace a primary node as well as follower nodes.

URL

POST    /api/session/renderstream/failoverpool

Request

{
  "layer": {
    "uid": "",
    "name": ""
  }
}

Response

{
  "status": {
    "code": 0,
    "message": "",
    "details": [
      {
        "type_url": "",
        "value": ""
      }
    ]
  }
}