diff options
Diffstat (limited to 'ambari-server/docs/api/v1/tasks.md')
-rw-r--r-- | ambari-server/docs/api/v1/tasks.md | 92 |
1 files changed, 92 insertions, 0 deletions
diff --git a/ambari-server/docs/api/v1/tasks.md b/ambari-server/docs/api/v1/tasks.md new file mode 100644 index 0000000000..a06790f1d8 --- /dev/null +++ b/ambari-server/docs/api/v1/tasks.md @@ -0,0 +1,92 @@ +<!--- +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 Tasks +===== + +[Back to Resources](index.md#resources) + +**Summary** + +Returns a collection of all tasks for the request identified by ":requestId" and the cluster identified by ":clusterName". + + GET /clusters/:clusterName/requests/:requestId/tasks + +**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 tasks for the request 2 and the cluster named "c1". + + GET /clusters/c1/requests/2/tasks?fields=Tasks/status + + 200 OK + { + "href" : "http://your.ambari.server/api/v1/clusters/c1/requests/2/tasks?fields=Tasks/status", + "items" : [ + { + "href" : "http://your.ambari.server/api/v1/clusters/c1/requests/2/tasks/12", + "Tasks" : { + "cluster_name" : "c1", + "id" : 12, + "request_id" : 2, + "status" : "COMPLETED" + } + }, + { + "href" : "http://your.ambari.server/api/v1/clusters/c1/requests/2/tasks/13", + "Tasks" : { + "cluster_name" : "c1", + "id" : 13, + "request_id" : 2, + "status" : "IN_PROGRESS" + } + } + ] + } |