summaryrefslogtreecommitdiff
path: root/ambari-server/docs/api/v1/requests.md
blob: 474ea856fd5bb2a00fcf65ef3f9afd7735ec80e3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
<!---
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->

List Requests
=====

[Back to Resources](index.md#resources)

**Summary**

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

    GET /clusters/:clusterName/requests

**Response**
<table>
  <tr>
    <th>HTTP CODE</th>
    <th>Description</th>
  </tr>
  <tr>
    <td>200</td>
    <td>OK</td>  
  </tr>
  <tr>
    <td>400</td>
    <td>Bad Request</td>  
  </tr>
  <tr>
    <td>401</td>
    <td>Unauthorized</td>  
  </tr>
  <tr>
    <td>403</td>
    <td>Forbidden</td>  
  </tr> 
  <tr>
    <td>404</td>
    <td>Not Found</td>  
  </tr>
  <tr>
    <td>500</td>
    <td>Internal Server Error</td>  
  </tr>
</table>



**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"
            }
          }
        ]	
    }