search

Concise description

None

Request URL

{{adminHost:8181}}/appliReserve/search

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

serverIp
 
Yes
string
Server IP

page
 
Yes
string
Page number, default to 1

pageSize
 
Yes
string
How many pieces of data are displayed on each page, default to 20

Success Response Example

{
  "code": 1000,
  "message": "Success",
  "result": {
    "records": [
      {
        "reserveId": "1203006119274872832",
        "appliId": "1199762458126843904",
        "serverId": "c255ced0be4451c5ba5524b926a53816",
        "serverIp": "192.168.0.28",
        "exitRestart": 0,
        "codeRate": 8000,
        "frameRate": 60,
        "reserveCnt": 1,
        "runningCnt": 0,
        "usingCnt": 0,
        "status": 1,
        "autoAdjustFlag": 0,
        "minCnt": 0,
        "maxCnt": 0,
        "minIdleCnt": 0,
        "maxIdleCnt": 0,
        "hesitateTime": 0,
        "multiUserInteractionFlag": "0",
        "updateDate": "1706860609608",
        "appliName": "test33"
      }
    ],
    "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. reserveId
string
Pre start Id

records. appliId
string
Application ID

records. serverId
string
render node ID

records. serverIp
string
rendering node IP

records. exitRestart
string
Whether to restart the application after the client exits, 0 does not restart, 1 restarts

records. codeRate
string
bit rate

records. frameRate
string
frame rate

records. reserveCnt
string
Number of pre starts

records. runningCnt
string
Number of pre starts running on the server side

records. usingCnt
string
The number of pre starts that the client is currently using

records. status
string
1: Enable 0: Disabled (only retains the pre-start setting, but the rendering node does not start application information, and pre-start information disabled in the exchange information interface is not returned to the rendering node)

records. autoAdjustFlag
string
Whether to automatically adjust, default to 0. 0: not enabled, 1: enabled

records. minCnt
string
During the use of the minimum value application, the rendering server needs to continuously supplement the pre start application to meet the minimum idle. When the application exits, the number of idle increases. When the number of idle exceeds the maximum idle, the rendering service will exit the excess pre start application. When the remaining pre start number equals the minimum value, stop exiting.

records. maxCnt
string
During the use of the maximum value application, the rendering server needs to continuously supplement the pre start application to meet the minimum idle. Set a maximum value here to cap the total number of applications started.

records. minIdleCnt
string
During the process of using the minimum number of idle applications, the rendering server needs to continuously supplement pre started applications to meet the minimum idle.

records. maxIdleCnt
string
During the use of the maximum number of idle applications, the rendering server needs to continuously supplement the pre start applications to meet the minimum idle. When the application exits, the idle number increases. When the idle number exceeds the maximum idle number, the rendering service will exit the excess pre start applications.

records. hestateTime
string
None

records. multiUserInteractionFlag
string
Whether to enable 2.5D multi-user interaction (currently not used)

records. updateDate
string
Update time

records. appliName
string
Application name

total
string
None

size
string
None

current
string
None

orders
array
None

optimizeCountSql
string
None

searchCount
string
None

pages
string
None

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]

Field Name	Required	Type	Note
appliId	Yes	string	Application ID
serverIp	Yes	string	Server IP
page	Yes	string	Page number, default to 1
pageSize	Yes	string	How many pieces of data are displayed on each page, default to 20

Field Name	Type	Note
code	string	None
message	string	None
result	object	None
records	array	None
records. reserveId	string	Pre start Id
records. appliId	string	Application ID
records. serverId	string	render node ID
records. serverIp	string	rendering node IP
records. exitRestart	string	Whether to restart the application after the client exits, 0 does not restart, 1 restarts
records. codeRate	string	bit rate
records. frameRate	string	frame rate
records. reserveCnt	string	Number of pre starts
records. runningCnt	string	Number of pre starts running on the server side
records. usingCnt	string	The number of pre starts that the client is currently using
records. status	string	1: Enable 0: Disabled (only retains the pre-start setting, but the rendering node does not start application information, and pre-start information disabled in the exchange information interface is not returned to the rendering node)
records. autoAdjustFlag	string	Whether to automatically adjust, default to 0. 0: not enabled, 1: enabled
records. minCnt	string	During the use of the minimum value application, the rendering server needs to continuously supplement the pre start application to meet the minimum idle. When the application exits, the number of idle increases. When the number of idle exceeds the maximum idle, the rendering service will exit the excess pre start application. When the remaining pre start number equals the minimum value, stop exiting.
records. maxCnt	string	During the use of the maximum value application, the rendering server needs to continuously supplement the pre start application to meet the minimum idle. Set a maximum value here to cap the total number of applications started.
records. minIdleCnt	string	During the process of using the minimum number of idle applications, the rendering server needs to continuously supplement pre started applications to meet the minimum idle.
records. maxIdleCnt	string	During the use of the maximum number of idle applications, the rendering server needs to continuously supplement the pre start applications to meet the minimum idle. When the application exits, the idle number increases. When the idle number exceeds the maximum idle number, the rendering service will exit the excess pre start applications.
records. hestateTime	string	None
records. multiUserInteractionFlag	string	Whether to enable 2.5D multi-user interaction (currently not used)
records. updateDate	string	Update time
records. appliName	string	Application name
total	string	None
size	string	None
current	string	None
orders	array	None
optimizeCountSql	string	None
searchCount	string	None
pages	string	None