LarkXR3.3 API

getRunningAppliList

Concise description
  • None
Request URL
  • {{adminHost:8181}}/taskInfo/getRunningAppliList
Request Method
  • get
Header
Field Name Sample Required Type Note
adminKey 603284317954637824 Yes string This parameter is for backend management access credentials, which can be viewed in LarkXR3.3 backend access management
timestamp 8641706679604867 Yes string The timestamp when sending a request, in milliseconds
signature 9A02B47AE67664D80A2ED13FC2B1691512613790 Yes string This parameter is a key signature. Sort the adminKey (viewed in LarkXR3.2 backend access management), adminSecret (viewed in LarkXR3.3 backend access management), and current timestamp (long value) in alphabetical order, and then perform SHA-1 summary signature. Please refer to the example of [Obtaining Voucher Signature]
Request Query Parameters
Field Name Sample Required Type Note
appliId   Yes string Application ID, when not empty, returns the number of runs for a specific application
appliType 14,2 Yes string Application type, separated by commas when there are multiple types. 1: Exclusive GPU, 2: Shared GPU, 3: VR (SteamVR), 5: VR (SteamVR: Dependent on Steam), 6: VR (Nvidia), 7: VR (OpenXR), 9: AR (PXY), 11: AR (Nvidia), 13: SR (Shared GPU-UE Pixel Streaming), 14: SR (2D Sharing)). Returns the number of runs for a specific application type when not empty.
serverId c255ced0be4451c5ba5524b926a53816 No string When rendering node ID is not empty, return the number of runs on a specific node
wsId Jx3wQMD No string The workspace ID, when not empty, returns the number of runs on a specific workspace.
taskId   No string TaskId, if the task has finished running, return empty
clientIp   No string Client IP, if the client is offline, return empty
page   Yes string None
pageSize   Yes string None
Success Response Example
{
  "code": 1000,
  "message": "Success",
  "result": {
    "records": [
      {
        "taskId": "1202935225147981824",
        "status": 3,
        "startProcType": 0,
        "startAt": "1706843707148",
        "endAt": "0",
        "serverId": "c255ced0be4451c5ba5524b926a53816",
        "serverIp": "192.168.0.28",
        "publicIp": "",
        "clientIp": "192.168.0.28",
        "appliId": "1199762458126843904",
        "appliType": 2,
        "accessType": 1,
        "wsId": "Jx3wQMD1",
        "limitMaxFps": 1,
        "offScreen": 1,
        "useGamepad": 0,
        "dcs": 1,
        "playMode": 1,
        "scs": 0,
        "audioInput": 0,
        "audioInputAutoStart": 0,
        "videoInput": 0,
        "videoInputAutoStart": 0,
        "videoInputCnt": 1,
        "liveStreaming": 0,
        "qpMin": 20,
        "qpMax": 35,
        "taskCloseType": 0,
        "delayCloseDuration": 20,
        "reqGpuMemMax": 0,
        "useWebCodec": 0,
        "preferDecoder": "h264",
        "playerMode": 0,
        "playerListToggle": 1,
        "adminViewer": 0,
        "reserveFlag": 0,
        "clientStartSuccess": 1,
        "clientSuccessDate": "1706843708664",
        "useSdkFlag": 0,
        "createDate": "1706843707148",
        "updateDate": "1706843709881",
        "appliName": "test33",
        "wm": "1"
      }
    ],
    "total": "1",
    "size": "15",
    "current": "1",
    "orders": [],
    "optimizeCountSql": true,
    "searchCount": true,
    "pages": "1"
  }
}
Parameter Note for Success Response Example
Field Name Type Note
code string None
message string None
result object None
records array None
records. appliName string Application name
records. taskId string Task Id
records. status string Running status, 3 is running, 9 has ended
records. startProcType string In exclusive mode, the startup mode is mostly standard mode: 0, and a few are compatibility mode: 1
records. startAt string Start time, timestamp (ms)
records. endAt string End time, timestamp (ms)
records. serverId string None
records. serverIp string None
records. publicIp string Server public IP
records. clientIp string Client IP
records. appliId string Application Id
records. appliType string Application types: 1: Exclusive GPU, 2: Shared GPU, 3: VR (SteamVR), 5: VR (SteamVR: Dependent on Steam), 6: VR (Nvidia), 7: VR (OpenXR), 9: AR (PXY), 11: AR (Nvidia), 13: SR (Shared GPU-UE Pixel Streaming), 14: SR (2D Sharing)
records. accessType string 1: Public application, 0: Private application
records. wsId string Workplace Id
records. limitMaxFps string Whether to limit the frame rate of the application itself in shared mode, default to 1; 0: No, 1: Yes
records. offScreen string Whether to render off screen? Off screen rendering can reduce some resource consumption, default is 1. 0: not. 1: yes
records. useGamepad string Whether the application uses a controller, default to 0; 0: not used, 1: used
records. dcs string Does the application level support data channel services? 1 supports, 0 does not.
records. playMode string Does the application level support interactive mode? 1 supports, 0 does not.
records. scs string Whether the application uses intelligent voice services, 1 uses, 0 does not use
records. audioInput string Whether to enable the client audio (microphone) input function, 1 enabled, 0 not enabled
records. audioInputAutoStart string Whether to automatically turn on the microphone, 1 on, 0 not on
records. videoInput string Whether to enable the client video (camera) input function, 1 enabled, 0 not enabled
records. videoInputAutoStart string Whether to automatically turn on the camera
records. videoInputCnt string Number of cameras used by the application
records. liveStreaming string Whether to enable live streaming, 1 enabled, 0 not enabled
records. qpMin string encoding qp minimum value
records. qpMax string Maximum value of encoding qp
records. taskCloseType string Instance shutdown method: 0 immediate shutdown (default), 1 delayed shutdown
records. delayCloseDuration string Delay time for closing delay, in seconds, default to 20 seconds
records. reqGpuMemMax string Maximum GPU memory demand (in units of M), used to check if there is sufficient memory when allocating requests. The default value is 0: does not consider the current application memory demand, only checks the current GPU memory usage.
records. useWebCodec string Whether to use WebCodec, 0: Do not use, 1: Use
records. preferDecoder string Priority decoding format standards: ‘auto’, ‘vp8’, ‘vp9’, ‘h264’, ‘h265’, ‘hevc’, ‘av1’, ‘av1x’, default value of h264
records. playerMode string Does the application level support interactive mode? 1 supports, 0 does not.
records. playerListTag string Whether to display player list in demonstration/interactive mode, default to 1; 0: No, 1: Yes
records. adminViewer string Is it a remote desktop feature? 0: No 1: Yes
records. reserveFlag string Did you use pre start? 0: No 1: Yes
records. clientStartSuccess string Whether the client was successfully started. 0: No 1: Yes
records. clientSuccessDate string The timestamp (ms) of the successful start of the client
records. useSdkFlag string Did you use SDK?
records. createDate string None
records. updateDate string None
total string None
size string None
current string None
orders array None
optimizeCountSql string None
searchCount string None
pages string None
Note
admin 2025年4月8日 14:20 收藏文档