OpsCenter API

The OpsCenter API facilitates the development of websites and programs to retrieve data and perform Cassandra 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.
• Managing Cluster Configurations includes methods for reading and setting the cassandra.yaml for one or more nodes as well as setting the DSE node type.
• 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 Column Families describes keyspace and column family operations, such as creating new keyspaces and column families.
• Retrieving Metric Data explains how to measure the performance of clusters, nodes, and column families, 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 column families 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.
• Provisioning New Nodes and Clusters details methods for creating new Cassandra and DSE nodes and clusters through OpsCenter, including launching Amazon EC2 instances to host the nodes.
• User Interface details method for interacting with various OpsCenter User Interface components.

This document contains the following sections:

• Authentication
  • User Administration Methods
• OpsCenter Configuration
  • Getting Existing OpsCenter Cluster Configurations
  • Adding, Updating, and Removing Configured Clusters
• Managing Cluster Configurations
  • cassandra.yaml Configuration
  • DSE Node Types
• Retrieving Cluster and Node Information
  • Cluster Properties
  • Node Properties
  • Storage Capacity
• Performing Cluster Operations
  • Node Administration Methods
  • Process Management Methods
  • Cluster Rebalancing Methods
  • Cluster Services
  • Cluster Repair Service
  • Request Management Methods
• Managing Keyspaces and Column Families
  • Keyspace Management Methods
  • Column Family 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 Backup Job Schedules
• Backup Management and Restoring from Backups
  • Managing Backups
  • Restoring from Backups
• Best Practice Rules
  • Managing Best Practice Rules
• Hadoop
  • Hadoop Status
  • Job Details
  • Proxy Port
• Provisioning New Nodes and Clusters
  • Provisioning on Prepared Servers
  • Provisioning with New EC2 Instances
• User Interface