Concise description
- 添加预启动会让应用提前加载好，客户端访问时None需等待，即点即用。需要注意，一个节点预留一种应用实例，可以开多个。
Request URL
{{adminHost:8181}}/appliReserve/add
Request Method
| 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 Body Parameters
| Field Name |
Sample |
Required |
Type |
Note |
| appliId |
1196464974600339456 |
Yes |
long |
(Required) Application ID |
| serverId |
c255ced0be4451c5ba5524b926a53816 |
Yes |
string |
(Required) rendering node ID |
| serverIp |
192.168.0.28 |
Yes |
string |
(Required) Rendering node IP |
| reserveCnt |
2 |
Yes |
int |
(Required) Number of reserved instances |
| exitRestart |
|
No |
int |
Whether to restart the application after the client exits, 0 does not restart, 1 restarts |
| codeRate |
|
No |
int |
Code rate, default to 80 |
| frameRate |
|
No |
int |
Frame rate, default to 30 |
| autoAdjustFlag |
|
No |
int |
Whether to automatically adjust, default to 0. 0: not enabled, 1: enabled |
| minCnt |
|
No |
int |
During the use of the minimum value application, the rendering server needs to continuously replenish pre started applications to meet the minimum idle. When the application exits, the number of idle applications increases. When the number of idle applications exceeds the maximum idle number, the rendering service will exit the excess pre started applications. When the remaining number of pre started applications equals the minimum value, stop exiting. |
| maxCnt |
|
No |
int |
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 launched. |
| minIdleCnt |
|
No |
int |
During the process of using the minimum number of idle applications, the rendering server needs to continuously replenish pre started applications to meet the minimum idle. |
| maxIdleCnt |
|
No |
int |
During the use of the maximum number of idle applications, the rendering server needs to continuously supplement pre started applications 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 started applications. |
| hestateTime |
|
No |
int |
None |
Success Response Example
{
"code": 1000,
"message": "success"
}
Parameter Note for Success Response Example
| Field Name |
Type |
Note |
| code |
string |
None |
| message |
string |
None |
Failure Response Example
{
"code": 500,
"message": "该渲染节点已经有其他预留实例"
}
Parameter Note for Failure Response Example
| Field Name |
Type |
Note |
| code |
string |
None |
| message |
string |
None |
Note