IBM Analytics Engine v2 API | IBM Cloud API Docs

Introduction

Last updated: 2018-08-08

With IBM Analytics Engine you can create Apache Spark and Apache Hadoop clusters and customize these clusters by using scripts. You can work with data in IBM Cloud Object Storage, as well as integrate other Watson Data Platform services like IBM Watson Studio and Machine Learning. 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>0.0.5</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 iaesdk"

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 github.com/IBM/ibm-iae-go-sdk

GitHub

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

Service Endpoints

The endpoint URL used in the examples is not your actual service endpoint. To find out which URL to use, view the service credentials by clicking the service instance on the IBM Cloud console dashboard. Use the API URL under cluster_management section on the service credentials page.

For example: The API URL will be in the following format

London : https://api.eu-gb.ae.cloud.ibm.com
Dallas : https://api.us-south.ae.cloud.ibm.com
Washington DC : https://api.us-east.ae.cloud.ibm.com
Frankfurt : https://api.eu-de.ae.cloud.ibm.com
Tokyo : https://api.jp-tok.ae.cloud.ibm.com
Sydney: https://api.au-syd.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.

The SDK provides initialization methods for each form of authentication.

Use the API key to have the SDK manage the lifecycle of the access token. The SDK requests an access token, ensures that the access token is valid, and refreshes it if necessary.
Use the access token to manage the lifecycle yourself. You must periodically refresh the token.

For more information, see authentication with the SDK.For more information, see authentication with the SDK.For more information, see authentication with the SDK.For more information, see authentication with the SDK.

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

import com.ibm.cloud.iaesdk.ibm_analytics_engine_api.v2.IbmAnalyticsEngineApi;
import com.ibm.cloud.iaesdk.ibm_analytics_engine_api.v2.model.*;
import com.ibm.cloud.sdk.core.http.Response;
import com.ibm.cloud.sdk.core.security.*;

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

public static void main(String[] args)
{
    try {
        // Create an IAM authenticator.
        Authenticator authenticator = new IamAuthenticator(IAM_API_KEY);
        // Construct the service client.
        service = new IbmAnalyticsEngineApi(IbmAnalyticsEngineApi.DEFAULT_SERVICE_NAME, authenticator);
        // Set our service URL.
        service.setServiceUrl(IAE_ENDPOINT_URL);

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

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

const IbmAnalyticsEngineApiV2 = require('iaesdk/ibm-analytics-engine-api/v2');
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

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

// Construct the service client.
const IbmAnalyticsEngineServiceClient = new IbmAnalyticsEngineApiV2({
  authenticator,
  serviceUrl: IAE_ENDPOINT_URL,
});

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

from iaesdk import IbmAnalyticsEngineApiV2
from ibm_cloud_sdk_core.authenticators import IAMAuthenticator

# 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

# Create an IAM authenticator.
authenticator = IAMAuthenticator(IAM_API_KEY)

# Construct the service client.
iaesdk_service = IbmAnalyticsEngineApiV2(authenticator=authenticator)

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

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

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

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

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

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

    // Construct the service client.
    service, err := ibmanalyticsengineapiv2.NewIbmAnalyticsEngineApiV2(options)
    if err != nil {
        panic(err)
    }

    // Service operations can now be invoked using the "service" 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.
400 Bad Request	The request could not be processed, often due to a missing required parameter.
401 Unauthorized	The request could not be processed due to insufficient permissions.
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.

Currently, you cannot fetch the list of all IBM Analytics Engine service instances through this REST API. You should use the IBM Cloud CLI instead. For example, ibmcloud resource service-instances --service-name ibmanalyticsengine

Currently, you cannot fetch the list of all IBM Analytics Engine service instances through this REST API. You should use the IBM Cloud CLI instead. For example, ibmcloud resource service-instances --service-name ibmanalyticsengine.

GET /v2/analytics_engines

getAllAnalyticsEngines(params, [callback()])

get_all_analytics_engines(self, **kwargs) -> DetailedResponse

(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV2) GetAllAnalyticsEngines(getAllAnalyticsEnginesOptions *GetAllAnalyticsEnginesOptions) (response *core.DetailedResponse, err error)

ServiceCall<Void> getAllAnalyticsEngines()

Request

No Request Parameters

This method does not accept any request parameters.

No Request Parameters

This method does not accept any request parameters.

No Request Parameters

This method does not accept any request parameters.

No Request Parameters

This method does not accept any request parameters.

No Request Parameters

This method does not accept any request parameters.

Response