ambari/ambari-server/docs/api/v1/requests.md

List Requests

Back to Resources

Summary

Returns a collection of all requests for the cluster identified by ":clusterName".

GET /clusters/:clusterName/requests

Response

<th>HTTP CODE</th>
<th>Description</th>

<td>200</td>
<td>OK</td>  

<td>400</td>
<td>Bad Request</td>  

<td>401</td>
<td>Unauthorized</td>  

<td>403</td>
<td>Forbidden</td>  

<td>404</td>
<td>Not Found</td>  

<td>500</td>
<td>Internal Server Error</td>  

Example

Get the collection of the requests for the cluster named "c1".

GET /clusters/c1/requests?fields=Requests/request_context

200 OK
{
    "href" : "http://your.ambari.server/api/v1/clusters/c1/requests?fields=Requests/request_context",
    "items" : [
      {
        "href" : "http://your.ambari.server/api/v1/clusters/c1/requests/1",
        "Requests" : {
          "cluster_name" : "c1",
          "id" : 1,
          "request_context" : "Install Services"
        }
      },
      {
        "href" : "http://your.ambari.server/api/v1/clusters/c1/requests/2",
        "Requests" : {
          "cluster_name" : "c1",
          "id" : 2,
          "request_context" : "Start Services"
        }
      }
    ]   
}   

Post on a request resource allows the user to execute Custom commands or custom actions on resources identified by a resource filter. Custom Command - A command script defined for Services in the Ambari Services stack and identified by a command name. Example: Restart, Service checks / Decommission slave component. Custom Action - A command script defined in the stack under custom_actions and identified by the action definition specified in /custom_action_definitions/system_action_definitions.xml.

POST http://your.ambari.server/api/v1/clusters/c1/requests

202 Created
{
   "RequestInfo": {
      "context": "Restart DataNode",
      "command": "RESTART"
   },
   "Requests/resource_filters": [
      {
         "service_name": "HDFS",
         "component_name": "NAMENODE",
         "hosts": "host1,host2,host3"
      }
   ]
}