đź”—CDAP HTTP RESTful API v3

The Cask Data Application Platform (CDAP) has an HTTP interface for a multitude of purposes: from sending data events to a stream and inspecting the contents of a stream 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

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 flows, MapReduce programs, Spark programs, workflows, and custom services
  • Stream: sending data events to a stream or to inspect the contents of a stream
  • Dataset: interacting with datasets, dataset modules, and dataset types
  • Service: supports making requests to the methods of an application’s services
  • Route Config: create, fetch, and delete route configurations (route configs) which allocate requests between different versions of a service
  • Workflow: retrieving values from workflow tokens and statistics on workflow runs

Querying and Viewing APIs

  • Query: sending ad-hoc queries to CDAP datasets
  • Views: a read-only view of a stream, with a specific read format

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

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 flows, MapReduce programs, Spark programs, workflows, and custom services
  • Logging: retrieving application logs
  • Metadata: setting, retrieving, and deleting user metadata annotations
  • Metadata Management: metadata management
  • 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
  • Preferences: setting, retrieving, and deleting preferences
  • Query: sending ad-hoc queries to CDAP datasets
  • Route Config: create, fetch, and delete route configurations (route configs) which allocate requests between different versions of a service
  • 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
  • Stream: sending data events to a stream or to inspect the contents of a stream
  • Transactions: interacting with the transaction service
  • Views: a read-only view of a stream, with a specific read format
  • Workflow: retrieving values from workflow tokens and statistics on workflow runs