[AMBARI-10407] Create API endpoint for widgets

• Type: Task
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 2.1.0
• Fix Version/s: 2.1.0
• Component/s: ambari-server
• Epic Link: Enhanced Service Dashboard
• Assignee: Ivan Kozlov
• Reporter: Siddharth Wagle
• Created: 08/Apr/15 21:15
• Updated: 14/Apr/15 00:13
• Resolved: 10/Apr/15 19:51

Description

Request for getting a user created widget instance (private) /api/v1/users/jaimin/widgets/NAMENODE_HEAP

Response

{
  href: "http://c6401.ambari.apache.org:8080/api/v1/users/jaimin/widgets/NAMENODE_HEAP",
  cluster_name: "c1",
  widget_name: "NAMENODE_HEAP1",
  widget_type: “GAUGE”,
  display_name: "NameNode Heap",
  service_name: “HDFS”,
  component_name: “NAMENODE”,
  page_names: [“HDFS_SUMMARY”,”DASHBOARD”],
  description: "", 
  sharable: true,
  author: “jaimin”,
  metrics: {
    numerator_metric: "jvmMemoryHeapUsed",
    denominator_metric: "jvmMemoryHeapMax"
  },
  
  expression: [{
    name: result,
    template: “${numerator_metric}/${denominator_metric}”
  }],
  properties: {
   “warning_threshold”: 0.9,
   “error_threshold”:   0.7,
  }
}

NOTE: It should be able to query and get all the widgets that belongs to a particular page and either have a specific value for author_name or are having sharable set to true. something like following

/api/v1/users?Widgets/sharable=true|Widgets/author=jaimin&page_names=HDFS_SUMMARY&fields=Widgets/*

Issue Links

• links to: Review board