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

<dependency>
  <groupId>com.ibm.cloud</groupId>
  <artifactId>ibm-analytics-engine-api</artifactId>
  <version>1.2.0</version>
</dependency>

GitHub

https://github.com/IBM/ibm-iae-java-sdk

The code examples on this tab use the client library that is provided for Node.js.

Installation

npm install iaesdk

GitHub

https://github.com/IBM/ibm-iae-node-sdk

The code examples on this tab use the client library that is provided for Python.

Installation

pip install --upgrade "iaesdk>=3.2.0"

GitHub

https://github.com/IBM/ibm-iae-python-sdk

The code examples on this tab use the client library that is provided for Go.

Installation

go get -u github.com/IBM/ibm-iae-go-sdk/v2

GitHub

https://github.com/IBM/ibm-iae-go-sdk

Service Endpoints

The v3 API is currently available only in Dallas (us-south) and Frankfurt (eu-de) regions.

Dallas: https://api.us-south.ae.cloud.ibm.com
Frankfurt: https://api.eu-de.ae.cloud.ibm.com

Authentication

You use IBM® Cloud Identity and Access Management (IAM) tokens to make authenticated requests to IBM Analytics Engine APIs without embedding service credentials in every call. IAM authentication uses access tokens for authentication, which you acquire by sending a request with an API key. You can create a token in IBM Cloud using your API key or by using the IBM Cloud command line interface (CLI) as described here.

SDK managing the IAM token. Replace {apikey}, {url}.

import java.util.HashMap;
import com.ibm.cloud.iaesdk.ibm_analytics_engine_api.v3.IbmAnalyticsEngineApi;
import com.ibm.cloud.iaesdk.ibm_analytics_engine_api.v3.model.*;
import com.ibm.cloud.sdk.core.http.Response;
import com.ibm.cloud.sdk.core.security.*;

private static IbmAnalyticsEngineApi ibmAnalyticsEngineApiService;

private static String IAM_API_KEY = "{apikey}";
private static String IAE_ENDPOINT_URL = "{url}";
private static String API_AUTH_URL = "{api auth url}";

public static void main(String[] args)
{   
    HashMap<String, String> config = new HashMap<String, String>();
    config.put("APIKEY",IAM_API_KEY );
    config.put("AUTH_URL", API_AUTH_URL);
    
    try {
        // Create an IAM authenticator.
        Authenticator authenticator = IamAuthenticator.fromConfiguration(config);
        // Construct the service client.
        ibmAnalyticsEngineApiService = new IbmAnalyticsEngineApi(IbmAnalyticsEngineApi.DEFAULT_SERVICE_NAME, authenticator);
        // Set our service URL.
        ibmAnalyticsEngineApiService.setServiceUrl(IAE_ENDPOINT_URL);

    } catch (Exception e) {
        System.out.println("Exception");
    }
}

SDK managing the IAM token. Replace {apikey}, {url}.

const IbmAnalyticsEngineApiV3 = require('iaesdk/ibm-analytics-engine-api/v3');
const { IamAuthenticator } = require('iaesdk/auth');

const IAM_API_KEY = "{apikey}" // eg "W00YiRnLW4a3fTjMB-odB-2ySfTrFBIQQWanc--P3byk"
const IAE_ENDPOINT_URL = "{url}" // Current list available at https://cloud.ibm.com/apidocs/ibm-analytics-engine#service-endpoints
const API_AUTH_URL = "{api auth url}"
const DEFAULT_SERVICE_NAME = 'ibm_analytics_engine_api'
let options = {};

// Create an IAM authenticator.
options.authenticator = new IamAuthenticator({
  apikey: IAM_API_KEY,
  url: API_AUTH_URL
});

options.serviceUrl = IAE_ENDPOINT_URL;
options.serviceName = DEFAULT_SERVICE_NAME;

// Construct the service client.
const ibmAnalyticsEngineApiService = new IbmAnalyticsEngineApiV3.newInstance(options);

SDK managing the IAM token. Replace {apikey}, {url}.

from iaesdk import IbmAnalyticsEngineApiV3
from ibm_cloud_sdk_core.authenticators import IAMAuthenticator
import json

## Constants for IBM Analytics Engine values
IAM_API_KEY = "{apikey}" # eg "W00YiRnLW4a3fTjMB-odB-2ySfTrFBIQQWanc--P3byk"
IAE_ENDPOINT_URL = "{url}" # Current list avaiable at https://cloud.ibm.com/apidocs/ibm-analytics-engine#service-endpoints
API_AUTH_URL = "{api auth url}"

## Create an IAM authenticator.
authenticator = IAMAuthenticator(apikey=IAM_API_KEY, url=API_AUTH_URL)

## Construct the service client.
ibm_analytics_engine_api_service = IbmAnalyticsEngineApiV3(authenticator=authenticator)

## Set our custom service URL
ibm_analytics_engine_api_service.set_service_url(IAE_ENDPOINT_URL)

## Service operations can now be invoked using the "ibm_analytics_engine_api_service" variable.

SDK managing the IAM token. Replace {apikey}, {url}.

import (
    "fmt"
    "github.com/IBM/go-sdk-core/v3/core"
    "github.com/IBM/ibm-iae-go-sdk/ibmanalyticsengineapiv3"
)

func main() {
    // Create an IAM authenticator.
    authenticator := &core.IamAuthenticator{
        ApiKey: "{apikey}", // eg "0viPHOY7LbLNa9eLftrtHPpTjoGv6hbLD1QalRXikliJ"
        URL: "{api auth url}"
    }

    // Construct an "options" struct for creating the service client.
    options := &ibmanalyticsengineapiv3.IbmAnalyticsEngineApiV3Options{
        Authenticator: authenticator,
        URL: "{url}",  // eg "https://api.us-south.ae.cloud.ibm.com"
    }

    // Construct the service client.
    ibmAnalyticsEngineApiService, err := ibmanalyticsengineapiv3.NewIbmAnalyticsEngineApiV3(options)
    if err != nil {
        panic(err)
    }

    // Service operations can now be invoked using the "ibmAnalyticsEngineApiService" variable.
}

Error handling

This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 response always indicates success. A 400 type response is a client side failure, and a 500 type response usually indicates a server side error.

Status code summary
Status code	Description
200 OK	The request was processed successfully.
201 Created	The requested resource was created successfully.
202 Accepted	The request was accepted successfully.
400 Bad Request	The request could not be processed, often due to a missing required parameter.
401 Unauthorized	The authorization token is invalid or missing.
403 Forbidden	The authorization token presented does not have sufficient permission to perform the operation.
404 Not Found	The requested resource does not exist.
410 Gone	The requested resource was deleted and no longer exists.
429 Too Many Requests	The request could not be processed due to too many concurrent requests against the API.
500 Server Error	Your request could not be processed due to an internal server error.

IBM Analytics Engine v3 API | IBM Cloud API Docs