IBM Streams 4.2
Instance host
This element resource
provides access to information about an IBM®
Streams resource that
is allocated to an instance.
Note: The concept of REST
API resources is different from the general concept of resources in IBM
Streams.
A REST API resource refers an object with properties and relationships
to other resources. An IBM
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}/hosts/{restid}Properties
This element resource has the
following properties:
- domain
- A string that identifies the URI that you can use to access information about the domain.
- instance
- A string that identifies the URI that you can use to access information about the instance.
- ipAddress
- A string that identifies the IP address for the IBM Streams resource.
- jobs
- A string that identifies the URI that you can use to access information about the jobs that are running on the IBM Streams resource.
- metrics
- A string that identifies the URI that you can use to access information about the metrics for the IBM Streams resource.
- name
- A string that identifies the configuration name for the IBM Streams resource. This value can be a short name, long name, or IP address. By default, when you retrieve information about a collection of IBM Streams resource, they are sorted according to this property value.
- pes
- A string that identifies the URI that you can use to access information about the processing elements that are running on the IBM Streams resource.
- processorCount
- A number that represents the number of processors on the IBM Streams resource.
- resourceType
- A string that identifies the REST resource type, which in this case is host.
- restid
- A string that represents the identifier that is used to uniquely identify the host within a URI. The value of this property is the same as the value of the ipAddress property.
- restrictedTags
- An array of strings that identifies the set of resource tags that processing elements (PEs) must have to run on the IBM Streams resource.
- schedulerState
- A string that identifies the status of the IBM Streams resource regarding its availability for scheduling application jobs. Some possible values for this property include failed, starting, degraded, schedulable, and stopped. When an IBM Streams resource is schedulable, it means that the resource is running normally, the application deployment service is available, and the resource can be used to schedule application jobs.
- self
- A string that identifies the URI for this resource.
- services
- An array that provides the following information for each instance
service that is designated to run on the IBM
Streams resource:
- name
- A string that identifies the name of the service.
- status
- A string that identifies the status of the service. For more information, see IBM Streams service status values.
- statusReason
- Note: This property is deprecated and might become obsolete.A string that identifies a reason code, which provides more information about the current state of the service.
- status
- A string that identifies the status of the IBM Streams resource. For more information, see Resource status values.
- tags
- An array of strings that provides the names of each tag that is assigned to the IBM Streams resource.
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.