CDAP HTTP RESTful API v3

The Cask Data Application Platform (CDAP) has an HTTP interface for a multitude of purposes: from deploying custom applications through checking the status of system and custom CDAP services. V3 of the API includes the namespacing of applications, data, and metadata to achieve application and data isolation. This is an inital step towards introducing multi-tenancy into CDAP.

Introduction

  • Introduction: conventions, converting from HTTP RESTful API v2, naming restrictions, status codes, and working with CDAP security

General APIs

  • Namespace: creating and managing namespaces
  • Metadata: setting, retrieving, and deleting user metadata annotations
  • Preferences: setting, retrieving, and deleting preferences
  • Configuration: retrieving the CDAP and HBase configurations
  • Security: granting, revoking and listing privileges on CDAP entities, managing secure storage
  • Transactions: interacting with the transaction service

Major CDAP Entities APIs

  • Artifact: deploying artifacts and retrieving details about plugins available to artifacts and classes contained within artifacts
  • Lifecycle: deploying and managing applications, and managing the lifecycle of MapReduce programs, Spark programs, workflows, and custom services
  • Profile: management of cloud runtime profiles
  • Dataset: interacting with datasets, dataset modules, and dataset types
  • Service: supports making requests to the methods of an application’s services
  • Workflow: retrieving values from workflow tokens and statistics on workflow runs

Logging, Metrics, and Monitoring APIs

  • Logging: retrieving application logs
  • Metrics: retrieving metrics for system and user applications (user-defined metrics)
  • Monitor: checking the status of various system and custom CDAP services
  • Dashboard: check in real time status of past program runs and predict future resource usage
  • Reports: generate reports to understand and monitor program runs and their performance

Alphabetical List of APIs

  • Introduction: conventions, converting from HTTP RESTful API v2, naming restrictions, status codes, and working with CDAP security
  • Artifact: deploying artifacts and retrieving details about plugins available to artifacts and classes contained within artifacts
  • Configuration: retrieving the CDAP and HBase configurations
  • Dataset: interacting with datasets, dataset modules, and dataset types
  • Lifecycle: deploying and managing applications, and managing the lifecycle of MapReduce programs, Spark programs, workflows, and custom services
  • Logging: retrieving application logs
  • Metadata: setting, retrieving, and deleting user metadata annotations
  • Metrics: retrieving metrics for system and user applications (user-defined metrics)
  • Monitor: checking the status of various system and custom CDAP services
  • Namespace: creating and managing namespaces
  • Dashboard: check in real time status of past program runs and predict future resource usage
  • Preferences: setting, retrieving, and deleting preferences
  • Query: sending ad-hoc queries to CDAP datasets
  • Reports: generate reports to understand and monitor program runs and their performance
  • Security: granting, revoking, and listing privileges, as well as adding, retrieving, and managing Secure Keys
  • Service: supports making requests to the methods of an application’s services
  • Transactions: interacting with the transaction service
  • Workflow: retrieving values from workflow tokens and statistics on workflow runs