IBM Cloud API Docs

Introduction

Last updated: 2023-05-24

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.

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.

Methods

Find Analytics Engine by id

Retrieve the details of a single Analytics Engine instance.

Retrieve the details of a single Analytics Engine instance.

Retrieve the details of a single Analytics Engine instance.

Retrieve the details of a single Analytics Engine instance.

Retrieve the details of a single Analytics Engine instance.

GET /v3/analytics_engines/{instance_id}
getInstance(params)
get_instance(self,
        instance_id: str,
        **kwargs
    ) -> DetailedResponse
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetInstance(getInstanceOptions *GetInstanceOptions) (result *Instance, response *core.DetailedResponse, err error)
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetInstanceWithContext(ctx context.Context, getInstanceOptions *GetInstanceOptions) (result *Instance, response *core.DetailedResponse, err error)
ServiceCall<Instance> getInstance(GetInstanceOptions getInstanceOptions)

Request

Instantiate the GetInstanceOptions struct and set the fields to provide parameter values for the GetInstance method.

Use the GetInstanceOptions.Builder to create a GetInstanceOptions object that contains the parameter values for the getInstance method.

Custom Headers

  • Authorization
    Required*
    string

    Identity Access Management (IAM) bearer token.

Path Parameters

  • instance_id
    Required*
    string

    GUID of the Analytics Engine service instance to retrieve.

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    Example: e64c907a-e82f-46fd-addc-ccfafbd28b09

parameters

  • instanceId
    Required*
    string

    GUID of the Analytics Engine service instance to retrieve.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameters

  • instance_id
    Required*
    str

    GUID of the Analytics Engine service instance to retrieve.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameter

WithContext method only

GetInstanceOptions

The GetInstance options.

GetInstanceOptions

The getInstance options.

  • curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/v3/analytics_engines/{instance_id}"
  • getInstanceOptions := ibmAnalyticsEngineApiService.NewGetInstanceOptions(
  "e64c907a-e82f-46fd-addc-ccfafbd28b09",
)

instance, response, err := ibmAnalyticsEngineApiService.GetInstance(getInstanceOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(instance, "", "  ")
fmt.Println(string(b))
  • GetInstanceOptions getInstanceOptions = new GetInstanceOptions.Builder()
  .instanceId("e64c907a-e82f-46fd-addc-ccfafbd28b09")
  .build();

Response<Instance> response = ibmAnalyticsEngineApiService.getInstance(getInstanceOptions).execute();
Instance instance = response.getResult();

System.out.println(instance);
  • const params = {
  instanceId: 'e64c907a-e82f-46fd-addc-ccfafbd28b09',
};

let res;
try {
  res = await ibmAnalyticsEngineApiService.getInstance(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • response = ibm_analytics_engine_api_service.get_instance(
  instance_id='e64c907a-e82f-46fd-addc-ccfafbd28b09',
)
instance = response.get_result()

print(json.dumps(instance, indent=2))

Response

Response Body

Instance

Details of Analytics Engine instance

Instance

Details of Analytics Engine instance.

Instance

Details of Analytics Engine instance.

Instance

Details of Analytics Engine instance.

Instance

Details of Analytics Engine instance.

Status Code

  • 200

    OK

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Resource Not Found

  • 500

    Internal Server Error

Example responses
  • {
  "id": "dc0e9889-eab2-4t9e-9441-566209499546",
  "state": "active",
  "state_change_time": "2021-04-21T04:24:01Z",
  "default_runtime": {
    "spark_version": "3.1"
  },
  "instance_home": {
    "guid": "30d5c4a7-9fb7-4712-9039-a79417dec87b",
    "provider": "ibm-cos",
    "type": "objectstore",
    "region": "us-south",
    "endpoint": "s3.direct.us-south.cloud-object-storage.appdomain.cloud",
    "bucket": "ae-bucket-do-not-delete-dc0e9889-eab2-4t9e-9441-566209499546",
    "hmac_access_key": "eH****g=",
    "hmac_secret_key": "4d********76"
  },
  "default_config": {
    "spark.driver.memory": "4g",
    "spark.driver.cores": 1
  }
}
  • {
  "id": "dc0e9889-eab2-4t9e-9441-566209499546",
  "state": "active",
  "state_change_time": "2021-04-21T04:24:01Z",
  "default_runtime": {
    "spark_version": "3.1"
  },
  "instance_home": {
    "guid": "30d5c4a7-9fb7-4712-9039-a79417dec87b",
    "provider": "ibm-cos",
    "type": "objectstore",
    "region": "us-south",
    "endpoint": "s3.direct.us-south.cloud-object-storage.appdomain.cloud",
    "bucket": "ae-bucket-do-not-delete-dc0e9889-eab2-4t9e-9441-566209499546",
    "hmac_access_key": "eH****g=",
    "hmac_secret_key": "4d********76"
  },
  "default_config": {
    "spark.driver.memory": "4g",
    "spark.driver.cores": 1
  }
}

Find Analytics Engine state by id

Retrieve the state of a single Analytics Engine instance.

Retrieve the state of a single Analytics Engine instance.

Retrieve the state of a single Analytics Engine instance.

Retrieve the state of a single Analytics Engine instance.

Retrieve the state of a single Analytics Engine instance.

GET /v3/analytics_engines/{instance_id}/state
getInstanceState(params)
get_instance_state(self,
        instance_id: str,
        **kwargs
    ) -> DetailedResponse
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetInstanceState(getInstanceStateOptions *GetInstanceStateOptions) (result *InstanceGetStateResponse, response *core.DetailedResponse, err error)
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetInstanceStateWithContext(ctx context.Context, getInstanceStateOptions *GetInstanceStateOptions) (result *InstanceGetStateResponse, response *core.DetailedResponse, err error)
ServiceCall<InstanceGetStateResponse> getInstanceState(GetInstanceStateOptions getInstanceStateOptions)

Request

Instantiate the GetInstanceStateOptions struct and set the fields to provide parameter values for the GetInstanceState method.

Use the GetInstanceStateOptions.Builder to create a GetInstanceStateOptions object that contains the parameter values for the getInstanceState method.

Custom Headers

  • Authorization
    Required*
    string

    Identity Access Management (IAM) bearer token.

Path Parameters

  • instance_id
    Required*
    string

    GUID of the Analytics Engine service instance to retrieve state.

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    Example: e64c907a-e82f-46fd-addc-ccfafbd28b09

parameters

  • instanceId
    Required*
    string

    GUID of the Analytics Engine service instance to retrieve state.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameters

  • instance_id
    Required*
    str

    GUID of the Analytics Engine service instance to retrieve state.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameter

WithContext method only

GetInstanceStateOptions

The GetInstanceState options.

GetInstanceStateOptions

The getInstanceState options.

  • curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/v3/analytics_engines/{instance_id}/state"
  • getInstanceStateOptions := ibmAnalyticsEngineApiService.NewGetInstanceStateOptions(
  "e64c907a-e82f-46fd-addc-ccfafbd28b09",
)

instanceGetStateResponse, response, err := ibmAnalyticsEngineApiService.GetInstanceState(getInstanceStateOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(instanceGetStateResponse, "", "  ")
fmt.Println(string(b))
  • GetInstanceStateOptions getInstanceStateOptions = new GetInstanceStateOptions.Builder()
  .instanceId("e64c907a-e82f-46fd-addc-ccfafbd28b09")
  .build();

Response<InstanceGetStateResponse> response = ibmAnalyticsEngineApiService.getInstanceState(getInstanceStateOptions).execute();
InstanceGetStateResponse instanceGetStateResponse = response.getResult();

System.out.println(instanceGetStateResponse);
  • const params = {
  instanceId: 'e64c907a-e82f-46fd-addc-ccfafbd28b09',
};

let res;
try {
  res = await ibmAnalyticsEngineApiService.getInstanceState(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • response = ibm_analytics_engine_api_service.get_instance_state(
  instance_id='e64c907a-e82f-46fd-addc-ccfafbd28b09',
)
instance_get_state_response = response.get_result()

print(json.dumps(instance_get_state_response, indent=2))

Response

Response Body

InstanceGetStateResponse

State details of Analytics Engine instance

InstanceGetStateResponse

State details of Analytics Engine instance.

InstanceGetStateResponse

State details of Analytics Engine instance.

InstanceGetStateResponse

State details of Analytics Engine instance.

InstanceGetStateResponse

State details of Analytics Engine instance.

Status Code

  • 200

    OK

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Resource Not Found

  • 500

    Internal Server Error

Example responses
  • {
  "id": "dc0e9889-eab2-4t9e-9441-566209499546",
  "state": "active"
}
  • {
  "id": "dc0e9889-eab2-4t9e-9441-566209499546",
  "state": "active"
}

Set instance home

Provide the details of the Cloud Object Storage instance to associate with the Analytics Engine instance and use as 'instance home' if 'instance home' has not already been set.

Note: You can set 'instance home' again if the instance is in 'instance_home_creation_failure' state.

Provide the details of the Cloud Object Storage instance to associate with the Analytics Engine instance and use as 'instance home' if 'instance home' has not already been set.

Note: You can set 'instance home' again if the instance is in 'instance_home_creation_failure' state.

Provide the details of the Cloud Object Storage instance to associate with the Analytics Engine instance and use as 'instance home' if 'instance home' has not already been set.

Note: You can set 'instance home' again if the instance is in 'instance_home_creation_failure' state.

Provide the details of the Cloud Object Storage instance to associate with the Analytics Engine instance and use as 'instance home' if 'instance home' has not already been set.

Note: You can set 'instance home' again if the instance is in 'instance_home_creation_failure' state.

Provide the details of the Cloud Object Storage instance to associate with the Analytics Engine instance and use as 'instance home' if 'instance home' has not already been set.

Note: You can set 'instance home' again if the instance is in 'instance_home_creation_failure' state.

PUT /v3/analytics_engines/{instance_id}/instance_home
setInstanceHome(params)
set_instance_home(self,
        instance_id: str,
        *,
        new_instance_id: str = None,
        new_provider: str = None,
        new_type: str = None,
        new_region: str = None,
        new_endpoint: str = None,
        new_hmac_access_key: str = None,
        new_hmac_secret_key: str = None,
        **kwargs
    ) -> DetailedResponse
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) SetInstanceHome(setInstanceHomeOptions *SetInstanceHomeOptions) (result *InstanceHomeResponse, response *core.DetailedResponse, err error)
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) SetInstanceHomeWithContext(ctx context.Context, setInstanceHomeOptions *SetInstanceHomeOptions) (result *InstanceHomeResponse, response *core.DetailedResponse, err error)
ServiceCall<InstanceHomeResponse> setInstanceHome(SetInstanceHomeOptions setInstanceHomeOptions)

Request

Instantiate the SetInstanceHomeOptions struct and set the fields to provide parameter values for the SetInstanceHome method.

Use the SetInstanceHomeOptions.Builder to create a SetInstanceHomeOptions object that contains the parameter values for the setInstanceHome method.

Custom Headers

  • Authorization
    Required*
    string

    Identity Access Management (IAM) bearer token.

Path Parameters

  • instance_id
    Required*
    string

    The ID of the Analytics Engine instance.

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    Example: e64c907a-e82f-46fd-addc-ccfafbd28b09

Request Body

Required*
InstanceHomeRequest

Details of the Object Storage instance.

Examples:
View

parameters

  • instanceId
    Required*
    string

    The ID of the Analytics Engine instance.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html
  • newInstanceId
    string

    UUID of the instance home storage instance.

  • newProvider
    string

    Currently only ibm-cos (IBM Cloud Object Storage) is supported.

    Default: ibm-cos

  • newType
    string

    Type of the instance home storage. Currently, only objectstore (Cloud Object Storage) is supported.

    Default: objectstore

  • newRegion
    string

    Region of the Cloud Object Storage instance.

    Default: us-south

  • newEndpoint
    string

    Endpoint to access the Cloud Object Storage instance.

    Default: s3.direct.us-south.cloud-object-storage.appdomain.cloud

  • newHmacAccessKey
    string

    Cloud Object Storage access key.

    Examples:
    value
    _source
    _lines
    _html
  • newHmacSecretKey
    string

    Cloud Object Storage secret key.

    Examples:
    value
    _source
    _lines
    _html

parameters

  • instance_id
    Required*
    str

    The ID of the Analytics Engine instance.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html
  • new_instance_id
    str

    UUID of the instance home storage instance.

  • new_provider
    str

    Currently only ibm-cos (IBM Cloud Object Storage) is supported.

    Default: ibm-cos

  • new_type
    str

    Type of the instance home storage. Currently, only objectstore (Cloud Object Storage) is supported.

    Default: objectstore

  • new_region
    str

    Region of the Cloud Object Storage instance.

    Default: us-south

  • new_endpoint
    str

    Endpoint to access the Cloud Object Storage instance.

    Default: s3.direct.us-south.cloud-object-storage.appdomain.cloud

  • new_hmac_access_key
    str

    Cloud Object Storage access key.

    Examples:
    value
    _source
    _lines
    _html
  • new_hmac_secret_key
    str

    Cloud Object Storage secret key.

    Examples:
    value
    _source
    _lines
    _html

parameter

WithContext method only

SetInstanceHomeOptions

The SetInstanceHome options.

SetInstanceHomeOptions

The setInstanceHome options.

  • curl -X PUT --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "hmac_access_key": "b9****************************4b", "hmac_secret_key": "fa********************************************8a" }'   "{base_url}/v3/analytics_engines/{instance_id}/instance_home"
  • setInstanceHomeOptions := ibmAnalyticsEngineApiService.NewSetInstanceHomeOptions(
  "e64c907a-e82f-46fd-addc-ccfafbd28b09",
)
setInstanceHomeOptions.SetNewHmacAccessKey("b9****************************4b")
setInstanceHomeOptions.SetNewHmacSecretKey("fa********************************************8a")

instanceHomeResponse, response, err := ibmAnalyticsEngineApiService.SetInstanceHome(setInstanceHomeOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(instanceHomeResponse, "", "  ")
fmt.Println(string(b))
  • SetInstanceHomeOptions setInstanceHomeOptions = new SetInstanceHomeOptions.Builder()
  .instanceId("e64c907a-e82f-46fd-addc-ccfafbd28b09")
  .newHmacAccessKey("b9****************************4b")
  .newHmacSecretKey("fa********************************************8a")
  .build();

Response<InstanceHomeResponse> response = ibmAnalyticsEngineApiService.setInstanceHome(setInstanceHomeOptions).execute();
InstanceHomeResponse instanceHomeResponse = response.getResult();

System.out.println(instanceHomeResponse);
  • const params = {
  instanceId: 'e64c907a-e82f-46fd-addc-ccfafbd28b09',
  newHmacAccessKey: 'b9****************************4b',
  newHmacSecretKey: 'fa********************************************8a',
};

let res;
try {
  res = await ibmAnalyticsEngineApiService.setInstanceHome(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • response = ibm_analytics_engine_api_service.set_instance_home(
  instance_id='e64c907a-e82f-46fd-addc-ccfafbd28b09',
  new_hmac_access_key='b9****************************4b',
  new_hmac_secret_key='fa********************************************8a',
)
instance_home_response = response.get_result()

print(json.dumps(instance_home_response, indent=2))

Response

Response Body

InstanceHomeResponse

Response of Instance home API.

InstanceHomeResponse

Response of Instance home API.

InstanceHomeResponse

Response of Instance home API.

InstanceHomeResponse

Response of Instance home API.

InstanceHomeResponse

Response of Instance home API.

Status Code

  • 200

    Instance home was set.

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Resource Not Found

  • 409

    Conflict. Once instance home is set, it can't be changed.

  • 500

    Internal Server Error

Example responses
  • {
  "instance_id": "701549e6-ab7e-43f2-8b7e-742698c53db8",
  "region": "us-south",
  "endpoint": "https://s3.direct.us-south.cloud-object-storage.appdomain.cloud",
  "hmac_access_key": "b9**********4b",
  "hmac_secret_key": "fa******************8a"
}
  • {
  "instance_id": "701549e6-ab7e-43f2-8b7e-742698c53db8",
  "region": "us-south",
  "endpoint": "https://s3.direct.us-south.cloud-object-storage.appdomain.cloud",
  "hmac_access_key": "b9**********4b",
  "hmac_secret_key": "fa******************8a"
}

Update instance home credentials

Update the HMAC credentials used to access the instance home, if the instance home was set earlier. Credentials must have write access to the object storage used as instance home.

Note: Your running applications and the Spark history server would continue to use the old credentials after updating the HMAC credentials. Before revoking the old credentials, you must either wait for them to finish running or stop them.

Update the HMAC credentials used to access the instance home, if the instance home was set earlier. Credentials must have write access to the object storage used as instance home.

Note: Your running applications and the Spark history server would continue to use the old credentials after updating the HMAC credentials. Before revoking the old credentials, you must either wait for them to finish running or stop them.

Update the HMAC credentials used to access the instance home, if the instance home was set earlier. Credentials must have write access to the object storage used as instance home.

Note: Your running applications and the Spark history server would continue to use the old credentials after updating the HMAC credentials. Before revoking the old credentials, you must either wait for them to finish running or stop them.

Update the HMAC credentials used to access the instance home, if the instance home was set earlier. Credentials must have write access to the object storage used as instance home.

Note: Your running applications and the Spark history server would continue to use the old credentials after updating the HMAC credentials. Before revoking the old credentials, you must either wait for them to finish running or stop them.

Update the HMAC credentials used to access the instance home, if the instance home was set earlier. Credentials must have write access to the object storage used as instance home.

Note: Your running applications and the Spark history server would continue to use the old credentials after updating the HMAC credentials. Before revoking the old credentials, you must either wait for them to finish running or stop them.

PATCH /v3/analytics_engines/{instance_id}/instance_home
updateInstanceHomeCredentials(params)
update_instance_home_credentials(self,
        instance_id: str,
        hmac_access_key: str,
        hmac_secret_key: str,
        **kwargs
    ) -> DetailedResponse
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) UpdateInstanceHomeCredentials(updateInstanceHomeCredentialsOptions *UpdateInstanceHomeCredentialsOptions) (result *InstanceHomeResponse, response *core.DetailedResponse, err error)
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) UpdateInstanceHomeCredentialsWithContext(ctx context.Context, updateInstanceHomeCredentialsOptions *UpdateInstanceHomeCredentialsOptions) (result *InstanceHomeResponse, response *core.DetailedResponse, err error)
ServiceCall<InstanceHomeResponse> updateInstanceHomeCredentials(UpdateInstanceHomeCredentialsOptions updateInstanceHomeCredentialsOptions)

Request

Instantiate the UpdateInstanceHomeCredentialsOptions struct and set the fields to provide parameter values for the UpdateInstanceHomeCredentials method.

Use the UpdateInstanceHomeCredentialsOptions.Builder to create a UpdateInstanceHomeCredentialsOptions object that contains the parameter values for the updateInstanceHomeCredentials method.

Custom Headers

  • Authorization
    Required*
    string

    Identity Access Management (IAM) bearer token.

Path Parameters

  • instance_id
    Required*
    string

    The ID of the Analytics Engine instance.

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    Example: e64c907a-e82f-46fd-addc-ccfafbd28b09

Request Body

Required*
InstanceHomeCredentials

The HMAC credentials to be used for accessing the Object Storage set as instance home.

Examples:
View

parameters

  • instanceId
    Required*
    string

    The ID of the Analytics Engine instance.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html
  • hmacAccessKey
    Required*
    string

    Cloud Object Storage access key.

    Examples:
    value
    _source
    _lines
    _html
  • hmacSecretKey
    Required*
    string

    Cloud Object Storage secret key.

    Examples:
    value
    _source
    _lines
    _html

parameters

  • instance_id
    Required*
    str

    The ID of the Analytics Engine instance.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html
  • hmac_access_key
    Required*
    str

    Cloud Object Storage access key.

    Examples:
    value
    _source
    _lines
    _html
  • hmac_secret_key
    Required*
    str

    Cloud Object Storage secret key.

    Examples:
    value
    _source
    _lines
    _html

parameter

WithContext method only

UpdateInstanceHomeCredentialsOptions

The UpdateInstanceHomeCredentials options.

UpdateInstanceHomeCredentialsOptions

The updateInstanceHomeCredentials options.

  • curl -X PATCH --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ 
    "hmac_access_key": "b9****************************4b", 
    "hmac_secret_key": "fa********************************************8a" 
  }'   "{base_url}/v3/analytics_engines/{instance_id}/instance_home"
  • updateInstanceHomeCredentialsOptions := ibmAnalyticsEngineApiService.NewUpdateInstanceHomeCredentialsOptions(
  "e64c907a-e82f-46fd-addc-ccfafbd28b09",
  "b9****************************4b",
  "fa********************************************8a",
)

instanceHomeResponse, response, err := ibmAnalyticsEngineApiService.UpdateInstanceHomeCredentials(updateInstanceHomeCredentialsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(instanceHomeResponse, "", "  ")
fmt.Println(string(b))
  • UpdateInstanceHomeCredentialsOptions updateInstanceHomeCredentialsOptions = new UpdateInstanceHomeCredentialsOptions.Builder()
  .instanceId("e64c907a-e82f-46fd-addc-ccfafbd28b09")
  .hmacAccessKey("b9****************************4b")
  .hmacSecretKey("fa********************************************8a")
  .build();

Response<InstanceHomeResponse> response = ibmAnalyticsEngineApiService.updateInstanceHomeCredentials(updateInstanceHomeCredentialsOptions).execute();
InstanceHomeResponse instanceHomeResponse = response.getResult();

System.out.println(instanceHomeResponse);
  • const params = {
  instanceId: 'e64c907a-e82f-46fd-addc-ccfafbd28b09',
  hmacAccessKey: 'b9****************************4b',
  hmacSecretKey: 'fa********************************************8a',
};

let res;
try {
  res = await ibmAnalyticsEngineApiService.updateInstanceHomeCredentials(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • response = ibm_analytics_engine_api_service.update_instance_home_credentials(
  instance_id='e64c907a-e82f-46fd-addc-ccfafbd28b09',
  hmac_access_key='b9****************************4b',
  hmac_secret_key='fa********************************************8a',
)
instance_home_response = response.get_result()

print(json.dumps(instance_home_response, indent=2))

Response

Response Body

InstanceHomeResponse

Response of Instance home API.

InstanceHomeResponse

Response of Instance home API.

InstanceHomeResponse

Response of Instance home API.

InstanceHomeResponse

Response of Instance home API.

InstanceHomeResponse

Response of Instance home API.

Status Code

  • 200

    Your instance home credentials have been changed successfully.

  • 400

    Bad request. One or more of the required fields are missing or incorrect. The provided credentials must have write access to the Cloud Object Storage being used as instance home.

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Resource Not Found

  • 409

    Conflict. You can't update instance home credentials at this time. Wait for the instance to be active.

  • 500

    Internal Server Error

Example responses
  • {
  "instance_id": "701549e6-ab7e-43f2-8b7e-742698c53db8",
  "region": "us-south",
  "endpoint": "https://s3.direct.us-south.cloud-object-storage.appdomain.cloud",
  "hmac_access_key": "b9**********4b",
  "hmac_secret_key": "fa******************8a"
}
  • {
  "instance_id": "701549e6-ab7e-43f2-8b7e-742698c53db8",
  "region": "us-south",
  "endpoint": "https://s3.direct.us-south.cloud-object-storage.appdomain.cloud",
  "hmac_access_key": "b9**********4b",
  "hmac_secret_key": "fa******************8a"
}

Get instance default Spark configurations

Get the default Spark configuration properties that will be applied to all applications of the instance.

Get the default Spark configuration properties that will be applied to all applications of the instance.

Get the default Spark configuration properties that will be applied to all applications of the instance.

Get the default Spark configuration properties that will be applied to all applications of the instance.

Get the default Spark configuration properties that will be applied to all applications of the instance.

GET /v3/analytics_engines/{instance_id}/default_configs
getInstanceDefaultConfigs(params)
get_instance_default_configs(self,
        instance_id: str,
        **kwargs
    ) -> DetailedResponse
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetInstanceDefaultConfigs(getInstanceDefaultConfigsOptions *GetInstanceDefaultConfigsOptions) (result map[string]string, response *core.DetailedResponse, err error)
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetInstanceDefaultConfigsWithContext(ctx context.Context, getInstanceDefaultConfigsOptions *GetInstanceDefaultConfigsOptions) (result map[string]string, response *core.DetailedResponse, err error)
ServiceCall<Map<String, String>> getInstanceDefaultConfigs(GetInstanceDefaultConfigsOptions getInstanceDefaultConfigsOptions)

Request

Instantiate the GetInstanceDefaultConfigsOptions struct and set the fields to provide parameter values for the GetInstanceDefaultConfigs method.

Use the GetInstanceDefaultConfigsOptions.Builder to create a GetInstanceDefaultConfigsOptions object that contains the parameter values for the getInstanceDefaultConfigs method.

Custom Headers

  • Authorization
    Required*
    string

    Identity Access Management (IAM) bearer token.

Path Parameters

  • instance_id
    Required*
    string

    The ID of the Analytics Engine instance.

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    Example: e64c907a-e82f-46fd-addc-ccfafbd28b09

parameters

  • instanceId
    Required*
    string

    The ID of the Analytics Engine instance.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameters

  • instance_id
    Required*
    str

    The ID of the Analytics Engine instance.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameter

WithContext method only

GetInstanceDefaultConfigsOptions

The GetInstanceDefaultConfigs options.

GetInstanceDefaultConfigsOptions

The getInstanceDefaultConfigs options.

  • curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/v3/analytics_engines/{instance_id}/default_configs"
  • getInstanceDefaultConfigsOptions := ibmAnalyticsEngineApiService.NewGetInstanceDefaultConfigsOptions(
  "e64c907a-e82f-46fd-addc-ccfafbd28b09",
)

instanceDefaultConfigs, response, err := ibmAnalyticsEngineApiService.GetInstanceDefaultConfigs(getInstanceDefaultConfigsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(instanceDefaultConfigs, "", "  ")
fmt.Println(string(b))
  • GetInstanceDefaultConfigsOptions getInstanceDefaultConfigsOptions = new GetInstanceDefaultConfigsOptions.Builder()
  .instanceId("e64c907a-e82f-46fd-addc-ccfafbd28b09")
  .build();

Response<Map<String, String>> response = ibmAnalyticsEngineApiService.getInstanceDefaultConfigs(getInstanceDefaultConfigsOptions).execute();
Map<String, String> instanceDefaultConfigs = response.getResult();

System.out.println(instanceDefaultConfigs);
  • const params = {
  instanceId: 'e64c907a-e82f-46fd-addc-ccfafbd28b09',
};

let res;
try {
  res = await ibmAnalyticsEngineApiService.getInstanceDefaultConfigs(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • response = ibm_analytics_engine_api_service.get_instance_default_configs(
  instance_id='e64c907a-e82f-46fd-addc-ccfafbd28b09',
)
instance_default_configs = response.get_result()

print(json.dumps(instance_default_configs, indent=2))

Response

Response type: JsonObject

Response type: dict

Response type: map[string]string

Response type: Map<String, String>

Response Body

object

Default Spark configuration properties

Status Code

  • 200

    OK

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Resource Not Found

  • 500

    Internal Server Error

Example responses
  • {
  "spark.driver.memory": "4G",
  "spark.driver.cores": "1"
}
  • {
  "spark.driver.memory": "4G",
  "spark.driver.cores": "1"
}

Replace instance default Spark configurations

Replace the default Spark configuration properties that will be applied to all applications of the instance.

Replace the default Spark configuration properties that will be applied to all applications of the instance.

Replace the default Spark configuration properties that will be applied to all applications of the instance.

Replace the default Spark configuration properties that will be applied to all applications of the instance.

Replace the default Spark configuration properties that will be applied to all applications of the instance.

PUT /v3/analytics_engines/{instance_id}/default_configs
replaceInstanceDefaultConfigs(params)
replace_instance_default_configs(self,
        instance_id: str,
        body: dict,
        **kwargs
    ) -> DetailedResponse
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) ReplaceInstanceDefaultConfigs(replaceInstanceDefaultConfigsOptions *ReplaceInstanceDefaultConfigsOptions) (result map[string]string, response *core.DetailedResponse, err error)
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) ReplaceInstanceDefaultConfigsWithContext(ctx context.Context, replaceInstanceDefaultConfigsOptions *ReplaceInstanceDefaultConfigsOptions) (result map[string]string, response *core.DetailedResponse, err error)
ServiceCall<Map<String, String>> replaceInstanceDefaultConfigs(ReplaceInstanceDefaultConfigsOptions replaceInstanceDefaultConfigsOptions)

Request

Instantiate the ReplaceInstanceDefaultConfigsOptions struct and set the fields to provide parameter values for the ReplaceInstanceDefaultConfigs method.

Use the ReplaceInstanceDefaultConfigsOptions.Builder to create a ReplaceInstanceDefaultConfigsOptions object that contains the parameter values for the replaceInstanceDefaultConfigs method.

Custom Headers

  • Authorization
    Required*
    string

    Identity Access Management (IAM) bearer token.

Path Parameters

  • instance_id
    Required*
    string

    The ID of the Analytics Engine instance.

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    Example: e64c907a-e82f-46fd-addc-ccfafbd28b09

Request Body

Required*
object

Spark configuration properties to replace existing instance default Spark configurations.

Examples:
View

parameters

  • instanceId
    Required*
    string

    The ID of the Analytics Engine instance.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html
  • body
    Required*
    JsonObject

    Spark configuration properties to replace existing instance default Spark configurations.

    Examples:
    value
    _source
    _lines
    _html

parameters

  • instance_id
    Required*
    str

    The ID of the Analytics Engine instance.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html
  • body
    Required*
    dict

    Spark configuration properties to replace existing instance default Spark configurations.

    Examples:
    value
    _source
    _lines
    _html

parameter

WithContext method only

ReplaceInstanceDefaultConfigsOptions

The ReplaceInstanceDefaultConfigs options.

ReplaceInstanceDefaultConfigsOptions

The replaceInstanceDefaultConfigs options.

  • curl -X PUT --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ 
    "spark.driver.memory": "8G",
    "spark.driver.cores": "2" 
  }'   "{base_url}/v3/analytics_engines/{instance_id}/default_configs"
  • defaultConfigs := map[string]string {
  "spark.driver.memory": "8G",
  "spark.driver.cores": "2",
}

replaceInstanceDefaultConfigsOptions := ibmAnalyticsEngineApiService.NewReplaceInstanceDefaultConfigsOptions(
  "e64c907a-e82f-46fd-addc-ccfafbd28b09",
  defaultConfigs,
)

instanceDefaultConfigs, response, err := ibmAnalyticsEngineApiService.ReplaceInstanceDefaultConfigs(replaceInstanceDefaultConfigsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(instanceDefaultConfigs, "", "  ")
fmt.Println(string(b))
  • Map<String, String> newDefaultConfigs = new java.util.HashMap<String, String>();
newDefaultConfigs.put("spark.driver.memory", "8G");
newDefaultConfigs.put("spark.driver.cores", "2");

ReplaceInstanceDefaultConfigsOptions replaceInstanceDefaultConfigsOptions = new ReplaceInstanceDefaultConfigsOptions.Builder()
  .instanceId("e64c907a-e82f-46fd-addc-ccfafbd28b09")
  .body(newDefaultConfigs)
  .build();

Response<Map<String, String>> response = ibmAnalyticsEngineApiService.replaceInstanceDefaultConfigs(replaceInstanceDefaultConfigsOptions).execute();
Map<String, String> instanceDefaultConfigs = response.getResult();

System.out.println(instanceDefaultConfigs);
  • const params = {
  instanceId: 'e64c907a-e82f-46fd-addc-ccfafbd28b09',
  body: {
    'spark.driver.memory': '8G',
    'spark.driver.cores': '2',
  },
};

let res;
try {
  res = await ibmAnalyticsEngineApiService.replaceInstanceDefaultConfigs(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • response = ibm_analytics_engine_api_service.replace_instance_default_configs(
  instance_id='e64c907a-e82f-46fd-addc-ccfafbd28b09',
  body={
    'spark.driver.memory': '8G',
    'spark.driver.cores': '2',
  },
)
instance_default_configs = response.get_result()

print(json.dumps(instance_default_configs, indent=2))

Response

Response type: JsonObject

Response type: dict

Response type: map[string]string

Response type: Map<String, String>

Response Body

object

Default Spark configuration properties

Status Code

  • 200

    Instance default Spark configurations were replaced.

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Resource Not Found

  • 500

    Internal Server Error

Example responses
  • {
  "spark.driver.memory": "8G",
  "spark.driver.cores": "2"
}
  • {
  "spark.driver.memory": "8G",
  "spark.driver.cores": "2"
}

Update instance default Spark configurations

Update the default Spark configuration properties that will be applied to all applications of the instance.

Update the default Spark configuration properties that will be applied to all applications of the instance.

Update the default Spark configuration properties that will be applied to all applications of the instance.

Update the default Spark configuration properties that will be applied to all applications of the instance.

Update the default Spark configuration properties that will be applied to all applications of the instance.

PATCH /v3/analytics_engines/{instance_id}/default_configs
updateInstanceDefaultConfigs(params)
update_instance_default_configs(self,
        instance_id: str,
        body: dict,
        **kwargs
    ) -> DetailedResponse
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) UpdateInstanceDefaultConfigs(updateInstanceDefaultConfigsOptions *UpdateInstanceDefaultConfigsOptions) (result map[string]string, response *core.DetailedResponse, err error)
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) UpdateInstanceDefaultConfigsWithContext(ctx context.Context, updateInstanceDefaultConfigsOptions *UpdateInstanceDefaultConfigsOptions) (result map[string]string, response *core.DetailedResponse, err error)
ServiceCall<Map<String, String>> updateInstanceDefaultConfigs(UpdateInstanceDefaultConfigsOptions updateInstanceDefaultConfigsOptions)

Request

Instantiate the UpdateInstanceDefaultConfigsOptions struct and set the fields to provide parameter values for the UpdateInstanceDefaultConfigs method.

Use the UpdateInstanceDefaultConfigsOptions.Builder to create a UpdateInstanceDefaultConfigsOptions object that contains the parameter values for the updateInstanceDefaultConfigs method.

Custom Headers

  • Authorization
    Required*
    string

    Identity Access Management (IAM) bearer token.

  • Content-Type
    string

    Allowable values: [application/merge-patch+json,application/json]

Path Parameters

  • instance_id
    Required*
    string

    The ID of the Analytics Engine instance.

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    Example: e64c907a-e82f-46fd-addc-ccfafbd28b09

Request Body

Required*
application/merge-patch+jsonobject

Spark configuration properties to be updated. Properties will be merged with existing configuration properties. Set a property value to null in order to unset it.

Examples:
View

parameters

  • instanceId
    Required*
    string

    The ID of the Analytics Engine instance.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html
  • body
    Required*
    JsonObject

    Spark configuration properties to be updated. Properties will be merged with existing configuration properties. Set a property value to null in order to unset it.

    Examples:
    value
    _source
    _lines
    _html

parameters

  • instance_id
    Required*
    str

    The ID of the Analytics Engine instance.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html
  • body
    Required*
    dict

    Spark configuration properties to be updated. Properties will be merged with existing configuration properties. Set a property value to null in order to unset it.

    Examples:
    value
    _source
    _lines
    _html

parameter

WithContext method only

UpdateInstanceDefaultConfigsOptions

The UpdateInstanceDefaultConfigs options.

UpdateInstanceDefaultConfigsOptions

The updateInstanceDefaultConfigs options.

  • curl -X PATCH --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/merge-patch+json"   --data '{ 
    "ae.spark.history-server.cores": "1",
    "ae.spark.history-server.memory": "4G" 
  }'   "{base_url}/v3/analytics_engines/{instance_id}/default_configs"
  • defaultConfigs := map[string]interface{} {
  "ae.spark.history-server.cores": "1",
  "ae.spark.history-server.memory": "4G",
}

updateInstanceDefaultConfigsOptions := ibmAnalyticsEngineApiService.NewUpdateInstanceDefaultConfigsOptions(
  "e64c907a-e82f-46fd-addc-ccfafbd28b09",
  defaultConfigs,
)

instanceDefaultConfigs, response, err := ibmAnalyticsEngineApiService.UpdateInstanceDefaultConfigs(updateInstanceDefaultConfigsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(instanceDefaultConfigs, "", "  ")
fmt.Println(string(b))
  • Map<String, Object> defaultConfigsUpdate = new java.util.HashMap<String, Object>();
defaultConfigsUpdate.put("ae.spark.history-server.cores", "1");
defaultConfigsUpdate.put("ae.spark.history-server.memory", "4G");

UpdateInstanceDefaultConfigsOptions updateInstanceDefaultConfigsOptions = new UpdateInstanceDefaultConfigsOptions.Builder()
  .instanceId("e64c907a-e82f-46fd-addc-ccfafbd28b09")
  .body(defaultConfigsUpdate)
  .build();

Response<Map<String, String>> response = ibmAnalyticsEngineApiService.updateInstanceDefaultConfigs(updateInstanceDefaultConfigsOptions).execute();
Map<String, String> instanceDefaultConfigs = response.getResult();

System.out.println(instanceDefaultConfigs);
  • const params = {
  instanceId: 'e64c907a-e82f-46fd-addc-ccfafbd28b09',
  body: {
    'ae.spark.history-server.cores': '1',
    'ae.spark.history-server.memory': '4G',
  },
};

let res;
try {
  res = await ibmAnalyticsEngineApiService.updateInstanceDefaultConfigs(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • response = ibm_analytics_engine_api_service.update_instance_default_configs(
  instance_id='e64c907a-e82f-46fd-addc-ccfafbd28b09',
  body={
    'ae.spark.history-server.cores': '1',
    'ae.spark.history-server.memory': '4G',
  },
)
instance_default_configs = response.get_result()

print(json.dumps(instance_default_configs, indent=2))

Response

Response type: JsonObject

Response type: dict

Response type: map[string]string

Response type: Map<String, String>

Response Body

object

Default Spark configuration properties

Status Code

  • 200

    Instance default Spark configurations were updated.

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Resource Not Found

  • 500

    Internal Server Error

Example responses
  • {
  "ae.spark.history-server.cores": "1",
  "ae.spark.history-server.memory": "4G",
  "spark.driver.memory": "8G",
  "spark.driver.cores": "2"
}
  • {
  "ae.spark.history-server.cores": "1",
  "ae.spark.history-server.memory": "4G",
  "spark.driver.memory": "8G",
  "spark.driver.cores": "2"
}

Get instance default runtime

Get the default runtime environment on which all workloads of the instance will run.

Get the default runtime environment on which all workloads of the instance will run.

Get the default runtime environment on which all workloads of the instance will run.

Get the default runtime environment on which all workloads of the instance will run.

Get the default runtime environment on which all workloads of the instance will run.

GET /v3/analytics_engines/{instance_id}/default_runtime
getInstanceDefaultRuntime(params)
get_instance_default_runtime(self,
        instance_id: str,
        **kwargs
    ) -> DetailedResponse
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetInstanceDefaultRuntime(getInstanceDefaultRuntimeOptions *GetInstanceDefaultRuntimeOptions) (result *Runtime, response *core.DetailedResponse, err error)
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetInstanceDefaultRuntimeWithContext(ctx context.Context, getInstanceDefaultRuntimeOptions *GetInstanceDefaultRuntimeOptions) (result *Runtime, response *core.DetailedResponse, err error)
ServiceCall<Runtime> getInstanceDefaultRuntime(GetInstanceDefaultRuntimeOptions getInstanceDefaultRuntimeOptions)

Request

Instantiate the GetInstanceDefaultRuntimeOptions struct and set the fields to provide parameter values for the GetInstanceDefaultRuntime method.

Use the GetInstanceDefaultRuntimeOptions.Builder to create a GetInstanceDefaultRuntimeOptions object that contains the parameter values for the getInstanceDefaultRuntime method.

Custom Headers

  • Authorization
    Required*
    string

    Identity Access Management (IAM) bearer token.

Path Parameters

  • instance_id
    Required*
    string

    The ID of the Analytics Engine instance.

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    Example: e64c907a-e82f-46fd-addc-ccfafbd28b09

parameters

  • instanceId
    Required*
    string

    The ID of the Analytics Engine instance.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameters

  • instance_id
    Required*
    str

    The ID of the Analytics Engine instance.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameter

WithContext method only

GetInstanceDefaultRuntimeOptions

The GetInstanceDefaultRuntime options.

GetInstanceDefaultRuntimeOptions

The getInstanceDefaultRuntime options.

  • curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/v3/analytics_engines/{instance_id}/default_runtime"
  • getInstanceDefaultRuntimeOptions := ibmAnalyticsEngineApiService.NewGetInstanceDefaultRuntimeOptions(
  "e64c907a-e82f-46fd-addc-ccfafbd28b09",
)

runtime, response, err := ibmAnalyticsEngineApiService.GetInstanceDefaultRuntime(getInstanceDefaultRuntimeOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(runtime, "", "  ")
fmt.Println(string(b))
  • GetInstanceDefaultRuntimeOptions getInstanceDefaultRuntimeOptions = new GetInstanceDefaultRuntimeOptions.Builder()
  .instanceId("e64c907a-e82f-46fd-addc-ccfafbd28b09")
  .build();

Response<Runtime> response = ibmAnalyticsEngineApiService.getInstanceDefaultRuntime(getInstanceDefaultRuntimeOptions).execute();
Runtime runtime = response.getResult();

System.out.println(runtime);
  • const params = {
  instanceId: 'e64c907a-e82f-46fd-addc-ccfafbd28b09',
};

let res;
try {
  res = await ibmAnalyticsEngineApiService.getInstanceDefaultRuntime(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • response = ibm_analytics_engine_api_service.get_instance_default_runtime(
  instance_id='e64c907a-e82f-46fd-addc-ccfafbd28b09',
)
runtime = response.get_result()

print(json.dumps(runtime, indent=2))

Response

Response Body

Runtime

Runtime enviroment for applications and other workloads.

Runtime

Runtime enviroment for applications and other workloads.

Runtime

Runtime enviroment for applications and other workloads.

Runtime

Runtime enviroment for applications and other workloads.

Runtime

Runtime enviroment for applications and other workloads.

Status Code

  • 200

    OK

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Resource Not Found

  • 500

    Internal Server Error

Example responses
  • {
  "spark_version": "3.1"
}
  • {
  "spark_version": "3.1"
}

Replace instance default runtime

Replace the default runtime environment on which all workloads of the instance will run.

Replace the default runtime environment on which all workloads of the instance will run.

Replace the default runtime environment on which all workloads of the instance will run.

Replace the default runtime environment on which all workloads of the instance will run.

Replace the default runtime environment on which all workloads of the instance will run.

PUT /v3/analytics_engines/{instance_id}/default_runtime
replaceInstanceDefaultRuntime(params)
replace_instance_default_runtime(self,
        instance_id: str,
        *,
        spark_version: str = None,
        **kwargs
    ) -> DetailedResponse
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) ReplaceInstanceDefaultRuntime(replaceInstanceDefaultRuntimeOptions *ReplaceInstanceDefaultRuntimeOptions) (result *Runtime, response *core.DetailedResponse, err error)
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) ReplaceInstanceDefaultRuntimeWithContext(ctx context.Context, replaceInstanceDefaultRuntimeOptions *ReplaceInstanceDefaultRuntimeOptions) (result *Runtime, response *core.DetailedResponse, err error)
ServiceCall<Runtime> replaceInstanceDefaultRuntime(ReplaceInstanceDefaultRuntimeOptions replaceInstanceDefaultRuntimeOptions)

Request

Instantiate the ReplaceInstanceDefaultRuntimeOptions struct and set the fields to provide parameter values for the ReplaceInstanceDefaultRuntime method.

Use the ReplaceInstanceDefaultRuntimeOptions.Builder to create a ReplaceInstanceDefaultRuntimeOptions object that contains the parameter values for the replaceInstanceDefaultRuntime method.

Custom Headers

  • Authorization
    Required*
    string

    Identity Access Management (IAM) bearer token.

Path Parameters

  • instance_id
    Required*
    string

    The ID of the Analytics Engine instance.

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    Example: e64c907a-e82f-46fd-addc-ccfafbd28b09

Request Body

Required*
Runtime

Default runtime environment on which all workloads will run.

Examples:
View

parameters

  • instanceId
    Required*
    string

    The ID of the Analytics Engine instance.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html
  • sparkVersion
    string

    Spark version of the runtime environment.

    Allowable values: [3.1,3.3]

parameters

  • instance_id
    Required*
    str

    The ID of the Analytics Engine instance.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html
  • spark_version
    str

    Spark version of the runtime environment.

    Allowable values: [3.1,3.3]

parameter

WithContext method only

ReplaceInstanceDefaultRuntimeOptions

The ReplaceInstanceDefaultRuntime options.

ReplaceInstanceDefaultRuntimeOptions

The replaceInstanceDefaultRuntime options.

  • curl -X PUT --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "spark_runtime": "3.3" }'   "{base_url}/v3/analytics_engines/{instance_id}/default_runtime"
  • replaceInstanceDefaultRuntimeOptions := ibmAnalyticsEngineApiService.NewReplaceInstanceDefaultRuntimeOptions(
  "e64c907a-e82f-46fd-addc-ccfafbd28b09",
)
replaceInstanceDefaultRuntimeOptions.SetSparkVersion("3.3")

runtime, response, err := ibmAnalyticsEngineApiService.ReplaceInstanceDefaultRuntime(replaceInstanceDefaultRuntimeOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(runtime, "", "  ")
fmt.Println(string(b))
  • ReplaceInstanceDefaultRuntimeOptions replaceInstanceDefaultRuntimeOptions = new ReplaceInstanceDefaultRuntimeOptions.Builder()
  .instanceId("e64c907a-e82f-46fd-addc-ccfafbd28b09")
  .sparkVersion("3.3")
  .build();

Response<Runtime> response = ibmAnalyticsEngineApiService.replaceInstanceDefaultRuntime(replaceInstanceDefaultRuntimeOptions).execute();
Runtime runtime = response.getResult();

System.out.println(runtime);
  • const params = {
  instanceId: 'e64c907a-e82f-46fd-addc-ccfafbd28b09',
  sparkVersion: '3.3',
};

let res;
try {
  res = await ibmAnalyticsEngineApiService.replaceInstanceDefaultRuntime(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • response = ibm_analytics_engine_api_service.replace_instance_default_runtime(
  instance_id='e64c907a-e82f-46fd-addc-ccfafbd28b09',
  spark_version='3.3'
)
runtime = response.get_result()

print(json.dumps(runtime, indent=2))

Response

Response Body

Runtime

Runtime enviroment for applications and other workloads.

Runtime

Runtime enviroment for applications and other workloads.

Runtime

Runtime enviroment for applications and other workloads.

Runtime

Runtime enviroment for applications and other workloads.

Runtime

Runtime enviroment for applications and other workloads.

Status Code

  • 200

    Instance default runtime was replaced.

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Resource Not Found

  • 500

    Internal Server Error

Example responses
  • {
  "spark_version": "3.3"
}
  • {
  "spark_version": "3.3"
}

Deploy a Spark application

Deploys a Spark application on a given serverless Spark instance.

Deploys a Spark application on a given serverless Spark instance.

Deploys a Spark application on a given serverless Spark instance.

Deploys a Spark application on a given serverless Spark instance.

Deploys a Spark application on a given serverless Spark instance.

POST /v3/analytics_engines/{instance_id}/spark_applications
createApplication(params)
create_application(self,
        instance_id: str,
        *,
        application_details: 'ApplicationRequestApplicationDetails' = None,
        **kwargs
    ) -> DetailedResponse
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) CreateApplication(createApplicationOptions *CreateApplicationOptions) (result *ApplicationResponse, response *core.DetailedResponse, err error)
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) CreateApplicationWithContext(ctx context.Context, createApplicationOptions *CreateApplicationOptions) (result *ApplicationResponse, response *core.DetailedResponse, err error)
ServiceCall<ApplicationResponse> createApplication(CreateApplicationOptions createApplicationOptions)

Request

Instantiate the CreateApplicationOptions struct and set the fields to provide parameter values for the CreateApplication method.

Use the CreateApplicationOptions.Builder to create a CreateApplicationOptions object that contains the parameter values for the createApplication method.

Custom Headers

  • Authorization
    Required*
    string

    Identity Access Management (IAM) bearer token.

Path Parameters

  • instance_id
    Required*
    string

    The identifier of the Analytics Engine instance associated with the Spark application(s).

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    Example: e64c907a-e82f-46fd-addc-ccfafbd28b09

Request Body

Required*
ApplicationRequest

Request json to deploy a Spark application

Examples:
View

parameters

  • instanceId
    Required*
    string

    The identifier of the Analytics Engine instance associated with the Spark application(s).

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html
  • applicationDetails

    Application details.

parameters

  • instance_id
    Required*
    str

    The identifier of the Analytics Engine instance associated with the Spark application(s).

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html
  • application_details

    Application details.

parameter

WithContext method only

CreateApplicationOptions

The CreateApplication options.

CreateApplicationOptions

The createApplication options.

  • curl -X POST --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ 
    "application_details": { 
      "application": "/opt/ibm/spark/examples/src/main/python/wordcount.py", 
      "arguments": [ "/opt/ibm/spark/examples/src/main/resources/people.txt" ], 
      "runtime": { 
        "spark_version": "3.3" 
      }
    }
  }'   "{base_url}/v3/analytics_engines/{instance_id}/spark_applications"
  • createApplicationOptions := ibmAnalyticsEngineApiService.NewCreateApplicationOptions(
  "e64c907a-e82f-46fd-addc-ccfafbd28b09",
)

createApplicationOptions.SetApplication("/opt/ibm/spark/examples/src/main/python/wordcount.py")
createApplicationOptions.SetArguments([]string{"/opt/ibm/spark/examples/src/main/resources/people.txt"})
createApplicationOptions.SetRuntime(&ibmanalyticsengineapiv3.Runtime{
  SparkVersion: core.StringPtr("3.3"),
})

applicationResponse, response, err := ibmAnalyticsEngineApiService.CreateApplication(createApplicationOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(applicationResponse, "", "  ")
fmt.Println(string(b))
  • Runtime runtimeModel = new Runtime.Builder()
  .sparkVersion("3.3")
  .build();
ApplicationRequestApplicationDetails applicationRequestApplicationDetailsModel = new ApplicationRequestApplicationDetails.Builder()
  .application("/opt/ibm/spark/examples/src/main/python/wordcount.py")
  .runtime(runtimeModel)
  .arguments(java.util.Arrays.asList("/opt/ibm/spark/examples/src/main/resources/people.txt"))
  .build();
CreateApplicationOptions createApplicationOptions = new CreateApplicationOptions.Builder()
  .instanceId("e64c907a-e82f-46fd-addc-ccfafbd28b09")
  .applicationDetails(applicationRequestApplicationDetailsModel)
  .build();

Response<ApplicationResponse> response = ibmAnalyticsEngineApiService.createApplication(createApplicationOptions).execute();
ApplicationResponse applicationResponse = response.getResult();

System.out.println(applicationResponse);
  • // Request models needed by this operation.

// Runtime
const runtimeModel = {
  spark_version: '3.3',
};

// ApplicationRequestApplicationDetails
const applicationRequestApplicationDetailsModel = {
  application: '/opt/ibm/spark/examples/src/main/python/wordcount.py',
  runtime: runtimeModel,
  arguments: ['/opt/ibm/spark/examples/src/main/resources/people.txt'],
};

const params = {
  instanceId: 'e64c907a-e82f-46fd-addc-ccfafbd28b09',
  applicationDetails: applicationRequestApplicationDetailsModel,
};

let res;
try {
  res = await ibmAnalyticsEngineApiService.createApplication(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • runtime_model = {
  'spark_version': '3.3',
}

application_request_application_details_model = {
  'application': '/opt/ibm/spark/examples/src/main/python/wordcount.py',
  'runtime': runtime_model,
  'arguments': ['/opt/ibm/spark/examples/src/main/resources/people.txt'],
}

response = ibm_analytics_engine_api_service.create_application(
  instance_id='e64c907a-e82f-46fd-addc-ccfafbd28b09',
  application_details=application_request_application_details_model,
)
application_response = response.get_result()

print(json.dumps(application_response, indent=2))

Response

Response Body

ApplicationResponse

Application response details

ApplicationResponse

Application response details.

ApplicationResponse

Application response details.

ApplicationResponse

Application response details.

ApplicationResponse

Application response details.

Status Code

  • 202

    Spark application submission accepted.

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Resource Not Found

  • 500

    Internal Server Error

Example responses
  • {
  "id": "87e63712-a823-4aa1-9f6e-7291d4e5a113",
  "state": "accepted"
}
  • {
  "id": "87e63712-a823-4aa1-9f6e-7291d4e5a113",
  "state": "accepted"
}

List all Spark applications

Returns a list of all Spark applications submitted to the specified Analytics Engine instance. The result can be filtered by specifying query parameters.

Returns a list of all Spark applications submitted to the specified Analytics Engine instance. The result can be filtered by specifying query parameters.

Returns a list of all Spark applications submitted to the specified Analytics Engine instance. The result can be filtered by specifying query parameters.

Returns a list of all Spark applications submitted to the specified Analytics Engine instance. The result can be filtered by specifying query parameters.

Returns a list of all Spark applications submitted to the specified Analytics Engine instance. The result can be filtered by specifying query parameters.

GET /v3/analytics_engines/{instance_id}/spark_applications
listApplications(params)
list_applications(self,
        instance_id: str,
        *,
        state: List[str] = None,
        limit: int = None,
        start: str = None,
        **kwargs
    ) -> DetailedResponse
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) ListApplications(listApplicationsOptions *ListApplicationsOptions) (result *ApplicationCollection, response *core.DetailedResponse, err error)
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) ListApplicationsWithContext(ctx context.Context, listApplicationsOptions *ListApplicationsOptions) (result *ApplicationCollection, response *core.DetailedResponse, err error)
ServiceCall<ApplicationCollection> listApplications(ListApplicationsOptions listApplicationsOptions)

Request

Instantiate the ListApplicationsOptions struct and set the fields to provide parameter values for the ListApplications method.

Use the ListApplicationsOptions.Builder to create a ListApplicationsOptions object that contains the parameter values for the listApplications method.

Custom Headers

  • Authorization
    Required*
    string

    Identity Access Management (IAM) bearer token.

Path Parameters

  • instance_id
    Required*
    string

    The identifier of the Analytics Engine instance associated with the Spark application(s).

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    Example: e64c907a-e82f-46fd-addc-ccfafbd28b09

Query Parameters

  • state
    string[]

    List of Spark application states that will be used to filter the response.

    Allowable values: [finished,running,failed,accepted,stopped,auto_terminated,ops_terminated]

  • start_time_interval
    string

    Time interval to use for filtering applications by their start time. Interval is specified in the format <lower timestamp limit>,<upper timestamp limit>. Each timestamp value must be ISO 8601 compliant. You may also use keywords BEGINNING as a placeholder value for lower timestamp limit and CURRENT as a placeholder value for upper timestamp limit. Note: The lower timestamp limit is inclusive, whereas the upper timestamp limit is exclusive.

  • submission_time_interval
    string

    Time interval to use for filtering applications by their submission time. Interval is specified in the format <lower timestamp limit>,<upper timestamp limit>. Each timestamp value must be ISO 8601 compliant. You may also use keywords BEGINNING as a placeholder value for lower timestamp limit and CURRENT as a placeholder value for upper timestamp limit. Note: The lower timestamp limit is inclusive, whereas the upper timestamp limit is exclusive.

  • end_time_interval
    string

    Time interval to use for filtering applications by their end time. Interval is specified in the format <lower timestamp limit>,<upper timestamp limit>. Each timestamp value must be ISO 8601 compliant. You may also use keywords BEGINNING as a placeholder value for lower timestamp limit and CURRENT as a placeholder value for upper timestamp limit. Note: The lower timestamp limit is inclusive, whereas the upper timestamp limit is exclusive.

  • limit
    integer

    Number of application entries to be included in the response.

    Possible values: 1 ≤ value ≤ 1000

    Default: 25

  • start
    string

    Token used to fetch the next or the previous page of the applications list.

    Possible values: 1 ≤ length ≤ 84, Value must match regular expression ^[A-Za-z0-9_-]+$

parameters

  • instanceId
    Required*
    string

    The identifier of the Analytics Engine instance associated with the Spark application(s).

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html
  • state
    string[]

    List of Spark application states that will be used to filter the response.

    Allowable values: [finished,running,failed,accepted,stopped,auto_terminated,ops_terminated]

  • limit
    number

    Number of application entries to be included in the response.

    Possible values: 1 ≤ value ≤ 10000

  • start
    string

    Token used to fetch the next or the previous page of the applications list.

    Possible values: 1 ≤ length ≤ 84, Value must match regular expression /^[A-Za-z0-9_-]+$/

parameters

  • instance_id
    Required*
    str

    The identifier of the Analytics Engine instance associated with the Spark application(s).

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html
  • state
    List[str]

    List of Spark application states that will be used to filter the response.

    Allowable values: [finished,running,failed,accepted,stopped,auto_terminated,ops_terminated]

  • limit
    int

    Number of application entries to be included in the response.

    Possible values: 1 ≤ value ≤ 10000

  • start
    str

    Token used to fetch the next or the previous page of the applications list.

    Possible values: 1 ≤ length ≤ 84, Value must match regular expression /^[A-Za-z0-9_-]+$/

parameter

WithContext method only

ListApplicationsOptions

The ListApplications options.

ListApplicationsOptions

The listApplications options.

  • curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/v3/analytics_engines/{instance_id}/spark_applications?state=accepted,running,finished,failed&limit=25"
  • listApplicationsOptions := &ibmanalyticsengineapiv3.ListApplicationsOptions{
  InstanceID: core.StringPtr("e64c907a-e82f-46fd-addc-ccfafbd28b09"),
  State: []string{"accepted", "running", "finished", "failed"},
  Limit: core.Int64Ptr(int64(25)),
}

pager, err := ibmAnalyticsEngineApiService.NewApplicationsPager(listApplicationsOptions)
if err != nil {
  panic(err)
}

var allResults []ibmanalyticsengineapiv3.Application
for pager.HasNext() {
  nextPage, err := pager.GetNext()
  if err != nil {
    panic(err)
  }
  allResults = append(allResults, nextPage...)
}
b, _ := json.MarshalIndent(allResults, "", "  ")
fmt.Println(string(b))
  • ListApplicationsOptions listApplicationsOptions = new ListApplicationsOptions.Builder()
  .instanceId("e64c907a-e82f-46fd-addc-ccfafbd28b09")
  .addState("accepted")
  .addState("running")
  .addState("finished")
  .addState("failed")
  .limit(Long.valueOf("25"))
  .build();

ApplicationsPager pager = new ApplicationsPager(ibmAnalyticsEngineApiService, listApplicationsOptions);
List<Application> allResults = new ArrayList<>();
while (pager.hasNext()) {
  List<Application> nextPage = pager.getNext();
  allResults.addAll(nextPage);
}

System.out.println(GsonSingleton.getGson().toJson(allResults));
  • const params = {
  instanceId: 'e64c907a-e82f-46fd-addc-ccfafbd28b09',
  state: ['accepted', 'running', 'finished', 'failed'],
  limit: 25,
};

const allResults = [];
try {
  const pager = new IbmAnalyticsEngineApiV3.ApplicationsPager(
    ibmAnalyticsEngineApiService,
    params
  );
  while (pager.hasNext()) {
    const nextPage = await pager.getNext();
    expect(nextPage).not.toBeNull();
    allResults.push(...nextPage);
  }
  console.log(JSON.stringify(allResults, null, 2));
} catch (err) {
  console.warn(err);
}
  • all_results = []
pager = ApplicationsPager(
  client=ibm_analytics_engine_api_service,
  instance_id='e64c907a-e82f-46fd-addc-ccfafbd28b09',
  state=['accepted', 'running', 'finished', 'failed'],
  limit=10,
)
while pager.has_next():
  next_page = pager.get_next()
  assert next_page is not None
  all_results.extend(next_page)

print(json.dumps(all_results, indent=2))

Response

Response Body

ApplicationCollection

A paginated collection of applications

ApplicationCollection

A paginated collection of applications.

ApplicationCollection

A paginated collection of applications.

ApplicationCollection

A paginated collection of applications.

ApplicationCollection

A paginated collection of applications.

Status Code

  • 200

    OK

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Resource Not Found

  • 500

    Internal Server Error

Example responses
  • {
  "applications": [
    {
      "id": "db933645-0b68-4dcb-80d8-7b71a6c8e542",
      "spark_application_id": "app-20211009103247-0000",
      "spark_application_name": "PythonWordCount",
      "state": "finished",
      "submission_time": "2021-04-21T04:23:50Z",
      "start_time": "2021-04-21T04:24:01Z",
      "end_time": "2021-04-21T04:25:18Z",
      "finish_time": "2021-04-21T04:25:18Z",
      "auto_termination_time": "2021-04-24T04:24:01Z"
    },
    {
      "id": "a2a2b23f-0929-4c49-9cc0-bd4c2bf953d9",
      "spark_application_id": "app-20211009103147-0000",
      "spark_application_name": "PythonWordCount",
      "state": "finished",
      "submission_time": "2021-04-21T04:21:50Z",
      "start_time": "2021-04-21T04:22:01Z",
      "end_time": "2021-04-21T04:23:18Z",
      "finish_time": "2021-04-21T04:23:18Z",
      "auto_termination_time": "2021-04-24T04:22:01Z"
    }
  ],
  "first": {
    "href": "https://api.us-south.ae.cloud.ibm.com/v3/analytics_engines/e64c907a-e82f-46fd-addc-ccfafbd28b09/spark_applications?limit=25"
  },
  "next": {
    "href": "https://api.us-south.ae.cloud.ibm.com/v3/analytics_engines/e64c907a-e82f-46fd-addc-ccfafbd28b09/spark_applications?limit=25&start=QiwyMDIyLTA5LTI2IDA4OjE4OjU2LjE4MiwxMDAyYTVlZC0xZWU4LTQwZWItOWUyNC00OTMyNTcxZjgzYzE",
    "start": "QiwyMDIyLTA5LTI2IDA4OjE4OjU2LjE4MiwxMDAyYTVlZC0xZWU4LTQwZWItOWUyNC00OTMyNTcxZjgzYzE"
  },
  "limit": 25
}
  • {
  "applications": [
    {
      "id": "db933645-0b68-4dcb-80d8-7b71a6c8e542",
      "spark_application_id": "app-20211009103247-0000",
      "spark_application_name": "PythonWordCount",
      "state": "finished",
      "submission_time": "2021-04-21T04:23:50Z",
      "start_time": "2021-04-21T04:24:01Z",
      "end_time": "2021-04-21T04:25:18Z",
      "finish_time": "2021-04-21T04:25:18Z",
      "auto_termination_time": "2021-04-24T04:24:01Z"
    },
    {
      "id": "a2a2b23f-0929-4c49-9cc0-bd4c2bf953d9",
      "spark_application_id": "app-20211009103147-0000",
      "spark_application_name": "PythonWordCount",
      "state": "finished",
      "submission_time": "2021-04-21T04:21:50Z",
      "start_time": "2021-04-21T04:22:01Z",
      "end_time": "2021-04-21T04:23:18Z",
      "finish_time": "2021-04-21T04:23:18Z",
      "auto_termination_time": "2021-04-24T04:22:01Z"
    }
  ],
  "first": {
    "href": "https://api.us-south.ae.cloud.ibm.com/v3/analytics_engines/e64c907a-e82f-46fd-addc-ccfafbd28b09/spark_applications?limit=25"
  },
  "next": {
    "href": "https://api.us-south.ae.cloud.ibm.com/v3/analytics_engines/e64c907a-e82f-46fd-addc-ccfafbd28b09/spark_applications?limit=25&start=QiwyMDIyLTA5LTI2IDA4OjE4OjU2LjE4MiwxMDAyYTVlZC0xZWU4LTQwZWItOWUyNC00OTMyNTcxZjgzYzE",
    "start": "QiwyMDIyLTA5LTI2IDA4OjE4OjU2LjE4MiwxMDAyYTVlZC0xZWU4LTQwZWItOWUyNC00OTMyNTcxZjgzYzE"
  },
  "limit": 25
}

Retrieve the details of a given Spark application

Gets the details of a given Spark application.

Gets the details of a given Spark application.

Gets the details of a given Spark application.

Gets the details of a given Spark application.

Gets the details of a given Spark application.

GET /v3/analytics_engines/{instance_id}/spark_applications/{application_id}
getApplication(params)
get_application(self,
        instance_id: str,
        application_id: str,
        **kwargs
    ) -> DetailedResponse
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetApplication(getApplicationOptions *GetApplicationOptions) (result *ApplicationGetResponse, response *core.DetailedResponse, err error)
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetApplicationWithContext(ctx context.Context, getApplicationOptions *GetApplicationOptions) (result *ApplicationGetResponse, response *core.DetailedResponse, err error)
ServiceCall<ApplicationGetResponse> getApplication(GetApplicationOptions getApplicationOptions)

Request

Instantiate the GetApplicationOptions struct and set the fields to provide parameter values for the GetApplication method.

Use the GetApplicationOptions.Builder to create a GetApplicationOptions object that contains the parameter values for the getApplication method.

Custom Headers

  • Authorization
    Required*
    string

    Identity Access Management (IAM) bearer token.

Path Parameters

  • instance_id
    Required*
    string

    Identifier of the instance to which the application belongs.

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    Example: e64c907a-e82f-46fd-addc-ccfafbd28b09

  • application_id
    Required*
    string

    Identifier of the application for which details are requested.

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    Example: ff48cc19-0e7e-4627-aac6-0b4ad080397b

parameters

  • instanceId
    Required*
    string

    Identifier of the instance to which the application belongs.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html
  • applicationId
    Required*
    string

    Identifier of the application for which details are requested.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameters

  • instance_id
    Required*
    str

    Identifier of the instance to which the application belongs.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html
  • application_id
    Required*
    str

    Identifier of the application for which details are requested.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameter

WithContext method only

GetApplicationOptions

The GetApplication options.

GetApplicationOptions

The getApplication options.

  • curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/v3/analytics_engines/{instance_id}/spark_applications/{application_id}"
  • getApplicationOptions := ibmAnalyticsEngineApiService.NewGetApplicationOptions(
  "e64c907a-e82f-46fd-addc-ccfafbd28b09",
  "ff48cc19-0e7e-4627-aac6-0b4ad080397b",
)

applicationGetResponse, response, err := ibmAnalyticsEngineApiService.GetApplication(getApplicationOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(applicationGetResponse, "", "  ")
fmt.Println(string(b))
  • GetApplicationOptions getApplicationOptions = new GetApplicationOptions.Builder()
  .instanceId("e64c907a-e82f-46fd-addc-ccfafbd28b09")
  .applicationId("ff48cc19-0e7e-4627-aac6-0b4ad080397b")
  .build();

Response<ApplicationGetResponse> response = ibmAnalyticsEngineApiService.getApplication(getApplicationOptions).execute();
ApplicationGetResponse applicationGetResponse = response.getResult();

System.out.println(applicationGetResponse);
  • const params = {
  instanceId: 'e64c907a-e82f-46fd-addc-ccfafbd28b09',
  applicationId: 'ff48cc19-0e7e-4627-aac6-0b4ad080397b',
};

let res;
try {
  res = await ibmAnalyticsEngineApiService.getApplication(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • response = ibm_analytics_engine_api_service.get_application(
  instance_id='e64c907a-e82f-46fd-addc-ccfafbd28b09',
  application_id='ff48cc19-0e7e-4627-aac6-0b4ad080397b',
)
application_get_response = response.get_result()

print(json.dumps(application_get_response, indent=2))

Response

Response Body

ApplicationGetResponse

Response of the Application Get API

ApplicationGetResponse

Response of the Application Get API.

ApplicationGetResponse

Response of the Application Get API.

ApplicationGetResponse

Response of the Application Get API.

ApplicationGetResponse

Response of the Application Get API.

Status Code

  • 200

    OK

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Resource Not Found

  • 500

    Internal Server Error

Example responses
  • {
  "application_details": {
    "application": "/opt/ibm/spark/examples/src/main/python/wordcount.py",
    "arguments": [
      "/opt/ibm/spark/examples/src/main/resources/people.txt"
    ]
  },
  "id": "a9a6f328-56d8-4923-8042-97652fff2af3",
  "spark_application_id": "app-20210908112356-0000",
  "spark_application_name": "PythonWordCount",
  "state": "finished",
  "submission_time": "2021-04-21T04:23:55Z",
  "start_time": "2021-04-21T04:24:01Z",
  "end_time": "2021-04-21T04:28:15Z",
  "finish_time": "2021-04-21T04:28:15Z",
  "auto_termination_time": "2021-04-24T04:24:01Z"
}
  • {
  "application_details": {
    "application": "/opt/ibm/spark/examples/src/main/python/wordcount.py",
    "arguments": [
      "/opt/ibm/spark/examples/src/main/resources/people.txt"
    ]
  },
  "id": "a9a6f328-56d8-4923-8042-97652fff2af3",
  "spark_application_id": "app-20210908112356-0000",
  "spark_application_name": "PythonWordCount",
  "state": "finished",
  "submission_time": "2021-04-21T04:23:55Z",
  "start_time": "2021-04-21T04:24:01Z",
  "end_time": "2021-04-21T04:28:15Z",
  "finish_time": "2021-04-21T04:28:15Z",
  "auto_termination_time": "2021-04-24T04:24:01Z"
}

Stop application

Stops a running application identified by the app_id identifier. This is an idempotent operation. Performs no action if the requested application is already stopped or completed.

Stops a running application identified by the app_id identifier. This is an idempotent operation. Performs no action if the requested application is already stopped or completed.

Stops a running application identified by the app_id identifier. This is an idempotent operation. Performs no action if the requested application is already stopped or completed.

Stops a running application identified by the app_id identifier. This is an idempotent operation. Performs no action if the requested application is already stopped or completed.

Stops a running application identified by the app_id identifier. This is an idempotent operation. Performs no action if the requested application is already stopped or completed.

DELETE /v3/analytics_engines/{instance_id}/spark_applications/{application_id}
deleteApplication(params)
delete_application(self,
        instance_id: str,
        application_id: str,
        **kwargs
    ) -> DetailedResponse
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) DeleteApplication(deleteApplicationOptions *DeleteApplicationOptions) (response *core.DetailedResponse, err error)
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) DeleteApplicationWithContext(ctx context.Context, deleteApplicationOptions *DeleteApplicationOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> deleteApplication(DeleteApplicationOptions deleteApplicationOptions)

Request

Instantiate the DeleteApplicationOptions struct and set the fields to provide parameter values for the DeleteApplication method.

Use the DeleteApplicationOptions.Builder to create a DeleteApplicationOptions object that contains the parameter values for the deleteApplication method.

Custom Headers

  • Authorization
    Required*
    string

    Identity Access Management (IAM) bearer token.

Path Parameters

  • instance_id
    Required*
    string

    Identifier of the instance to which the application belongs.

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    Example: e64c907a-e82f-46fd-addc-ccfafbd28b09

  • application_id
    Required*
    string

    Identifier of the application that needs to be stopped.

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    Example: ff48cc19-0e7e-4627-aac6-0b4ad080397b

parameters

  • instanceId
    Required*
    string

    Identifier of the instance to which the application belongs.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html
  • applicationId
    Required*
    string

    Identifier of the application that needs to be stopped.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameters

  • instance_id
    Required*
    str

    Identifier of the instance to which the application belongs.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html
  • application_id
    Required*
    str

    Identifier of the application that needs to be stopped.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameter

WithContext method only

DeleteApplicationOptions

The DeleteApplication options.

DeleteApplicationOptions

The deleteApplication options.

  • curl -X DELETE --location --header "Authorization: Bearer {iam_token}"   "{base_url}/v3/analytics_engines/{instance_id}/spark_applications/{application_id}"
  • deleteApplicationOptions := ibmAnalyticsEngineApiService.NewDeleteApplicationOptions(
  "e64c907a-e82f-46fd-addc-ccfafbd28b09",
  "ff48cc19-0e7e-4627-aac6-0b4ad080397b",
)

response, err := ibmAnalyticsEngineApiService.DeleteApplication(deleteApplicationOptions)
if err != nil {
  panic(err)
}
if response.StatusCode != 204 {
  fmt.Printf("\nUnexpected response status code received from DeleteApplication(): %d\n", response.StatusCode)
}
  • DeleteApplicationOptions deleteApplicationOptions = new DeleteApplicationOptions.Builder()
  .instanceId("e64c907a-e82f-46fd-addc-ccfafbd28b09")
  .applicationId("ff48cc19-0e7e-4627-aac6-0b4ad080397b")
  .build();

Response<Void> response = ibmAnalyticsEngineApiService.deleteApplication(deleteApplicationOptions).execute();
  • const params = {
  instanceId: 'e64c907a-e82f-46fd-addc-ccfafbd28b09',
  applicationId: 'ff48cc19-0e7e-4627-aac6-0b4ad080397b',
};

try {
  await ibmAnalyticsEngineApiService.deleteApplication(params);
} catch (err) {
  console.warn(err);
}
  • response = ibm_analytics_engine_api_service.delete_application(
  instance_id='e64c907a-e82f-46fd-addc-ccfafbd28b09',
  application_id='ff48cc19-0e7e-4627-aac6-0b4ad080397b',
)

Response

Status Code

  • 204

    No Content

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Resource Not Found

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.

Get the status of the application

Returns the status of the given Spark application.

Returns the status of the given Spark application.

Returns the status of the given Spark application.

Returns the status of the given Spark application.

Returns the status of the given Spark application.

GET /v3/analytics_engines/{instance_id}/spark_applications/{application_id}/state
getApplicationState(params)
get_application_state(self,
        instance_id: str,
        application_id: str,
        **kwargs
    ) -> DetailedResponse
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetApplicationState(getApplicationStateOptions *GetApplicationStateOptions) (result *ApplicationGetStateResponse, response *core.DetailedResponse, err error)
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetApplicationStateWithContext(ctx context.Context, getApplicationStateOptions *GetApplicationStateOptions) (result *ApplicationGetStateResponse, response *core.DetailedResponse, err error)
ServiceCall<ApplicationGetStateResponse> getApplicationState(GetApplicationStateOptions getApplicationStateOptions)

Request

Instantiate the GetApplicationStateOptions struct and set the fields to provide parameter values for the GetApplicationState method.

Use the GetApplicationStateOptions.Builder to create a GetApplicationStateOptions object that contains the parameter values for the getApplicationState method.

Custom Headers

  • Authorization
    Required*
    string

    Identity Access Management (IAM) bearer token.

Path Parameters

  • instance_id
    Required*
    string

    Identifier of the instance to which the applications belongs.

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    Example: e64c907a-e82f-46fd-addc-ccfafbd28b09

  • application_id
    Required*
    string

    Identifier of the application for which details are requested.

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    Example: ff48cc19-0e7e-4627-aac6-0b4ad080397b

parameters

  • instanceId
    Required*
    string

    Identifier of the instance to which the applications belongs.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html
  • applicationId
    Required*
    string

    Identifier of the application for which details are requested.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameters

  • instance_id
    Required*
    str

    Identifier of the instance to which the applications belongs.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html
  • application_id
    Required*
    str

    Identifier of the application for which details are requested.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameter

WithContext method only

GetApplicationStateOptions

The GetApplicationState options.

GetApplicationStateOptions

The getApplicationState options.

  • curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/v3/analytics_engines/{instance_id}/spark_applications/{application_id}/state"
  • getApplicationStateOptions := ibmAnalyticsEngineApiService.NewGetApplicationStateOptions(
  "e64c907a-e82f-46fd-addc-ccfafbd28b09",
  "ff48cc19-0e7e-4627-aac6-0b4ad080397b",
)

applicationGetStateResponse, response, err := ibmAnalyticsEngineApiService.GetApplicationState(getApplicationStateOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(applicationGetStateResponse, "", "  ")
fmt.Println(string(b))
  • GetApplicationStateOptions getApplicationStateOptions = new GetApplicationStateOptions.Builder()
  .instanceId("e64c907a-e82f-46fd-addc-ccfafbd28b09")
  .applicationId("ff48cc19-0e7e-4627-aac6-0b4ad080397b")
  .build();

Response<ApplicationGetStateResponse> response = ibmAnalyticsEngineApiService.getApplicationState(getApplicationStateOptions).execute();
ApplicationGetStateResponse applicationGetStateResponse = response.getResult();

System.out.println(applicationGetStateResponse);
  • const params = {
  instanceId: 'e64c907a-e82f-46fd-addc-ccfafbd28b09',
  applicationId: 'ff48cc19-0e7e-4627-aac6-0b4ad080397b',
};

let res;
try {
  res = await ibmAnalyticsEngineApiService.getApplicationState(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • response = ibm_analytics_engine_api_service.get_application_state(
  instance_id='e64c907a-e82f-46fd-addc-ccfafbd28b09',
  application_id='ff48cc19-0e7e-4627-aac6-0b4ad080397b',
)
application_get_state_response = response.get_result()

print(json.dumps(application_get_state_response, indent=2))

Response

Response Body

ApplicationGetStateResponse

State of a given application.

ApplicationGetStateResponse

State of a given application.

ApplicationGetStateResponse

State of a given application.

ApplicationGetStateResponse

State of a given application.

ApplicationGetStateResponse

State of a given application.

Status Code

  • 200

    OK

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Resource Not Found

  • 500

    Internal Server Error

Example responses
  • {
  "id": "9da32aaf-df69-4e61-bdb8-1b2772c0f677",
  "state": "finished",
  "start_time": "2021-04-21T04:24:01Z",
  "end_time": "2021-04-21T04:28:15Z",
  "finish_time": "2021-04-21T04:28:15Z",
  "auto_termination_time": "2021-04-24T04:24:01Z"
}
  • {
  "id": "9da32aaf-df69-4e61-bdb8-1b2772c0f677",
  "state": "finished",
  "start_time": "2021-04-21T04:24:01Z",
  "end_time": "2021-04-21T04:28:15Z",
  "finish_time": "2021-04-21T04:28:15Z",
  "auto_termination_time": "2021-04-24T04:24:01Z"
}

Get current resource consumption

Gives the total memory and virtual processor cores allotted to all the applications running in the service instance at this point in time. When auto-scaled applications are running, the resources allotted will change over time, based on the applications's demands. Note: The consumption is not an indication of actual resource consumption by Spark processes. It is the sum of resources allocated to the currently running applications at the time of application submission.

Gives the total memory and virtual processor cores allotted to all the applications running in the service instance at this point in time. When auto-scaled applications are running, the resources allotted will change over time, based on the applications's demands. Note: The consumption is not an indication of actual resource consumption by Spark processes. It is the sum of resources allocated to the currently running applications at the time of application submission.

Gives the total memory and virtual processor cores allotted to all the applications running in the service instance at this point in time. When auto-scaled applications are running, the resources allotted will change over time, based on the applications's demands. Note: The consumption is not an indication of actual resource consumption by Spark processes. It is the sum of resources allocated to the currently running applications at the time of application submission.

Gives the total memory and virtual processor cores allotted to all the applications running in the service instance at this point in time. When auto-scaled applications are running, the resources allotted will change over time, based on the applications's demands. Note: The consumption is not an indication of actual resource consumption by Spark processes. It is the sum of resources allocated to the currently running applications at the time of application submission.

Gives the total memory and virtual processor cores allotted to all the applications running in the service instance at this point in time. When auto-scaled applications are running, the resources allotted will change over time, based on the applications's demands. Note: The consumption is not an indication of actual resource consumption by Spark processes. It is the sum of resources allocated to the currently running applications at the time of application submission.

GET /v3/analytics_engines/{instance_id}/current_resource_consumption
getCurrentResourceConsumption(params)
get_current_resource_consumption(self,
        instance_id: str,
        **kwargs
    ) -> DetailedResponse
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetCurrentResourceConsumption(getCurrentResourceConsumptionOptions *GetCurrentResourceConsumptionOptions) (result *CurrentResourceConsumptionResponse, response *core.DetailedResponse, err error)
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetCurrentResourceConsumptionWithContext(ctx context.Context, getCurrentResourceConsumptionOptions *GetCurrentResourceConsumptionOptions) (result *CurrentResourceConsumptionResponse, response *core.DetailedResponse, err error)
ServiceCall<CurrentResourceConsumptionResponse> getCurrentResourceConsumption(GetCurrentResourceConsumptionOptions getCurrentResourceConsumptionOptions)

Request

Instantiate the GetCurrentResourceConsumptionOptions struct and set the fields to provide parameter values for the GetCurrentResourceConsumption method.

Use the GetCurrentResourceConsumptionOptions.Builder to create a GetCurrentResourceConsumptionOptions object that contains the parameter values for the getCurrentResourceConsumption method.

Custom Headers

  • Authorization
    Required*
    string

    Identity Access Management (IAM) bearer token.

Path Parameters

  • instance_id
    Required*
    string

    ID of the Analytics Engine instance.

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    Example: e64c907a-e82f-46fd-addc-ccfafbd28b09

parameters

  • instanceId
    Required*
    string

    ID of the Analytics Engine instance.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameters

  • instance_id
    Required*
    str

    ID of the Analytics Engine instance.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameter

WithContext method only

GetCurrentResourceConsumptionOptions

The GetCurrentResourceConsumption options.

GetCurrentResourceConsumptionOptions

The getCurrentResourceConsumption options.

  • curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/v3/analytics_engines/{instance_id}/current_resource_consumption"
  • getCurrentResourceConsumptionOptions := ibmAnalyticsEngineApiService.NewGetCurrentResourceConsumptionOptions(
  "e64c907a-e82f-46fd-addc-ccfafbd28b09",
)

currentResourceConsumptionResponse, response, err := ibmAnalyticsEngineApiService.GetCurrentResourceConsumption(getCurrentResourceConsumptionOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(currentResourceConsumptionResponse, "", "  ")
fmt.Println(string(b))
  • GetCurrentResourceConsumptionOptions getCurrentResourceConsumptionOptions = new GetCurrentResourceConsumptionOptions.Builder()
  .instanceId("e64c907a-e82f-46fd-addc-ccfafbd28b09")
  .build();

Response<CurrentResourceConsumptionResponse> response = ibmAnalyticsEngineApiService.getCurrentResourceConsumption(getCurrentResourceConsumptionOptions).execute();
CurrentResourceConsumptionResponse currentResourceConsumptionResponse = response.getResult();

System.out.println(currentResourceConsumptionResponse);
  • const params = {
  instanceId: 'e64c907a-e82f-46fd-addc-ccfafbd28b09',
};

let res;
try {
  res = await ibmAnalyticsEngineApiService.getCurrentResourceConsumption(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • response = ibm_analytics_engine_api_service.get_current_resource_consumption(
  instance_id='e64c907a-e82f-46fd-addc-ccfafbd28b09',
)
current_resource_consumption_response = response.get_result()

print(json.dumps(current_resource_consumption_response, indent=2))

Response

Response Body

CurrentResourceConsumptionResponse

Current resource consumption of the instance.

CurrentResourceConsumptionResponse

Current resource consumption of the instance.

CurrentResourceConsumptionResponse

Current resource consumption of the instance.

CurrentResourceConsumptionResponse

Current resource consumption of the instance.

CurrentResourceConsumptionResponse

Current resource consumption of the instance.

Status Code

  • 200

    OK

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Resource Not Found

  • 500

    Internal Server Error

Example responses
  • {
  "cores": "2",
  "memory": "8G"
}
  • {
  "cores": "2",
  "memory": "8G"
}

Get resource consumption limits

Returns the maximum total memory and virtual processor cores that can be allotted across all the applications running in the service instance at any point in time.

Returns the maximum total memory and virtual processor cores that can be allotted across all the applications running in the service instance at any point in time.

Returns the maximum total memory and virtual processor cores that can be allotted across all the applications running in the service instance at any point in time.

Returns the maximum total memory and virtual processor cores that can be allotted across all the applications running in the service instance at any point in time.

Returns the maximum total memory and virtual processor cores that can be allotted across all the applications running in the service instance at any point in time.

GET /v3/analytics_engines/{instance_id}/resource_consumption_limits
getResourceConsumptionLimits(params)
get_resource_consumption_limits(self,
        instance_id: str,
        **kwargs
    ) -> DetailedResponse
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetResourceConsumptionLimits(getResourceConsumptionLimitsOptions *GetResourceConsumptionLimitsOptions) (result *ResourceConsumptionLimitsResponse, response *core.DetailedResponse, err error)
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetResourceConsumptionLimitsWithContext(ctx context.Context, getResourceConsumptionLimitsOptions *GetResourceConsumptionLimitsOptions) (result *ResourceConsumptionLimitsResponse, response *core.DetailedResponse, err error)
ServiceCall<ResourceConsumptionLimitsResponse> getResourceConsumptionLimits(GetResourceConsumptionLimitsOptions getResourceConsumptionLimitsOptions)

Request

Instantiate the GetResourceConsumptionLimitsOptions struct and set the fields to provide parameter values for the GetResourceConsumptionLimits method.

Use the GetResourceConsumptionLimitsOptions.Builder to create a GetResourceConsumptionLimitsOptions object that contains the parameter values for the getResourceConsumptionLimits method.

Custom Headers

  • Authorization
    Required*
    string

    Identity Access Management (IAM) bearer token.

Path Parameters

  • instance_id
    Required*
    string

    ID of the Analytics Engine instance.

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    Example: e64c907a-e82f-46fd-addc-ccfafbd28b09

parameters

  • instanceId
    Required*
    string

    ID of the Analytics Engine instance.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameters

  • instance_id
    Required*
    str

    ID of the Analytics Engine instance.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameter

WithContext method only

GetResourceConsumptionLimitsOptions

The GetResourceConsumptionLimits options.

GetResourceConsumptionLimitsOptions

The getResourceConsumptionLimits options.

  • curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/v3/analytics_engines/{instance_id}/resource_consumption_limits"
  • getResourceConsumptionLimitsOptions := ibmAnalyticsEngineApiService.NewGetResourceConsumptionLimitsOptions(
  "e64c907a-e82f-46fd-addc-ccfafbd28b09",
)

resourceConsumptionLimitsResponse, response, err := ibmAnalyticsEngineApiService.GetResourceConsumptionLimits(getResourceConsumptionLimitsOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(resourceConsumptionLimitsResponse, "", "  ")
fmt.Println(string(b))
  • GetResourceConsumptionLimitsOptions getResourceConsumptionLimitsOptions = new GetResourceConsumptionLimitsOptions.Builder()
  .instanceId("e64c907a-e82f-46fd-addc-ccfafbd28b09")
  .build();

Response<ResourceConsumptionLimitsResponse> response = ibmAnalyticsEngineApiService.getResourceConsumptionLimits(getResourceConsumptionLimitsOptions).execute();
ResourceConsumptionLimitsResponse resourceConsumptionLimitsResponse = response.getResult();

System.out.println(resourceConsumptionLimitsResponse);
  • const params = {
  instanceId: 'e64c907a-e82f-46fd-addc-ccfafbd28b09',
};

let res;
try {
  res = await ibmAnalyticsEngineApiService.getResourceConsumptionLimits(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • response = ibm_analytics_engine_api_service.get_resource_consumption_limits(
  instance_id='e64c907a-e82f-46fd-addc-ccfafbd28b09',
)
resource_consumption_limits_response = response.get_result()

print(json.dumps(resource_consumption_limits_response, indent=2))

Response

Response Body

ResourceConsumptionLimitsResponse

Resource consumption limits for the instance.

ResourceConsumptionLimitsResponse

Resource consumption limits for the instance.

ResourceConsumptionLimitsResponse

Resource consumption limits for the instance.

ResourceConsumptionLimitsResponse

Resource consumption limits for the instance.

ResourceConsumptionLimitsResponse

Resource consumption limits for the instance.

Status Code

  • 200

    OK

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Resource Not Found

  • 500

    Internal Server Error

Example responses
  • {
  "max_cores": "150",
  "max_memory": "600G"
}
  • {
  "max_cores": "150",
  "max_memory": "600G"
}

Replace log forwarding configuration

Modify the configuration for forwarding logs from the Analytics Engine instance to IBM Log Analysis server. Use this endpoint to enable or disable log forwarding.

Modify the configuration for forwarding logs from the Analytics Engine instance to IBM Log Analysis server. Use this endpoint to enable or disable log forwarding.

Modify the configuration for forwarding logs from the Analytics Engine instance to IBM Log Analysis server. Use this endpoint to enable or disable log forwarding.

Modify the configuration for forwarding logs from the Analytics Engine instance to IBM Log Analysis server. Use this endpoint to enable or disable log forwarding.

Modify the configuration for forwarding logs from the Analytics Engine instance to IBM Log Analysis server. Use this endpoint to enable or disable log forwarding.

PUT /v3/analytics_engines/{instance_id}/log_forwarding_config
replaceLogForwardingConfig(params)
replace_log_forwarding_config(self,
        instance_id: str,
        *,
        enabled: bool = None,
        sources: List[str] = None,
        tags: List[str] = None,
        **kwargs
    ) -> DetailedResponse
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) ReplaceLogForwardingConfig(replaceLogForwardingConfigOptions *ReplaceLogForwardingConfigOptions) (result *LogForwardingConfigResponse, response *core.DetailedResponse, err error)
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) ReplaceLogForwardingConfigWithContext(ctx context.Context, replaceLogForwardingConfigOptions *ReplaceLogForwardingConfigOptions) (result *LogForwardingConfigResponse, response *core.DetailedResponse, err error)
ServiceCall<LogForwardingConfigResponse> replaceLogForwardingConfig(ReplaceLogForwardingConfigOptions replaceLogForwardingConfigOptions)

Request

Instantiate the ReplaceLogForwardingConfigOptions struct and set the fields to provide parameter values for the ReplaceLogForwardingConfig method.

Use the ReplaceLogForwardingConfigOptions.Builder to create a ReplaceLogForwardingConfigOptions object that contains the parameter values for the replaceLogForwardingConfig method.

Custom Headers

  • Authorization
    Required*
    string

    Identity Access Management (IAM) bearer token.

Path Parameters

  • instance_id
    Required*
    string

    ID of the Analytics Engine instance.

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    Example: e64c907a-e82f-46fd-addc-ccfafbd28b09

Request Body

Required*
LogForwardingConfigRequest

Request json with log forwarding configuration details.

parameters

  • instanceId
    Required*
    string

    ID of the Analytics Engine instance.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html
  • enabled
    boolean

    Enable or disable log forwarding.

    Examples:
    value
    _source
    _lines
    _html
  • sources
    string[]

    List of sources of logs that will be forwarded. By default, only 'spark-driver' logs are forwarded.

    Examples:
    value
    _source
    _lines
    _html
  • tags
    string[]

    List of tags to be applied to the logs being forwarded. They can be used to filter the logs in the IBM Log Analysis server.

    Examples:
    value
    _source
    _lines
    _html

parameters

  • instance_id
    Required*
    str

    ID of the Analytics Engine instance.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html
  • enabled
    bool

    Enable or disable log forwarding.

    Examples:
    value
    _source
    _lines
    _html
  • sources
    List[str]

    List of sources of logs that will be forwarded. By default, only 'spark-driver' logs are forwarded.

    Examples:
    value
    _source
    _lines
    _html
  • tags
    List[str]

    List of tags to be applied to the logs being forwarded. They can be used to filter the logs in the IBM Log Analysis server.

    Examples:
    value
    _source
    _lines
    _html

parameter

WithContext method only

ReplaceLogForwardingConfigOptions

The ReplaceLogForwardingConfig options.

ReplaceLogForwardingConfigOptions

The replaceLogForwardingConfig options.

  • curl -X PUT --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "enabled": true }'   "{base_url}/v3/analytics_engines/{instance_id}/log_forwarding_config"
  • curl -X PUT --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{
    "enabled": true,
    "sources": [
      "spark-driver",
      "spark-executor"
    ]
  }'
  "{base_url}/v3/analytics_engines/{instance_id}/log_forwarding_config"
  • replaceLogForwardingConfigOptions := ibmAnalyticsEngineApiService.NewReplaceLogForwardingConfigOptions(
  "e64c907a-e82f-46fd-addc-ccfafbd28b09",
)
replaceLogForwardingConfigOptions.SetEnabled(true)

logForwardingConfigResponse, response, err := ibmAnalyticsEngineApiService.ReplaceLogForwardingConfig(replaceLogForwardingConfigOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(logForwardingConfigResponse, "", "  ")
fmt.Println(string(b))
  • ReplaceLogForwardingConfigOptions replaceLogForwardingConfigOptions = new ReplaceLogForwardingConfigOptions.Builder()
  .instanceId("e64c907a-e82f-46fd-addc-ccfafbd28b09")
  .enabled(true)
  .build();

Response<LogForwardingConfigResponse> response = ibmAnalyticsEngineApiService.replaceLogForwardingConfig(replaceLogForwardingConfigOptions).execute();
LogForwardingConfigResponse logForwardingConfigResponse = response.getResult();

System.out.println(logForwardingConfigResponse);
  • const params = {
  instanceId: 'e64c907a-e82f-46fd-addc-ccfafbd28b09',
  enabled: true,
};

let res;
try {
  res = await ibmAnalyticsEngineApiService.replaceLogForwardingConfig(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • response = ibm_analytics_engine_api_service.replace_log_forwarding_config(
  instance_id='e64c907a-e82f-46fd-addc-ccfafbd28b09',
  enabled=True,
)
log_forwarding_config_response = response.get_result()

print(json.dumps(log_forwarding_config_response, indent=2))

Response

Response Body

LogForwardingConfigResponse

Log forwarding configuration details.

LogForwardingConfigResponse

Log forwarding configuration details.

LogForwardingConfigResponse

Log forwarding configuration details.

LogForwardingConfigResponse

Log forwarding configuration details.

LogForwardingConfigResponse

Log forwarding configuration details.

Status Code

  • 200

    Updated

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Resource Not Found

  • 500

    Internal Server Error

Example responses
  • {
  "sources": [
    "spark-driver",
    "spark-executor"
  ],
  "log_server": {
    "type": "ibm-log-analysis"
  },
  "enabled": true
}
  • {
  "sources": [
    "spark-driver",
    "spark-executor"
  ],
  "log_server": {
    "type": "ibm-log-analysis"
  },
  "enabled": true
}

Get log forwarding configuration

Retrieve the log forwarding configuration of the Analytics Engine instance.

Retrieve the log forwarding configuration of the Analytics Engine instance.

Retrieve the log forwarding configuration of the Analytics Engine instance.

Retrieve the log forwarding configuration of the Analytics Engine instance.

Retrieve the log forwarding configuration of the Analytics Engine instance.

GET /v3/analytics_engines/{instance_id}/log_forwarding_config
getLogForwardingConfig(params)
get_log_forwarding_config(self,
        instance_id: str,
        **kwargs
    ) -> DetailedResponse
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetLogForwardingConfig(getLogForwardingConfigOptions *GetLogForwardingConfigOptions) (result *LogForwardingConfigResponse, response *core.DetailedResponse, err error)
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetLogForwardingConfigWithContext(ctx context.Context, getLogForwardingConfigOptions *GetLogForwardingConfigOptions) (result *LogForwardingConfigResponse, response *core.DetailedResponse, err error)
ServiceCall<LogForwardingConfigResponse> getLogForwardingConfig(GetLogForwardingConfigOptions getLogForwardingConfigOptions)

Request

Instantiate the GetLogForwardingConfigOptions struct and set the fields to provide parameter values for the GetLogForwardingConfig method.

Use the GetLogForwardingConfigOptions.Builder to create a GetLogForwardingConfigOptions object that contains the parameter values for the getLogForwardingConfig method.

Custom Headers

  • Authorization
    Required*
    string

    Identity Access Management (IAM) bearer token.

Path Parameters

  • instance_id
    Required*
    string

    ID of the Analytics Engine instance.

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    Example: e64c907a-e82f-46fd-addc-ccfafbd28b09

parameters

  • instanceId
    Required*
    string

    ID of the Analytics Engine instance.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameters

  • instance_id
    Required*
    str

    ID of the Analytics Engine instance.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameter

WithContext method only

GetLogForwardingConfigOptions

The GetLogForwardingConfig options.

GetLogForwardingConfigOptions

The getLogForwardingConfig options.

  • curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/v3/analytics_engines/{instance_id}/log_forwarding_config"
  • getLogForwardingConfigOptions := ibmAnalyticsEngineApiService.NewGetLogForwardingConfigOptions(
  "e64c907a-e82f-46fd-addc-ccfafbd28b09",
)

logForwardingConfigResponse, response, err := ibmAnalyticsEngineApiService.GetLogForwardingConfig(getLogForwardingConfigOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(logForwardingConfigResponse, "", "  ")
fmt.Println(string(b))
  • GetLogForwardingConfigOptions getLogForwardingConfigOptions = new GetLogForwardingConfigOptions.Builder()
  .instanceId("e64c907a-e82f-46fd-addc-ccfafbd28b09")
  .build();

Response<LogForwardingConfigResponse> response = ibmAnalyticsEngineApiService.getLogForwardingConfig(getLogForwardingConfigOptions).execute();
LogForwardingConfigResponse logForwardingConfigResponse = response.getResult();

System.out.println(logForwardingConfigResponse);
  • const params = {
  instanceId: 'e64c907a-e82f-46fd-addc-ccfafbd28b09',
};

let res;
try {
  res = await ibmAnalyticsEngineApiService.getLogForwardingConfig(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • response = ibm_analytics_engine_api_service.get_log_forwarding_config(
  instance_id='e64c907a-e82f-46fd-addc-ccfafbd28b09',
)
log_forwarding_config_response = response.get_result()

print(json.dumps(log_forwarding_config_response, indent=2))

Response

Response Body

LogForwardingConfigResponse

Log forwarding configuration details.

LogForwardingConfigResponse

Log forwarding configuration details.

LogForwardingConfigResponse

Log forwarding configuration details.

LogForwardingConfigResponse

Log forwarding configuration details.

LogForwardingConfigResponse

Log forwarding configuration details.

Status Code

  • 200

    OK

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Resource Not Found

  • 500

    Internal Server Error

Example responses
  • {
  "sources": [
    "spark-driver",
    "spark-executor"
  ],
  "log_server": {
    "type": "ibm-log-analysis"
  },
  "enabled": true
}
  • {
  "sources": [
    "spark-driver",
    "spark-executor"
  ],
  "log_server": {
    "type": "ibm-log-analysis"
  },
  "enabled": true
}

Enable or disable log forwarding

Enable or disable log forwarding from IBM Analytics Engine to IBM Log Analysis server.
Note: Deprecated. Use the log forwarding config api instead.

Enable or disable log forwarding from IBM Analytics Engine to IBM Log Analysis server.
Note: Deprecated. Use the log forwarding config api instead.

Enable or disable log forwarding from IBM Analytics Engine to IBM Log Analysis server.
Note: Deprecated. Use the log forwarding config api instead.

Enable or disable log forwarding from IBM Analytics Engine to IBM Log Analysis server.
Note: Deprecated. Use the log forwarding config api instead.

Enable or disable log forwarding from IBM Analytics Engine to IBM Log Analysis server.
Note: Deprecated. Use the log forwarding config api instead.

PUT /v3/analytics_engines/{instance_guid}/logging
configurePlatformLogging(params)
configure_platform_logging(self,
        instance_guid: str,
        *,
        enable: bool = None,
        **kwargs
    ) -> DetailedResponse
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) ConfigurePlatformLogging(configurePlatformLoggingOptions *ConfigurePlatformLoggingOptions) (result *LoggingConfigurationResponse, response *core.DetailedResponse, err error)
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) ConfigurePlatformLoggingWithContext(ctx context.Context, configurePlatformLoggingOptions *ConfigurePlatformLoggingOptions) (result *LoggingConfigurationResponse, response *core.DetailedResponse, err error)
ServiceCall<LoggingConfigurationResponse> configurePlatformLogging(ConfigurePlatformLoggingOptions configurePlatformLoggingOptions)

Request

Instantiate the ConfigurePlatformLoggingOptions struct and set the fields to provide parameter values for the ConfigurePlatformLogging method.

Use the ConfigurePlatformLoggingOptions.Builder to create a ConfigurePlatformLoggingOptions object that contains the parameter values for the configurePlatformLogging method.

Custom Headers

  • Authorization
    Required*
    string

    Identity Access Management (IAM) bearer token.

Path Parameters

  • instance_guid
    Required*
    string

    GUID of the instance details for which log forwarding is to be configured.

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    Example: e64c907a-e82f-46fd-addc-ccfafbd28b09

Request Body

Required*
LoggingConfigurationRequest

Request json with logging parameter details.

parameters

  • instanceGuid
    Required*
    string

    GUID of the instance details for which log forwarding is to be configured.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html
  • enable
    boolean

    Enable or disable log forwarding.

    Examples:
    value
    _source
    _lines
    _html

parameters

  • instance_guid
    Required*
    str

    GUID of the instance details for which log forwarding is to be configured.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html
  • enable
    bool

    Enable or disable log forwarding.

    Examples:
    value
    _source
    _lines
    _html

parameter

WithContext method only

ConfigurePlatformLoggingOptions

The ConfigurePlatformLogging options.

ConfigurePlatformLoggingOptions

The configurePlatformLogging options.

  • curl -X PUT --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   --header "Content-Type: application/json"   --data '{ "enable": true }'   "{base_url}/v3/analytics_engines/{instance_guid}/logging"
  • configurePlatformLoggingOptions := ibmAnalyticsEngineApiService.NewConfigurePlatformLoggingOptions(
  "e64c907a-e82f-46fd-addc-ccfafbd28b09",
)

loggingConfigurationResponse, response, err := ibmAnalyticsEngineApiService.ConfigurePlatformLogging(configurePlatformLoggingOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(loggingConfigurationResponse, "", "  ")
fmt.Println(string(b))
  • ConfigurePlatformLoggingOptions configurePlatformLoggingOptions = new ConfigurePlatformLoggingOptions.Builder()
  .instanceGuid("e64c907a-e82f-46fd-addc-ccfafbd28b09")
  .enable(true)
  .build();

Response<LoggingConfigurationResponse> response = ibmAnalyticsEngineApiService.configurePlatformLogging(configurePlatformLoggingOptions).execute();
LoggingConfigurationResponse loggingConfigurationResponse = response.getResult();

System.out.println(loggingConfigurationResponse);
  • const params = {
  instanceGuid: 'e64c907a-e82f-46fd-addc-ccfafbd28b09',
  enable: true,
};

let res;
try {
  res = await ibmAnalyticsEngineApiService.configurePlatformLogging(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • response = ibm_analytics_engine_api_service.configure_platform_logging(
  instance_guid='e64c907a-e82f-46fd-addc-ccfafbd28b09',
)
logging_configuration_response = response.get_result()

print(json.dumps(logging_configuration_response, indent=2))

Response

Response Body

LoggingConfigurationResponse

(deprecated) Response of logging API.

LoggingConfigurationResponse

(deprecated) Response of logging API.

LoggingConfigurationResponse

(deprecated) Response of logging API.

LoggingConfigurationResponse

(deprecated) Response of logging API.

LoggingConfigurationResponse

(deprecated) Response of logging API.

Status Code

  • 201

    Created

  • 400

    Bad Request

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Resource Not Found

  • 500

    Internal Server Error

Example responses
  • {
  "components": [
    "spark-driver",
    "spark-executor"
  ],
  "log_server": {
    "type": "ibm-log-analysis"
  },
  "enable": true
}
  • {
  "components": [
    "spark-driver",
    "spark-executor"
  ],
  "log_server": {
    "type": "ibm-log-analysis"
  },
  "enable": true
}

Retrieve the logging configuration for a given instance id

Retrieve the logging configuration of a given Analytics Engine instance.
Note: Deprecated. Use the log forwarding config api instead.

Retrieve the logging configuration of a given Analytics Engine instance.
Note: Deprecated. Use the log forwarding config api instead.

Retrieve the logging configuration of a given Analytics Engine instance.
Note: Deprecated. Use the log forwarding config api instead.

Retrieve the logging configuration of a given Analytics Engine instance.
Note: Deprecated. Use the log forwarding config api instead.

Retrieve the logging configuration of a given Analytics Engine instance.
Note: Deprecated. Use the log forwarding config api instead.

GET /v3/analytics_engines/{instance_guid}/logging
getLoggingConfiguration(params)
get_logging_configuration(self,
        instance_guid: str,
        **kwargs
    ) -> DetailedResponse
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetLoggingConfiguration(getLoggingConfigurationOptions *GetLoggingConfigurationOptions) (result *LoggingConfigurationResponse, response *core.DetailedResponse, err error)
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetLoggingConfigurationWithContext(ctx context.Context, getLoggingConfigurationOptions *GetLoggingConfigurationOptions) (result *LoggingConfigurationResponse, response *core.DetailedResponse, err error)
ServiceCall<LoggingConfigurationResponse> getLoggingConfiguration(GetLoggingConfigurationOptions getLoggingConfigurationOptions)

Request

Instantiate the GetLoggingConfigurationOptions struct and set the fields to provide parameter values for the GetLoggingConfiguration method.

Use the GetLoggingConfigurationOptions.Builder to create a GetLoggingConfigurationOptions object that contains the parameter values for the getLoggingConfiguration method.

Custom Headers

  • Authorization
    Required*
    string

    Identity Access Management (IAM) bearer token.

Path Parameters

  • instance_guid
    Required*
    string

    GUID of the Analytics Engine service instance to retrieve log configuration.

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    Example: e64c907a-e82f-46fd-addc-ccfafbd28b09

parameters

  • instanceGuid
    Required*
    string

    GUID of the Analytics Engine service instance to retrieve log configuration.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameters

  • instance_guid
    Required*
    str

    GUID of the Analytics Engine service instance to retrieve log configuration.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameter

WithContext method only

GetLoggingConfigurationOptions

The GetLoggingConfiguration options.

GetLoggingConfigurationOptions

The getLoggingConfiguration options.

  • curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/v3/analytics_engines/{instance_guid}/logging"
  • getLoggingConfigurationOptions := ibmAnalyticsEngineApiService.NewGetLoggingConfigurationOptions(
  "e64c907a-e82f-46fd-addc-ccfafbd28b09",
)

loggingConfigurationResponse, response, err := ibmAnalyticsEngineApiService.GetLoggingConfiguration(getLoggingConfigurationOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(loggingConfigurationResponse, "", "  ")
fmt.Println(string(b))
  • GetLoggingConfigurationOptions getLoggingConfigurationOptions = new GetLoggingConfigurationOptions.Builder()
  .instanceGuid("e64c907a-e82f-46fd-addc-ccfafbd28b09")
  .build();

Response<LoggingConfigurationResponse> response = ibmAnalyticsEngineApiService.getLoggingConfiguration(getLoggingConfigurationOptions).execute();
LoggingConfigurationResponse loggingConfigurationResponse = response.getResult();

System.out.println(loggingConfigurationResponse);
  • const params = {
  instanceGuid: 'e64c907a-e82f-46fd-addc-ccfafbd28b09',
};

let res;
try {
  res = await ibmAnalyticsEngineApiService.getLoggingConfiguration(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • response = ibm_analytics_engine_api_service.get_logging_configuration(
  instance_guid='e64c907a-e82f-46fd-addc-ccfafbd28b09',
)
logging_configuration_response = response.get_result()

print(json.dumps(logging_configuration_response, indent=2))

Response

Response Body

LoggingConfigurationResponse

(deprecated) Response of logging API.

LoggingConfigurationResponse

(deprecated) Response of logging API.

LoggingConfigurationResponse

(deprecated) Response of logging API.

LoggingConfigurationResponse

(deprecated) Response of logging API.

LoggingConfigurationResponse

(deprecated) Response of logging API.

Status Code

  • 200

    OK

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Resource Not Found

  • 500

    Internal Server Error

Example responses
  • {
  "components": [
    "spark-driver",
    "spark-executor"
  ],
  "log_server": {
    "type": "ibm-log-analysis"
  },
  "enable": true
}
  • {
  "components": [
    "spark-driver",
    "spark-executor"
  ],
  "log_server": {
    "type": "ibm-log-analysis"
  },
  "enable": true
}

Start Spark history server

Start the Spark history server for the given Analytics Engine instance.

Start the Spark history server for the given Analytics Engine instance.

Start the Spark history server for the given Analytics Engine instance.

Start the Spark history server for the given Analytics Engine instance.

Start the Spark history server for the given Analytics Engine instance.

POST /v3/analytics_engines/{instance_id}/spark_history_server
startSparkHistoryServer(params)
start_spark_history_server(self,
        instance_id: str,
        **kwargs
    ) -> DetailedResponse
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) StartSparkHistoryServer(startSparkHistoryServerOptions *StartSparkHistoryServerOptions) (result *SparkHistoryServerResponse, response *core.DetailedResponse, err error)
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) StartSparkHistoryServerWithContext(ctx context.Context, startSparkHistoryServerOptions *StartSparkHistoryServerOptions) (result *SparkHistoryServerResponse, response *core.DetailedResponse, err error)
ServiceCall<SparkHistoryServerResponse> startSparkHistoryServer(StartSparkHistoryServerOptions startSparkHistoryServerOptions)

Request

Instantiate the StartSparkHistoryServerOptions struct and set the fields to provide parameter values for the StartSparkHistoryServer method.

Use the StartSparkHistoryServerOptions.Builder to create a StartSparkHistoryServerOptions object that contains the parameter values for the startSparkHistoryServer method.

Custom Headers

  • Authorization
    Required*
    string

    Identity Access Management (IAM) bearer token.

Path Parameters

  • instance_id
    Required*
    string

    The ID of the Analytics Engine instance to which the Spark history server belongs.

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    Example: e64c907a-e82f-46fd-addc-ccfafbd28b09

parameters

  • instanceId
    Required*
    string

    The ID of the Analytics Engine instance to which the Spark history server belongs.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameters

  • instance_id
    Required*
    str

    The ID of the Analytics Engine instance to which the Spark history server belongs.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameter

WithContext method only

StartSparkHistoryServerOptions

The StartSparkHistoryServer options.

StartSparkHistoryServerOptions

The startSparkHistoryServer options.

  • curl -X POST --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/v3/analytics_engines/{instance_id}/spark_history_server"
  • startSparkHistoryServerOptions := ibmAnalyticsEngineApiService.NewStartSparkHistoryServerOptions(
  "e64c907a-e82f-46fd-addc-ccfafbd28b09",
)

sparkHistoryServerResponse, response, err := ibmAnalyticsEngineApiService.StartSparkHistoryServer(startSparkHistoryServerOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(sparkHistoryServerResponse, "", "  ")
fmt.Println(string(b))
  • StartSparkHistoryServerOptions startSparkHistoryServerOptions = new StartSparkHistoryServerOptions.Builder()
  .instanceId("e64c907a-e82f-46fd-addc-ccfafbd28b09")
  .build();

Response<SparkHistoryServerResponse> response = ibmAnalyticsEngineApiService.startSparkHistoryServer(startSparkHistoryServerOptions).execute();
SparkHistoryServerResponse sparkHistoryServerResponse = response.getResult();

System.out.println(sparkHistoryServerResponse);
  • const params = {
  instanceId: 'e64c907a-e82f-46fd-addc-ccfafbd28b09',
};

let res;
try {
  res = await ibmAnalyticsEngineApiService.startSparkHistoryServer(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • response = ibm_analytics_engine_api_service.start_spark_history_server(
  instance_id='e64c907a-e82f-46fd-addc-ccfafbd28b09',
)
spark_history_server_response = response.get_result()

print(json.dumps(spark_history_server_response, indent=2))

Response

Response Body

SparkHistoryServerResponse

Status of the Spark history server

SparkHistoryServerResponse

Status of the Spark history server.

SparkHistoryServerResponse

Status of the Spark history server.

SparkHistoryServerResponse

Status of the Spark history server.

SparkHistoryServerResponse

Status of the Spark history server.

Status Code

  • 202

    Accepted

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Resource Not Found

  • 500

    Internal Server Error

Example responses
  • {
  "state": "started",
  "cores": "1",
  "memory": "4G",
  "start_time": "2022-02-21T07:37:47Z",
  "auto_termination_time": "2022-02-24T07:37:47Z"
}
  • {
  "state": "started",
  "cores": "1",
  "memory": "4G",
  "start_time": "2022-02-21T07:37:47Z",
  "auto_termination_time": "2022-02-24T07:37:47Z"
}

Get Spark history server details

Get the details of the Spark history server of the given Analytics Engine instance.

Get the details of the Spark history server of the given Analytics Engine instance.

Get the details of the Spark history server of the given Analytics Engine instance.

Get the details of the Spark history server of the given Analytics Engine instance.

Get the details of the Spark history server of the given Analytics Engine instance.

GET /v3/analytics_engines/{instance_id}/spark_history_server
getSparkHistoryServer(params)
get_spark_history_server(self,
        instance_id: str,
        **kwargs
    ) -> DetailedResponse
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetSparkHistoryServer(getSparkHistoryServerOptions *GetSparkHistoryServerOptions) (result *SparkHistoryServerResponse, response *core.DetailedResponse, err error)
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) GetSparkHistoryServerWithContext(ctx context.Context, getSparkHistoryServerOptions *GetSparkHistoryServerOptions) (result *SparkHistoryServerResponse, response *core.DetailedResponse, err error)
ServiceCall<SparkHistoryServerResponse> getSparkHistoryServer(GetSparkHistoryServerOptions getSparkHistoryServerOptions)

Request

Instantiate the GetSparkHistoryServerOptions struct and set the fields to provide parameter values for the GetSparkHistoryServer method.

Use the GetSparkHistoryServerOptions.Builder to create a GetSparkHistoryServerOptions object that contains the parameter values for the getSparkHistoryServer method.

Custom Headers

  • Authorization
    Required*
    string

    Identity Access Management (IAM) bearer token.

Path Parameters

  • instance_id
    Required*
    string

    The ID of the Analytics Engine instance to which the Spark history server belongs.

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    Example: e64c907a-e82f-46fd-addc-ccfafbd28b09

parameters

  • instanceId
    Required*
    string

    The ID of the Analytics Engine instance to which the Spark history server belongs.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameters

  • instance_id
    Required*
    str

    The ID of the Analytics Engine instance to which the Spark history server belongs.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameter

WithContext method only

GetSparkHistoryServerOptions

The GetSparkHistoryServer options.

GetSparkHistoryServerOptions

The getSparkHistoryServer options.

  • curl -X GET --location --header "Authorization: Bearer {iam_token}"   --header "Accept: application/json"   "{base_url}/v3/analytics_engines/{instance_id}/spark_history_server"
  • getSparkHistoryServerOptions := ibmAnalyticsEngineApiService.NewGetSparkHistoryServerOptions(
  "e64c907a-e82f-46fd-addc-ccfafbd28b09",
)

sparkHistoryServerResponse, response, err := ibmAnalyticsEngineApiService.GetSparkHistoryServer(getSparkHistoryServerOptions)
if err != nil {
  panic(err)
}
b, _ := json.MarshalIndent(sparkHistoryServerResponse, "", "  ")
fmt.Println(string(b))
  • GetSparkHistoryServerOptions getSparkHistoryServerOptions = new GetSparkHistoryServerOptions.Builder()
  .instanceId("e64c907a-e82f-46fd-addc-ccfafbd28b09")
  .build();

Response<SparkHistoryServerResponse> response = ibmAnalyticsEngineApiService.getSparkHistoryServer(getSparkHistoryServerOptions).execute();
SparkHistoryServerResponse sparkHistoryServerResponse = response.getResult();

System.out.println(sparkHistoryServerResponse);
  • const params = {
  instanceId: 'e64c907a-e82f-46fd-addc-ccfafbd28b09',
};

let res;
try {
  res = await ibmAnalyticsEngineApiService.getSparkHistoryServer(params);
  console.log(JSON.stringify(res.result, null, 2));
} catch (err) {
  console.warn(err);
}
  • response = ibm_analytics_engine_api_service.get_spark_history_server(
  instance_id='e64c907a-e82f-46fd-addc-ccfafbd28b09',
)
spark_history_server_response = response.get_result()

print(json.dumps(spark_history_server_response, indent=2))

Response

Response Body

SparkHistoryServerResponse

Status of the Spark history server

SparkHistoryServerResponse

Status of the Spark history server.

SparkHistoryServerResponse

Status of the Spark history server.

SparkHistoryServerResponse

Status of the Spark history server.

SparkHistoryServerResponse

Status of the Spark history server.

Status Code

  • 200

    OK

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Resource Not Found

  • 500

    Internal Server Error

Example responses
  • {
  "state": "started",
  "cores": "1",
  "memory": "4G",
  "start_time": "2022-02-21T07:37:47Z",
  "auto_termination_time": "2022-02-24T07:37:47Z"
}
  • {
  "state": "started",
  "cores": "1",
  "memory": "4G",
  "start_time": "2022-02-21T07:37:47Z",
  "auto_termination_time": "2022-02-24T07:37:47Z"
}

Stop Spark history server

Stop the Spark history server of the given Analytics Engine instance.

Stop the Spark history server of the given Analytics Engine instance.

Stop the Spark history server of the given Analytics Engine instance.

Stop the Spark history server of the given Analytics Engine instance.

Stop the Spark history server of the given Analytics Engine instance.

DELETE /v3/analytics_engines/{instance_id}/spark_history_server
stopSparkHistoryServer(params)
stop_spark_history_server(self,
        instance_id: str,
        **kwargs
    ) -> DetailedResponse
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) StopSparkHistoryServer(stopSparkHistoryServerOptions *StopSparkHistoryServerOptions) (response *core.DetailedResponse, err error)
(ibmAnalyticsEngineApi *IbmAnalyticsEngineApiV3) StopSparkHistoryServerWithContext(ctx context.Context, stopSparkHistoryServerOptions *StopSparkHistoryServerOptions) (response *core.DetailedResponse, err error)
ServiceCall<Void> stopSparkHistoryServer(StopSparkHistoryServerOptions stopSparkHistoryServerOptions)

Request

Instantiate the StopSparkHistoryServerOptions struct and set the fields to provide parameter values for the StopSparkHistoryServer method.

Use the StopSparkHistoryServerOptions.Builder to create a StopSparkHistoryServerOptions object that contains the parameter values for the stopSparkHistoryServer method.

Custom Headers

  • Authorization
    Required*
    string

    Identity Access Management (IAM) bearer token.

Path Parameters

  • instance_id
    Required*
    string

    The ID of the Analytics Engine instance to which the Spark history server belongs.

    Possible values: Value must match regular expression [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

    Example: e64c907a-e82f-46fd-addc-ccfafbd28b09

parameters

  • instanceId
    Required*
    string

    The ID of the Analytics Engine instance to which the Spark history server belongs.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameters

  • instance_id
    Required*
    str

    The ID of the Analytics Engine instance to which the Spark history server belongs.

    Possible values: Value must match regular expression /[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}/

    Examples:
    value
    _source
    _lines
    _html

parameter

WithContext method only

StopSparkHistoryServerOptions

The StopSparkHistoryServer options.

StopSparkHistoryServerOptions

The stopSparkHistoryServer options.

  • curl -X DELETE --location --header "Authorization: Bearer {iam_token}"   "{base_url}/v3/analytics_engines/{instance_id}/spark_history_server"
  • stopSparkHistoryServerOptions := ibmAnalyticsEngineApiService.NewStopSparkHistoryServerOptions(
  "e64c907a-e82f-46fd-addc-ccfafbd28b09",
)

response, err := ibmAnalyticsEngineApiService.StopSparkHistoryServer(stopSparkHistoryServerOptions)
if err != nil {
  panic(err)
}
if response.StatusCode != 204 {
  fmt.Printf("\nUnexpected response status code received from StopSparkHistoryServer(): %d\n", response.StatusCode)
}
  • StopSparkHistoryServerOptions stopSparkHistoryServerOptions = new StopSparkHistoryServerOptions.Builder()
  .instanceId("e64c907a-e82f-46fd-addc-ccfafbd28b09")
  .build();

Response<Void> response = ibmAnalyticsEngineApiService.stopSparkHistoryServer(stopSparkHistoryServerOptions).execute();
  • const params = {
  instanceId: 'e64c907a-e82f-46fd-addc-ccfafbd28b09',
};

try {
  await ibmAnalyticsEngineApiService.stopSparkHistoryServer(params);
} catch (err) {
  console.warn(err);
}
  • response = ibm_analytics_engine_api_service.stop_spark_history_server(
  instance_id='e64c907a-e82f-46fd-addc-ccfafbd28b09',
)

Response

Status Code

  • 204

    No Content

  • 401

    Unauthorized

  • 403

    Forbidden

  • 404

    Resource Not Found

  • 500

    Internal Server Error

No Sample Response

This method does not specify any sample responses.