REST APIs for Querying Timeline Service 2.0
You must use REST APIs for querying Timeline Service 2.0 and retrieving information
about applications. The API is implemented at the path /ws/v2/timeline/
on
the web service for the timeline service.
The following table lists the different types of queries supported on the REST API
for Timeline Service 2.0:
If you want to query... | Use this HTTP Request Syntax... |
---|---|
The root path of the API |
GET /ws/v2/timeline/ |
Active flows | GET /ws/v2/timeline/clusters/{cluster name}/flows/OR GET /ws/v2/timeline/flows/ |
Active flow runs | GET /ws/v2/timeline/clusters/{cluster name}/users/{user name}/flows/{flow name}/runs/OR GET /ws/v2/timeline/users/{user name}/flows/{flow name}/runs/ |
A specific flow run | GET /ws/v2/timeline/clusters/{cluster name}/users/{user name}/flows/{flow name}/runs/{run id}OR GET /ws/v2/timeline/users/{user name}/flows/{flow name}/runs/{run id} |
YARN applications that belong to a flow | GET /ws/v2/timeline/clusters/{cluster name}/users/{user name}/flows/{flow name}/appsOR GET /ws/v2/timeline/users/{user name}/flows/{flow name}/apps |
YARN applications that belong to a flow run | GET /ws/v2/timeline/clusters/{cluster name}/users/{user name}/flows/{flow name}/runs/{run id}/appsOR GET /ws/v2/timeline/users/{user name}/flows/{flow name}/runs/{run id}/apps/ |
A specific YARN application | GET /ws/v2/timeline/clusters/{cluster name}/apps/{app id}OR GET /ws/v2/timeline/apps/{app id} |
Generic timeline entities within the scope of an application | GET /ws/v2/timeline/clusters/{cluster name}/apps/{app id}/entities/{entity type}OR GET /ws/v2/timeline/apps/{app id}/entities/{entity type} |
Generic timeline entities per user | GET /ws/v2/timeline/clusters/{cluster name}/users/{userid}/entities/{entitytype}OR GET /ws/v2/timeline/users/{userid}/entities/{entitytype} |
A specific timeline entity | GET /ws/v2/timeline/clusters/{cluster name}/apps/{app id}/entities/{entity type}/{entity id}OR GET /ws/v2/timeline/apps/{app id}/entities/{entity type}/{entity id} |
A generic timeline entity per user | GET /ws/v2/timeline/clusters/{cluster name}/users/{userid}/entities/{entitytype}/{entityid}OR GET /ws/v2/timeline/users/{userid}/entities/{entitytype}/{entityid} |
A set of available entity types for an Application ID | GET /ws/v2/timeline/apps/{appid}/entity-typesOR GET /ws/v2/timeline/clusters/{clusterid}/apps/{appid}/entity-types |
Note | |
---|---|
For more information about these API query types, see https://hadoop.apache.org/docs/r3.1.0/hadoop-yarn/hadoop-yarn-site/TimelineServiceV2.html#Timeline_Service_v.2_REST_API. |