search

Request URL

{{adminHost:8181}}/renderServer/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


regionId
 
No
string
The region ID of the server, when starting the rendering service, the cluster partition ID configured by the startup manager

serverName
 
No
string
Server Name

status
 
No
string
Node status. 1: Effective 3: Freeze 5: Shake 11: Offline 14: Offline Freeze

serverIp
 
No
string
Server Ip

page
 
No
string
Page number, default to 1

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

Success Response Example

{
  "code": 1000,
  "message": "Success",
  "result": {
    "records": [
      {
        "serverId": "c255ced0be4451c5ba5524b926a53816",
        "serverName": "",
        "regionId": "test",
        "regionName": "测试",
        "serverIp": "192.168.0.28",
        "publicIp": "",
        "preferPublicIp": "",
        "serverPort": 10002,
        "syncPort": 8089,
        "certDomainUrl": "",
        "sslPort": 10004,
        "coefficient": 100,
        "freeSpace": "67",
        "gpuCnt": 1,
        "gpuMaxConcurrentCnt": 0,
        "status": 1,
        "failCntInPeriod": 0,
        "firstFailDateInPeriod": "0",
        "createDate": "1704854632622",
        "updateDate": "1707028826453",
        "syncing": false,
        "groupId": [
          "601477834145267712",
          "1194226279482654720"
        ],
        "groupName": [
          "Default",
          "ssss"
        ]
      }
    ],
    "total": "1",
    "size": "20",
    "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. serverId
string
Server Id

records. serverName
string
Server name

records. regionId
string
The region ID to which the rendering server belongs

records. regionName
string
The name of the region to which the rendering server belongs

records. serverIp
string
rendering server IP

records. publicIp
string
Public IP

records. preferPublicIP
string
Priority public IP

records. serverPort
string
rendering service port

records. syncPort
string
Sync Service Port

records. certDomainUrl
string
SSL domain name

records. sslPort
string
SSL port

records. coefficient
string
The heterogeneity factor of a server is set to 100 by default. A larger value indicates better server performance and higher supported concurrency. Under the simple allocation principle, it is used to limit server concurrency, where 100 represents one concurrency, 200 represents two concurrency, and so on. Under the general allocation principle, it represents the heterogeneity factor of the server.

records. freeSpace
string
The maximum remaining space on a node’s disk (the one with the highest remaining space when there are multiple disks), * used to obtain unsynchronized nodes during semi-active synchronization and prioritize the use of the remaining node with the highest remaining space.

records. gpuCnt
string
Number of GPUs for a node

records. gpuMaxConcurrentCnt
string
Maximum concurrency limit for a single GPU

records. status
string
Server status, 1: valid 3: frozen 5: jitter 11: offline 14: offline frozen

records. fail CntInPeriod
string
Number of failed attempts to go online

records. firstFailDateInPeriod
string
The time when the first launch failed

records. createDate
string
Creation time

records. updateDate
string
Update time

records. syncing
string
Does the node have an application being synchronized? False indicates that it is not synchronized.

records. groupId
array
Group Id; returns [] when the rendering node is not bound to a group

records. groupName
array
Group name; returns [] when the rendering node is not bound to a group

total
string
How many pieces of data in total

size
string
How many pieces of data per page

current
string
Current page number

pages
string
How many pages are there in total

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
regionId	No	string	The region ID of the server, when starting the rendering service, the cluster partition ID configured by the startup manager
serverName	No	string	Server Name
status	No	string	Node status. 1: Effective 3: Freeze 5: Shake 11: Offline 14: Offline Freeze
serverIp	No	string	Server Ip
page	No	string	Page number, default to 1
pageSize	No	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. serverId	string	Server Id
records. serverName	string	Server name
records. regionId	string	The region ID to which the rendering server belongs
records. regionName	string	The name of the region to which the rendering server belongs
records. serverIp	string	rendering server IP
records. publicIp	string	Public IP
records. preferPublicIP	string	Priority public IP
records. serverPort	string	rendering service port
records. syncPort	string	Sync Service Port
records. certDomainUrl	string	SSL domain name
records. sslPort	string	SSL port
records. coefficient	string	The heterogeneity factor of a server is set to 100 by default. A larger value indicates better server performance and higher supported concurrency. Under the simple allocation principle, it is used to limit server concurrency, where 100 represents one concurrency, 200 represents two concurrency, and so on. Under the general allocation principle, it represents the heterogeneity factor of the server.
records. freeSpace	string	The maximum remaining space on a node’s disk (the one with the highest remaining space when there are multiple disks), * used to obtain unsynchronized nodes during semi-active synchronization and prioritize the use of the remaining node with the highest remaining space.
records. gpuCnt	string	Number of GPUs for a node
records. gpuMaxConcurrentCnt	string	Maximum concurrency limit for a single GPU
records. status	string	Server status, 1: valid 3: frozen 5: jitter 11: offline 14: offline frozen
records. fail CntInPeriod	string	Number of failed attempts to go online
records. firstFailDateInPeriod	string	The time when the first launch failed
records. createDate	string	Creation time
records. updateDate	string	Update time
records. syncing	string	Does the node have an application being synchronized? False indicates that it is not synchronized.
records. groupId	array	Group Id; returns [] when the rendering node is not bound to a group
records. groupName	array	Group name; returns [] when the rendering node is not bound to a group
total	string	How many pieces of data in total
size	string	How many pieces of data per page
current	string	Current page number
pages	string	How many pages are there in total