IBM InfoSphere Streams Version 4.1.1
Instance
This element resource provides access to information about an InfoSphere® Streams instance.
Universal Resource Identifier (URI) pattern
https://server:port/streams/rest/instances/{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 are running for this instance.
- activeVersion
- An object that contains the following information about the InfoSphere
Streams installation
that was used to start the instance:
- architecture
- A string that identifies the hardware architecture on which the product is installed.
- buildVersion
- A string that identifies the product build that is installed.
- editionName
- A string that identifies the product edition that is installed.
- fullProductVersion
- A string that identifies the 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
- A string that identifies the hot fix that is installed. This property is returned only if a hot fix is installed.
- minimumOSBaseVersion
- A string that identifies the minimum required operating system for the product. In particular, it identifies the base number of the version.
- minimumOSPatchVersion
- A string that identifies the minimum required operating system patch for the product.
- minimumOSVersion
- A string that identifies the minimum required operating system for the product.
- productName
- A string that identifies the official product name.
- productVersion
- A string that identifies the version of the product.
- activeViews
- Note: This property is deprecated and might become obsolete. Use the views property instead.A string that identifies the URI that you can use to access information about the active views in the instance.
- applicationNetwork
- A string that identifies the subnetworks that are used by the InfoSphere Streams data transport mechanism. This property is present only if the instance uses application network routing. For more information, see Application network properties for InfoSphere Streams domains and instances.
- configuredViews
- Note: This property is deprecated and might become obsolete. Use the views property instead.A string that identifies the URI that you can use to access information about the configured views in the instance.
- creationTime
- A number that represents the time that the instance was created. The unit of time is milliseconds since the epoch, which was midnight Greenwich mean time (GMT) on January 1, 1970.
- creationUser
- A string that identifies the user ID that created the instance.
- domain
- A string that identifies the URI that you can use to access information about the domain.
- exportedStreams
- A string that identifies the URI that you can use to access information about the exported streams in the instance.
- health
- A string that identifies the summarized status of the jobs in the instance. Some possible values for this property include healthy, partiallyHealthy, partiallyUnhealthy, unhealthy, and unknown.
- hosts
- A string that identifies the URI that you can use to access information about the hosts in the instance.
- id
- A string that represents the InfoSphere Streams unique identifier, which was specified when the instance was created. By default, when you retrieve a collection of instance resources, they are sorted according to this property value.
- importedStreams
- A string that identifies the URI that you can use to access information about the imported streams in the instance.
- jobs
- A string that identifies the URI that you can use to access information about the jobs that are running in the instance.
- operatorConnections
- A string that identifies the URI that you can use to access information about the operator connections in the instance.
- operators
- A string that identifies the URI that you can use to access information about the operators in the instance.
- owner
- A string that identifies the user ID that owns the instance.
- peConnections
- A string that identifies the URI that you can use to access information about the processing element connections in the instance.
- pes
- A string that identifies the URI that you can use to access information about the processing elements in the instance.
- resourceAllocations
- A string that identifies the URI that you can use to access information about the resources that are allocated to the instance.
- resourceType
- A string that identifies the REST resource type, which in this case is instance.
- restid
- A string that represents the identifier that uniquely identifies the instance within a REST URI. The value for this property is the same as the value of the id property.
- self
- A string that identifies the URI for this resource.
- startedBy
- A string that identifies the user ID that started the instance. This property is not present if the instance is not started.
- startTime
- A number that represents the time that the instance was started. The unit of time is milliseconds since the epoch, which was midnight Greenwich mean time (GMT) on January 1, 1970. This property is not present if the instance is not started.
- status
- A string that identifies the status of the instance. Some possible values for this property include running, failed, stopped, partiallyFailed, partiallyRunning, starting, stopping, and unknown.
- views
- A string that identifies the URI that you can use to access information about the views in the instance.
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.