Streaming Analytics API v1

Live

Streaming Analytics API v1

+ Day(s) remaining in the trial

Overview

IBM Streaming Analytics for IBM Cloud is powered by IBM Streams, an advanced analytic platform that you can use to ingest, analyze, and correlate information as it arrives from different types of data sources in real time. When you create an instance of the Streaming Analytics service, you get your own instance of IBM Streams running in IBM Cloud, ready to run your IBM Streams applications.

Security

Keys

Pick a key to use with this API. Make sure you are logged in with your IBM id for your keys to be populated in the dropdown below. By selecting a key, it will be pre-filled for each endpoint in the Documentation section that can be used with the built-in testing. If you want to change which key to use for a particular endpoint, you can do so at the endpoint in the Documentation section.
You can manage your API keys in the <MyAPIs> section. API keys authenticate you to your subscription, so make sure to keep them secret. Do not share the X-IBM-Client-Secret portion of any API key in publicly accessible places such as GitHub, or client-side code.



Manage your keys
 

Global Parameters

This section contains global variables, which apply to all of the endpoint definitions of this API. You can use this section to set these variables once, and have the values pre-filled for every endpoint in the Documentation section. The values set can be used with the built-in testing. You can always override the value in the endpoint definition of the Documentation section.
Global variables

You must take this value from the service credentials, which can be accessed from the service dashboard.

Documentation

Streaming Analytics API v1:

instance

Learn how to monitor, start, stop the service instance. You can also manage resources allocated to the service instance.
Edit instance size
Sets the size, in number of dedicated application nodes, of your Streaming Analytics service instance. If the instance is running, you are only allowed to increase the size. If the instance is stopped, you can increase or decrease its size.

PUT   /jax-rs/streams/size/service_instances/{instanceId}/service_bindings/{bindingId}

			https://{rest_url}/jax-rs/streams/size/service_instances/{instanceId}/service_bindings/{bindingId}
		
Keys
Global variables

rest_url

BASEURL , required

You must take this value from the service credentials, which can be accessed from the service dashboard.

Path and Query parameters

bindingId

URL , required

The bind ID established on the service bind sequence. You can find the parameter value in the service credentials.

instanceId

URL , required

The service instance ID established on the service provision sequence. You can find the parameter value in the service credentials.

Request code
								
HttpResponse<String> response = Unirest.put("https://rest_url//jax-rs/streams/size/service_instances/{instanceId}/service_bindings/{bindingId}") .header("accept", "application/json") .header("content-type", "application/json") .asString();
Request model

object , optional

Request example
{
  "": object
}
Response model

200

Successful response

Body

enabled

BOOLEAN , optional

Determines whether the IBM Cloud service enabled property is set for the service instance.

maximum

INTEGER , optional

Indicates the maximum number of application nodes allowed in a service instance. This is a practical limit based upon the size of the environment, you can change it if you need larger instances.

minimum

INTEGER , optional

Indicates the minimum number of application nodes allowed in a service instance.

plan

STRING , optional

Determines the pricing plan you selected when creating the service instance.

size

INTEGER , optional

Defines the number of application nodes in the service instance.

state

STRING , optional

Indicates the state of the instance. Valid values are STARTING, STARTED, STOPPING, STOPPED.

status

STRING , optional

Indicates the status of the service instance. Valid values are failed, partially_failed, partially_running, running, starting, stopped, stopping, and unknown.

Response example

200

Successful response

								{
  "enabled" : boolean,
  "maximum" : integer,
  "minimum" : integer,
  "plan" : string,
  "size" : integer,
  "state" : string,
  "status" : string
}
							
List all instance resources
Retrieves information about the dedicated application nodes (IBM Streams resources) that are assigned to a service instance.

GET   /jax-rs/resources/service_instances/{instanceId}/service_bindings/{bindingId}

			https://{rest_url}/jax-rs/resources/service_instances/{instanceId}/service_bindings/{bindingId}
		
Keys
Global variables

rest_url

BASEURL , required

You must take this value from the service credentials, which can be accessed from the service dashboard.

Path and Query parameters

bindingId

URL , required

The bind ID established on the service bind sequence. You can find the parameter value in the service credentials.

instanceId

URL , required

The service instance ID established on the service provision sequence. You can find the parameter value in the service credentials.

Request code
								
HttpResponse<String> response = Unirest.get("https://rest_url//jax-rs/resources/service_instances/{instanceId}/service_bindings/{bindingId}") .header("accept", "application/json") .asString();
Response model

200

OK

Body

auto_stop

BOOLEAN , optional

A boolean that automatically stops the service instance when one of the following conditions occurs: The instance has no jobs running for an extended period, and the resource allocation for the instance is consumed.

available_versions [available_versions]

ARRAY , optional

An array that provides the following information for each resource:

domain_version [domain_version]

ARRAY , optional

An array that provides the following information for the domain:

enabled

BOOLEAN , optional

Determines whether the IBM Cloud service enabled property is set for the service instance.

instance_version [instance_version]

ARRAY , optional

An array that provides the following information for the instance.

job_count

INTEGER , optional

Specifies the number of Streaming Analytics application jobs currently active on the specified Streaming Analytics service instance.

maximum

INTEGER , optional

Specifies the maximum number of resources that you can assign to an active Streaming Analytics instance.

minimum

INTEGER , optional

Specifies the minimum number of resources that you can assign to an active Streaming Analytics instance.

plan

STRING , optional

Specifies the pricing plan you selected when creating the Streaming Analytics service instance.

resourceSpecifications [resourceSpecifications]

ARRAY , optional

A JSON array of specifications that you can use to assign resources to an active Streaming Analytics service instance. These specifications include the following information:

resources [resources]

ARRAY , optional

A JSON array of dedicated application nodes that are assigned to the specified Streaming Analytics service that includes the following information for each resource. The resources parameter is only returned on the service instance when the value of the state parameter is set to STARTED.

size

INTEGER , optional

Specifies the current number of dedicated application nodes assigned to your Streaming Analytics service instance.

state

STRING , optional

Specifies the IBM Cloud service state for the specified Streaming Analytics service instance. Values: STARTING, STARTED, STOPPING, or STOPPED.

status

STRING , optional

Specifies the status of the service instance. Values: failed, partially_failed, partially_running, running, starting, stopped, stopping, and unknown.

streams_console_url

STRING , optional

Identifies the URL that you can use to access the IBM Streams console.

streams_rest_url

STRING , optional

Identifies the URL that you can use to access the IBM Streams REST API.

buildVersion

STRING , optional

Identifies the IBM Streams product build that is installed.

fullProductVersion

STRING , optional

Identifies the IBM Streams full product version. If no hot fix is installed, this is the same as the productVersion. If a hot fix is installed, the hot fix is included as part of the full product version.

hotFix

STRING , optional

Identifies the hot fix that is installed. This property is returned only if a hot fix is installed.

productVersion

STRING , optional

Identifies the version of the product.

buildVersion

STRING , optional

Identifies the IBM Streams product build that is installed.

fullProductVersion

STRING , optional

Identifies the IBM Streams full product version. If no hot fix is installed, this is the same as the productVersion. If a hot fix is installed, the hot fix is included as part of the full product version.

hotFix

STRING , optional

Identifies the hot fix that is installed. This property is returned only if a hot fix is installed.

productVersion

STRING , optional

Identifies the version of the product.

buildVersion

STRING , optional

Identifies the IBM Streams product build that is installed.

fullProductVersion

STRING , optional

Identifies the IBM Streams full product version. If no hot fix is installed, this is the same as the productVersion. If a hot fix is installed, the hot fix is included as part of the full product version.

hotFix

STRING , optional

Identifies the hot fix that is installed. This property is returned only if a hot fix is installed.

productVersion

STRING , optional

Identifies the version of the product.

count

INTEGER , optional

Specifies the number of dedicated application nodes currently active on the specified Streaming Analytics service instance.

id

STRING , optional

The ID assigned to the dedicated application node.

tags

ARRAY , optional

A JSON array of tags that are assigned to the dedicated application node.

host-name

STRING , optional

Specifies the domain host name of the dedicated application node.

ip-address

STRING , optional

Specifies The accessible TCP/IP address of the dedicated application node.

tags

ARRAY , optional

A JSON array of tags that are assigned to the dedicated application node.

Response example

200

OK

								{
  "auto_stop" : boolean,
  "available_versions" : [{
    "buildVersion" : string,
    "fullProductVersion" : string,
    "hotFix" : string,
    "productVersion" : string
  }],
  "domain_version" : [{
    "buildVersion" : string,
    "fullProductVersion" : string,
    "hotFix" : string,
    "productVersion" : string
  }],
  "enabled" : boolean,
  "instance_version" : [{
    "buildVersion" : string,
    "fullProductVersion" : string,
    "hotFix" : string,
    "productVersion" : string
  }],
  "job_count" : integer,
  "maximum" : integer,
  "minimum" : integer,
  "plan" : string,
  "resourceSpecifications" : [{
    "count" : integer,
    "id" : string,
    "tags" : [string]
  }],
  "resources" : [{
    "host-name" : string,
    "ip-address" : string,
    "tags" : [string]
  }],
  "size" : integer,
  "state" : string,
  "status" : string,
  "streams_console_url" : string,
  "streams_rest_url" : string
}
							
Retrieve instance size
Retrieves the size, in number of dedicated application nodes (IBM Streams resources), of the service instance. By default, the service instance is configured with two dedicated application nodes.

GET   /jax-rs/streams/size/service_instances/{instanceId}/service_bindings/{bindingId}

			https://{rest_url}/jax-rs/streams/size/service_instances/{instanceId}/service_bindings/{bindingId}
		
Keys
Global variables

rest_url

BASEURL , required

You must take this value from the service credentials, which can be accessed from the service dashboard.

Path and Query parameters

bindingId

URL , required

The bind ID established on the service bind sequence. You can find the parameter value in the service credentials.

instanceId

URL , required

The service instance ID established on the service provision sequence. You can find the parameter value in the service credentials.

Request code
								
HttpResponse<String> response = Unirest.get("https://rest_url//jax-rs/streams/size/service_instances/{instanceId}/service_bindings/{bindingId}") .header("accept", "application/json") .asString();
Response model

200

OK

Body

enabled

BOOLEAN , optional

Determines whether the IBM Cloud service enabled property is set for the Streaming Analytics service instance.

maximum

INTEGER , optional

Indicates the maximum number of application nodes allowed in a Streams instance. This is a practical limit based upon the size of the environment, and it can be changed if larger instances are required.

minimum

INTEGER , optional

Indicates the minimum number of application nodes allowed in a Streams instance.

plan

STRING , optional

Determines the pricing plan you selected when creating the Streaming Analytics service instance.

size

INTEGER , optional

The number of application nodes in the Streams instance.

state

STRING , optional

State of the instance. Valid values are STARTING, STARTED, STOPPING, STOPPED.

status

STRING , optional

Status of the Streams instance. Valid values are failed, partially_failed, partially_running, running, starting, stopped, stopping, and unknown.

Response example

200

OK

								{
  "enabled" : boolean,
  "maximum" : integer,
  "minimum" : integer,
  "plan" : string,
  "size" : integer,
  "state" : string,
  "status" : string
}
							
Retrieve instance status
Retrieves the state and status information about a service instance.

GET   /jax-rs/streams/status/service_instances/{instanceId}/service_bindings/{bindingId}

			https://{rest_url}/jax-rs/streams/status/service_instances/{instanceId}/service_bindings/{bindingId}
		
Keys
Global variables

rest_url

BASEURL , required

You must take this value from the service credentials, which can be accessed from the service dashboard.

Path and Query parameters

bindingId

URL , required

The bind ID established on the service Bind sequence.

instanceId

URL , required

The service instance ID established on the service Provision sequence.

Request code
								
HttpResponse<String> response = Unirest.get("https://rest_url//jax-rs/streams/status/service_instances/{instanceId}/service_bindings/{bindingId}") .header("accept", "application/json") .asString();
Response model

200

Successful response

Body

enabled

BOOLEAN , optional

Determines whether the IBM Cloud service enabled property is set for the Streaming Analytics service instance. Values: true | false

plan

STRING , optional

Determines the pricing plan you selected when creating the Streaming Analytics service instance.

state

STRING , optional

Specifies the IBM Cloud service state for the specified Streaming Analytics service instance. Values: STARTING, STARTED, STOPPING, or STOPPED

status

STRING , optional

Indicates the status of the service instance. Valid values are failed, partially_failed, partially_running, running, starting, stopped, stopping, and unknown.

Response example

200

Successful response

								{
  "enabled" : boolean,
  "plan" : string,
  "state" : string,
  "status" : string
}
							
Start a service instance
Starts a stopped service instance.

PUT   /jax-rs/streams/start/service_instances/{instanceId}/service_bindings/{bindingId}

			https://{rest_url}/jax-rs/streams/start/service_instances/{instanceId}/service_bindings/{bindingId}
		
Keys
Global variables

rest_url

BASEURL , required

You must take this value from the service credentials, which can be accessed from the service dashboard.

Path and Query parameters

bindingId

URL , required

The bind ID established on the service bind sequence. You can find the parameter value in the service credentials.

body

STRING , required

Enter an empty JSON object

instanceId

URL , required

The service instance ID established on the service provision sequence. You can find the parameter value in the service credentials.

Request code
								
HttpResponse<String> response = Unirest.put("https://rest_url//jax-rs/streams/start/service_instances/{instanceId}/service_bindings/{bindingId}?body=string") .header("accept", "application/json") .header("content-type", "application/json") .asString();
Response model

200

Successful response

Body

enabled

BOOLEAN , optional

Determines whether the IBM Cloud service enabled property is set for the service instance.

plan

STRING , optional

Determines the pricing plan you selected when creating the service instance.

state

STRING , optional

Specifies the IBM Cloud service state for the specified service instance.

status

STRING , optional

Indicates the status of the service instance. Valid values are failed, partially_failed, partially_running, running, starting, stopped, stopping, and unknown.

Response example

200

Successful response

								{
  "enabled" : boolean,
  "plan" : string,
  "state" : string,
  "status" : string
}
							
Stop instance
Stops a running service instance.

PUT   /jax-rs/streams/stop/service_instances/{instanceId}/service_bindings/{bindingId}

			https://{rest_url}/jax-rs/streams/stop/service_instances/{instanceId}/service_bindings/{bindingId}
		
Keys
Global variables

rest_url

BASEURL , required

You must take this value from the service credentials, which can be accessed from the service dashboard.

Path and Query parameters

bindingId

URL , required

The bind ID established on the service bind sequence. You can find the parameter value in the service credentials.

body

STRING , required

Enter an empty JSON object.

instanceId

URL , required

The service instance ID established on the service provision sequence. You can find the parameter value in the service credentials.

Request code
								
HttpResponse<String> response = Unirest.put("https://rest_url//jax-rs/streams/stop/service_instances/{instanceId}/service_bindings/{bindingId}?body=string") .header("accept", "application/json") .header("content-type", "application/json") .asString();
Response model

200

Successful response

Body

enabled

BOOLEAN , optional

Determines whether the IBM Cloud service enabled property is set for the Streaming Analytics service instance.

plan

STRING , optional

Determines the pricing plan you selected when creating the Streaming Analytics service instance.

state

STRING , optional

Specifies the IBM Cloud service state for the specified Streaming Analytics service instance. Values: STARTING, STARTED, STOPPING, or STOPPED.

status

STRING , optional

Indicates the status of the service instance. Valid values are failed, partially_failed, partially_running, running, starting, stopped, stopping, and unknown.

Response example

200

Successful response

								{
  "enabled" : boolean,
  "plan" : string,
  "state" : string,
  "status" : string
}
							

Loading content...