Repository: ambari Updated Branches: refs/heads/trunk c654952bd -> 1d2900fcc
AMBARI-5118. Update Request resource API doc. Task Resoruces fix. (swagle) Project: http://git-wip-us.apache.org/repos/asf/ambari/repo Commit: http://git-wip-us.apache.org/repos/asf/ambari/commit/1d2900fc Tree: http://git-wip-us.apache.org/repos/asf/ambari/tree/1d2900fc Diff: http://git-wip-us.apache.org/repos/asf/ambari/diff/1d2900fc Branch: refs/heads/trunk Commit: 1d2900fcc5722d593d4ba9f0a7b6d881de9080c1 Parents: c654952 Author: Siddharth Wagle <[email protected]> Authored: Mon Mar 17 15:59:47 2014 -0700 Committer: Siddharth Wagle <[email protected]> Committed: Mon Mar 17 15:59:54 2014 -0700 ---------------------------------------------------------------------- ambari-server/docs/api/v1/task_resources.md | 139 ----------------------- 1 file changed, 139 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/ambari/blob/1d2900fc/ambari-server/docs/api/v1/task_resources.md ---------------------------------------------------------------------- diff --git a/ambari-server/docs/api/v1/task_resources.md b/ambari-server/docs/api/v1/task_resources.md deleted file mode 100644 index ef22cfb..0000000 --- a/ambari-server/docs/api/v1/task_resources.md +++ /dev/null @@ -1,139 +0,0 @@ -<!--- -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. ---> - -# Task Resources - - -###API Summary - -- [List tasks](tasks.md) - -###Properties - -<table> - <tr> - <th>Property</th> - <th>Description</th> - </tr> - <tr> - <td>Tasks/id</td> - <td>The task id</td> - </tr> - <tr> - <td>Tasks/request_id</td> - <td>The parent request id</td> - </tr> - <tr> - <td>Tasks/cluster_name</td> - <td>The name of the parent cluster</td> - </tr> - <tr> - <td>Tasks/attempt_cnt</td> - <td>The number of attempts at completing this task</td> - </tr> - <tr> - <td>Tasks/command</td> - <td>The task command</td> - </tr> - <tr> - <td>Tasks/exit_code</td> - <td>The exit code</td> - </tr> - <tr> - <td>Tasks/host_name</td> - <td>The name of the host</td> - </tr> - <tr> - <td>Tasks/role</td> - <td>The role</td> - </tr> - <tr> - <td>Tasks/stage_id</td> - <td>The stage id</td> - </tr> - <tr> - <td>Tasks/start_time</td> - <td>The task start time</td> - </tr> - <tr> - <td>Tasks/status</td> - <td>The task status</td> - </tr> - <tr> - <td>Tasks/stderr</td> - <td>The stderr from running the taks</td> - </tr> - <tr> - <td>Tasks/stdout</td> - <td>The stdout from running the task</td> - </tr> -</table> - - -###Status - -The current status of a task resource can be determined by looking at the Tasks/status property. - - - GET api/v1/clusters/c1/requests/2/tasks/12?fields=Tasks/status - - 200 OK - { - "href" : "your.ambari.server/api/v1/clusters/c1/requests/2/tasks/12?fields=Tasks/status", - "Tasks" : { - "cluster_name" : "c1", - "id" : 12, - "request_id" : 2, - "status" : "COMPLETED" - } - -The following table lists the possible values of the task resource Tasks/status. -<table> - <tr> - <th>State</th> - <th>Description</th> - </tr> - <tr> - <td>PENDING</td> - <td>Not queued for a host.</td> - </tr> - <tr> - <td>QUEUED</td> - <td>Queued for a host.</td> - </tr> - <tr> - <td>IN_PROGRESS</td> - <td>Host reported it is working.</td> - </tr> - <tr> - <td>COMPLETED</td> - <td>Host reported success.</td> - </tr> - <tr> - <td>FAILED</td> - <td>Failed.</td> - </tr> - <tr> - <td>TIMEDOUT</td> - <td>Host did not respond in time.</td> - </tr> - <tr> - <td>ABORTED</td> - <td>Operation was abandoned.</td> - </tr> -</table> -
