OpsCenter API

The OpsCenter API facilitates the development of websites and programs to retrieve data and perform DataStax Enterprise database administrative actions. The OpsCenter API includes RESTful requests for programmatically performing the same set of operations as the OpsCenter GUI.

The documentation includes examples of each API method and is organized as follows:

• Authentication describes how to authenticate when users and roles are configured.
• OpsCenter Configuration covers methods for getting information about clusters, such as seed hosts and the JMX port, adding a new cluster to OpsCenter, updating a cluster, and removing a cluster.
• Retrieving Cluster and Node Information describes methods for getting more information about clusters, such as the endpoint snitch and partitioner name, information about a particular cluster property, nodes in the cluster, and node properties.
• Performing Cluster Operations describes methods for performing garbage compaction, flushing memtables, and other administrative actions on nodes and keyspaces.
• Managing Keyspaces and Tables describes keyspace and table operations, such as creating new keyspaces and tables.
• Retrieving Metric Data explains how to measure the performance of clusters, nodes, and tables, as well as generate projected forecasts of performance.
• Managing Events and Alerts includes documentation about methods for getting information about events and alerts and setting alert rules.
• Schedule management describes methods for dealing with scheduled operations. Currently the type of operations that can be scheduled is limited to backups and best practice rules
• Backup Management and Restoring from Backups describes methods for running backups, getting information about existing backups, and restoring keyspaces and tables from backups.
• Best Practice Rules describes methods for getting results of best practice rules as well as running individual rules on demand.
• Hadoop shows how to get information about the current status of the Hadoop infrastructure in your DSE cluster.
• Spark shows how to get information about the current status of the Spark infrastructure in your DSE cluster.
• Managing Performance Service Configuration details methods for configuring the performance service and displaying results from it.
• User Interface details method for interacting with various OpsCenter User Interface components.
• Agent Install and Status details methods for installing agents, determining agent health and operations on a node.
• Cluster Lifecycle Management describes how to provision clusters and manage their configurations.

This document contains the following sections:

• Authentication
  • User Administration Methods
• OpsCenter Configuration
  • Getting Existing OpsCenter Cluster Configurations
  • Adding, Updating, and Removing Configured Clusters
  • Updating OpsCenter and Agent Log Level
• Retrieving Cluster and Node Information
  • Cluster Properties
  • Node Properties
  • Storage Capacity
  • Diagnostic Tarball
• Performing Cluster Operations
  • Node Administration Methods
  • Process Management Methods
  • Cluster Rebalancing Methods
  • Cluster Services
  • Cluster Repair Service
  • NodeSync Service
  • Request Management Methods
• Managing Keyspaces and Tables
  • Keyspace Management Methods
  • Table Management Methods
• Retrieving Metric Data
  • Controlling the Metric Data Output
  • Metrics Attribute Key Lists
• Managing Events and Alerts
  • Event Methods
  • Alert Methods
• Schedule management
  • Managing Job Schedules
• Backup Management and Restoring from Backups
  • Managing Backups
  • Restoring from Backups
  • Managing Destinations
• Best Practice Rules
  • Managing Best Practice Rules
• Hadoop
  • Hadoop Status
  • Job Details
  • Proxy Port
• Spark
  • Proxy Port
• Managing Performance Service Configuration
  • Performance Service Management Methods
• User Interface
• Agent Install and Status
  • Install
  • Status
• Cluster Lifecycle Management
  • Common Response Properties
  • Paginated Results