Concise description
- Adding a pre start will allow the application to load ahead of time, and there is no need to wait when the client accesses, making it ready to use. It should be noted that a node reserves one application instance and can open multiple instances.
Request URL
{{adminHost:8181}}/appliReserve/update
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 |
| reserveId |
120300910244232704 |
Yes |
long |
(Required) Pre start instance ID |
| lastUpdateDate |
|
Yes |
string |
(Required) Last update time |
| status |
|
No |
int |
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) |
| reserveCnt |
2 |
No |
int |
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": "保存成功"
}
Parameter Note for Success Response Example
| Field Name |
Type |
Note |
| code |
string |
None |
| message |
string |
None |
Failure Response Example
{
"code": 500,
"message": "lastUpdateDate can not be null or empty"
}
Parameter Note for Failure Response Example
| Field Name |
Type |
Note |
| code |
string |
None |
| message |
string |
None |
Note