IBM InfoSphere Streams Version 4.1.1

Instance resources

This collection resource provides access to information about the resources that are allocated to instances in a domain.

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/domains/{restid}/resourceallocations
https://server:port/streams/rest/instances/{restid}/resourceallocations

The first URI pattern returns information about the resources that are allocated to each instance in a domain. The second URI pattern returns information about the resources that are allocated to a specific instance.

Properties

This collection resource has the following properties:

next: A string that represents 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 represents 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.
resourceAllocations: An array of instance resource objects. For more information about the properties for each instance resource object, see Instance resource.
resourceType: A string that represents the REST resource type: resourceAllocationList.
total: A number that represents 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 parameter is also supported when you use the https://server:port/streams/rest/domains/{restid}/resourceallocations URI pattern:

resource.restid

This parameter specifies the value of the restid property for a resource in the domain. For more, see Domain resource. If this parameter is used, the list is limited to the resources that you specify. For example:

https://server1:8443/streams/rest/domains/StreamsDomain/resourceallocations?resource.restid=server2.ibm.com

The following query parameter is also supported when you use the https://server:port/streams/rest/instances/{restid}/resourceallocations URI pattern:

job.restid

This parameter specifies the value of the restid property for a job in the domain. For more information, see Job. If this parameter is used, the list is limited to the resources on which the specified job resource is running. For example:

https://server1:8443/streams/rest/instances/StreamsInstance/resourceallocations?job.restid=5