Skip to content

Latest commit

 

History

History
53 lines (42 loc) · 1.02 KB

startbroker.md

File metadata and controls

53 lines (42 loc) · 1.02 KB

startbroker

The startbroker interface starts all brokers of databases.

Request JSON Syntax

Key Description
task task name
token token string encrypted.
async default "no", if "yes" run the task in asynchronous mode
  • The status of a task running in asynchronous mode can be checked using the 'gettaskstatus' api

Request Sample

{
  "task": "startbroker",
  "token": "4504b930fc1be99bf5dfd31fc5799faaa3f117fb903f397de087cd3544165d857926f07dd201b6aa",
  "async":"yes"
}

Response JSON Syntax

Key Description
task task name
status execution result, success or failed.
note if failed, a brief description will be given here

Response Sample

{
   "__EXEC_TIME" : "72 ms",
   "note" : "none",
   "status" : "success",
   "task" : "startbroker"
}

Response Sample (async mode)

{
   "job-status" : "running",
   "note" : "none",
   "status" : "success",
   "task" : "startbroker",
   "uuid" : "1877908931382247367"
}