command element

Type:

Provides detailed information about a submitted command.

There are two types of commands: synchronous and asynchronous. Synchronous commands complete immediately, and their results are passed back in the returned command object after the execution of an API call. Outside of that returned object, there is no way to check the result of a synchronous command.

Asynchronous commands have unique non-negative IDs. They may still be running when the API call returns. Clients can check the status of such commands using the API.

Example JSON

{
  "id" : ...,
  "name" : "...",
  "startTime" : "...",
  "endTime" : "...",
  "active" : false,
  "success" : false,
  "resultMessage" : "...",
  "resultDataUrl" : "...",
  "clusterRef" : {
    "clusterName" : "..."
  },
  "serviceRef" : {
    "clusterName" : "...",
    "serviceName" : "..."
  },
  "roleRef" : {
    "clusterName" : "...",
    "serviceName" : "...",
    "roleName" : "..."
  },
  "hostRef" : {
    "hostId" : "..."
  },
  "parent" : {
    "..." : ...
  },
  "children" : {
    "items" : [ {
      "..." : ...
    }, ... ]
  }
}