IBM InfoSphere Streams Version 4.1.1
Processing elements
This collection resource provides access to information about the PEs that are running within the instance that you specify.
Universal Resource Identifier (URI) pattern
https://server:port/streams/rest/instances/{restid}/pesProperties
This collection resource has
the following properties:
- pes
- An array of PE objects.
- next
- A string that identifies the URI for the next page in the list. This property is not present if the list is not paged or if the current page is the last page.
- previous
- A string that identifies the URI for the previous page in the list. This property is not present if the list is not paged or if the current page is the first page.
- resourceType
- A string that identifies the REST resource type, which is peList.
- total
- A number that identifies the total number of objects in the list. If the list is filtered, the total corresponds to the total number of items that match the filter parameters.
Resource retrieval
You can use the following HTTP methods and query parameters to retrieve this resource:
- HTTP methods
- GET
- Query parameters
- This collection resource supports the standard query
parameters for collection resources. The following query parameters
are also supported for the collection resource:
- host.restid
- This parameter is deprecated and might become obsolete. Use resource.restid instead.
- This parameter specifies the value of the restid property
for an InfoSphere® Streams resource. If this parameter is used, the
list is limited to the processing elements for the InfoSphere Streams resource that
you specify. For example:
GET https://server1:8443/streams/rest/instances/StreamsInstance/pes?host.restid=1.2.3.4 - job.restid
- This parameter specifies the value of the restid property
for a job.
If this parameter is used, the list is limited to the processing elements
for the job that you specify. For example:
GET https://server1:8443/streams/rest/instances/StreamsInstance/pes?job.restid=12 - resource.restid
- This parameter specifies the value of the restid property
for a resource that is allocated to the instance. If
this parameter is used, the list is limited to the processing elements
that are running on the resource that you specify. For example:
GET https://server1:8443/streams/rest/instances/StreamsInstance/pes?resource.restid=server2.ibm.com