IBM Streams 4.3.0
Instance services
This collection resource provides access to information about the instance services that are running for a specific IBM® Streams instance, including standby services.
Universal Resource Identifier (URI) pattern
https://server:port/streams/rest/instances/{restid}/activeservicesProperties
This collection resource has
the following properties:
- activeServices
- An array of instance service objects. For more information about the properties for each instance service object, see Instance service.
- 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.
- resourceType
- A string that represents the REST resource type, which is activeServiceList.
- 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 for the collection resource:
- resource.restid
- This parameter specifies the value of the restid property for a resource in
the domain. For more information, see Domain resource. If this parameter is used, the list is limited to the instance services for the
resource that you specify. For example:
https://server1:8443/streams/rest/instances/StreamsInstance/activeservices?resource.restid=host1.ibm.com