IBM InfoSphere Streams Version 4.1.1
Instance resource
This element resource provides access
to information about a resource that is allocated to an InfoSphere®
Streams instance.
Note: The
concept of REST API resources is different from the general concept
of resources in InfoSphere
Streams.
A REST API resource refers an object with properties and relationships
to other resources. An InfoSphere
Streams resource
refers to an entity on which streams processing applications and
domain and instance services can run.
Universal Resource Identifier (URI) pattern
https://server:port/streams/rest/instances/{restid}/resourceallocations/{restid}Properties
This element resource has the
following properties:
- activeServices
- A string that identifies the URI that you can use to access information about the instance services that run on the resource.
- applicationResource
- A boolean value that indicates whether the resource is an application resource, which is used to run streams processing applications.
- domain
- A string that identifies the URI that you can use to access information about the domain that contains the instance.
- instance
- A string that identifies the URI that you can use to access information about the instance.
- jobs
- A string that identifies the URI that you can use to access information
about the jobs that run on the resource. Note: This information is returned only if the resource is an application resource.
- pes
- A string that identifies the URI that you can use to access information
about the processing elements that run on the resource. Note: This information is only available if the resource is an application resource.
- resource
- A string that identifies the URI that you can use to access general information about the resource.
- resourceSpecification
- An object that identifies the resource specification that was
used to allocate the resource to the instance.
- exclusive
- A boolean value that indicates whether the resource allocation is exclusive to the InfoSphere Streams instance.
- id
- A string that represents the InfoSphere Streams unique identifier for the resource specification.
- resourceCount
- A number that indicates the number of resources that were requested in the resource specification.
- resourceTags
- An array of strings that contains the tags that were included in the resource specification.
Note: If the resourceSpecification is not present, the resource was allocated to the instance by using a static host identifier. That is to say, the resource was not dynamically allocated. - resourceType
- A string that identifies the REST resource type, which is resourceAllocation.
- restid
- A string that represents the identifier that is used with the instance restid property to uniquely identify the resource allocation within a URI. The value of this property is the same as the value of the domain resource restid property.
- schedulerStatus
- A string that indicates whether the resource is schedulable for the instance, which means the resource is available for running streams processing applications. For more information about schedulable states, see Resource status values.
- self
- A string that identifies the URI for this resource.
- serviceStatus
- An array that provides the following information for each instance
service on the resource:
- name
- A string that identifies an instance service.
- status
- A string that identifies the status of the service. For more information about status values, see Service status values.
- status
- A string that identifies the status of the resource for the instance. For more information about status values, see Resource status values.
Resource retrieval
You can use the following HTTP methods and query parameters to retrieve this resource:
- HTTP methods
- GET
- Query parameters
- This element resource supports the standard query parameters for element resources.