IBM Analytics Engine API

Introduction With IBM Analytics Engine you can create Apache Spark clusters and customize these clusters by using scripts. You can work with data in IBM Cloud Object Storage. This set of APIs pertain to various actions you can perform on an IBM Analytics Engine service instance. The code examples on this tab use the client library that is provided for Java. Maven xml

MethodPathSummary
GET/v3/analytics_engines/{instance_id}Find Analytics Engine by id
GET/v3/analytics_engines/{instance_id}/stateFind Analytics Engine state by id
PUT/v3/analytics_engines/{instance_id}/instance_homeSet instance home
PATCH/v3/analytics_engines/{instance_id}/instance_homeUpdate instance home credentials
GET/v3/analytics_engines/{instance_id}/default_configsGet instance default Spark configurations
PUT/v3/analytics_engines/{instance_id}/default_configsReplace instance default Spark configurations
PATCH/v3/analytics_engines/{instance_id}/default_configsUpdate instance default Spark configurations
GET/v3/analytics_engines/{instance_id}/default_runtimeGet instance default runtime
PUT/v3/analytics_engines/{instance_id}/default_runtimeReplace instance default runtime
POST/v3/analytics_engines/{instance_id}/spark_applicationsDeploy a Spark application
GET/v3/analytics_engines/{instance_id}/spark_applicationsList all Spark applications
GET/v3/analytics_engines/{instance_id}/spark_applications/{application_id}Retrieve the details of a given Spark application
DELETE/v3/analytics_engines/{instance_id}/spark_applications/{application_id}Stop application
GET/v3/analytics_engines/{instance_id}/spark_applications/{application_id}/stateGet the status of the application
GET/v3/analytics_engines/{instance_id}/current_resource_consumptionGet current resource consumption
GET/v3/analytics_engines/{instance_id}/resource_consumption_limitsGet resource consumption limits
PUT/v3/analytics_engines/{instance_id}/log_forwarding_configReplace log forwarding configuration
GET/v3/analytics_engines/{instance_id}/log_forwarding_configGet log forwarding configuration
PUT/v3/analytics_engines/{instance_guid}/loggingEnable or disable log forwarding
GET/v3/analytics_engines/{instance_guid}/loggingRetrieve the logging configuration for a given instance id
POST/v3/analytics_engines/{instance_id}/spark_history_serverStart Spark history server
GET/v3/analytics_engines/{instance_id}/spark_history_serverGet Spark history server details
DELETE/v3/analytics_engines/{instance_id}/spark_history_serverStop Spark history server