简要描述
请求URL
{{adminHost:8181}}/renderServer/search
请求方式
字段名 |
示例值 |
必选 |
类型 |
说明 |
adminKey |
603284317954637824 |
是 |
string |
该参数为后台管理接入凭证,在LarkXR3.3后台接入管理中查看 |
timestamp |
8641706679604867 |
是 |
string |
发送请求时的时间戳,单位为毫秒 |
signature |
9A02B47AE67664D80A2ED13FC2B1691512613790 |
是 |
string |
该参数为密钥签名。将adminKey(LarkXR3.2后台接入管理中查看)和adminSecret(LarkXR3.3后台中接入管理查看)和当前时间戳(long型数值)按字母序排序,然后进行SHA-1摘要签名。请参考【获取凭证签名】的样例 |
请求Query参数
参数名 |
示例值 |
必选 |
类型 |
说明 |
regionId |
|
否 |
string |
服务器所属区域Id,在启动渲染服务时,在启动管理器配置的集群分区ID |
serverName |
|
否 |
string |
服务器名称 |
status |
|
否 |
int |
节点状态。1:有效 3:冻结 5:抖动 11:离线 14:离线冻结 |
serverIp |
|
否 |
string |
服务器Ip |
page |
|
否 |
int |
页码,默认是1 |
pageSize |
|
否 |
int |
每页有多少条数据,默认是20 |
成功返回示例
{
"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"
}
}
成功返回示例的参数说明
参数名 |
类型 |
说明 |
code |
string |
无 |
message |
string |
无 |
result |
object |
无 |
records |
array |
无 |
records.serverId |
string |
服务器Id |
records.serverName |
string |
服务器名称 |
records.regionId |
string |
渲染服务器所属的区域Id |
records.regionName |
string |
渲染服务器所属的区域名称 |
records.serverIp |
string |
渲染服务器Ip |
records.publicIp |
string |
公网Ip |
records.preferPublicIp |
string |
优先公网IP |
records.serverPort |
string |
渲染服务端口 |
records.syncPort |
string |
同步服务端口 |
records.certDomainUrl |
string |
SSL域名 |
records.sslPort |
string |
SSL端口 |
records.coefficient |
string |
服务器的异构因子,默认为100。值越大表明服务器性能越佳,支撑的并发数越高。简易分配原则下,用于限制服务器并发数,100表示一个并发,200表示2个并发,以此类推。通用分配原则下,表示服务器的异构因子。 |
records.freeSpace |
string |
节点磁盘最大剩余空间(多磁盘时剩余最多的那个), * 用于半主动同步时获取未同步的节点按优先使用剩余最多的节点 |
records.gpuCnt |
string |
节点的GPU数量 |
records.gpuMaxConcurrentCnt |
string |
单个GPU最大并发数量限制 |
records.status |
string |
服务器状态,1:有效 3:冻结 5:抖动 11:离线 14:离线冻结 |
records.failCntInPeriod |
string |
上线失败次数 |
records.firstFailDateInPeriod |
string |
第一次上线失败的时间 |
records.createDate |
string |
创建时间 |
records.updateDate |
string |
更新时间 |
records.syncing |
string |
节点是否存在正在同步应用,false表示没有正在同步 |
records.groupId |
array |
组别Id;渲染节点没有绑定组别时,返回是[] |
records.groupName |
array |
组别名称;渲染节点没有绑定组别时,返回是[] |
total |
string |
共计多少条数据 |
size |
string |
每页多少条数据 |
current |
string |
当前页码 |
pages |
string |
一共有多少页 |
备注