Teracloud Streams (7.2.0.0)

Download OpenAPI specification:Download

Using Streams REST Management APIs

The REST management API provides programmatic access to configuration and management for Streams objects such as the domain, instances, resources, services and jobs. You can use the REST management API from any application that can establish an HTTPS connection to the server that is running the REST management API service.

Planning for release compatibility with the Streams REST management API
You can design your application to avoid future compatibility issues due to updates to the Streams REST management API.
Configuring security for the Streams REST management API
When you are developing an application that uses the Streams REST API, you must configure the access control lists, choose a method for authenticating users, and handle server and client certificates.
Enabling cross-origin requests to the Streams REST management API
If you add an origin to the Streams trusted origin list, you can make cross-origin requests to the REST management API from that origin.
Processing REST management API requests
To access information from Streams by using the REST management API, your application must send a valid HTTP request. The application must then handle the HTTP response.

Domain

APIs to access domain information, configurations, logs and perform domain level actions.

List domains

This collection resource provides access to information about the domains that are accessible.

Authorizations:

authBasic

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
403
500

Content type

application/json

{"domains": [{"activeServices": "string",
"activeVersion": {"architecture": "x86_64",
"buildVersion": "20250310145500",
"editionName": "Teracloud Streams",
"fullProductVersion": "7.2.0.0",
"hotFix": "string",
"minimumOSBaseVersion": "8",
"minimumOSPatchVersion": "0",
"minimumOSVersion": "Red Hat Enterprise Linux Server release 8.0 (Ootpa)",
"productName": "Teracloud Streams",
"productVersion": "7.2.0.0"
},
"applicationConfigurations": "https://host:port/streams/domains/{domainId}/applicationconfigurations",
"creationTime": "1741151569482",
"creationUser": "joeadmin",
"customResourceTags": "https://host:port/streams/domains/{domainId}/customresourcetags",
"groups": "https://host:port/streams/domains/{domainId}/groups",
"hosts": "Deprecated: This property is deprecated and might become obsolete.",
"id": "mydomainid",
"instances": "string",
"productLog": "https://host:port/streams/domains/{domainId}/productlog",
"productLogTrace": "https://host:port/streams/domains/{domainId}/productlogtrace",
"properties": "string",
"resourceAllocations": "Deprecated: This property is deprecated and might become obsolete.",
"resourceTags": [{"customDefinition": "string",
"definitionFormatProperties": true,
"description": "A management resource is one that can be used to run the Streams management services.",
"name": "management",
"propertiesDefinition": "{}",
"reserved": false
}
],
"resourceType": "domain",
"resources": "https://host:port/streams/domains/{domainId}/resources",
"restid": "myinstanceid",
"restrictedConfigurations": "https://host:port/streams/domains/{domainId}/restrictedconfigurations",
"roles": "https://host:port/streams/domains/{domainId}/roles",
"securedObjects": "https://host:port/streams/instances/{instanceId}/securedobjects",
"self": "https://host:port/streams/domains/{domainId}",
"startTime": 1537301102922,
"status": "running",
"trustedOrigins": "https://host:port/streams/instances/{instanceId}/trustedorigins",
"urlConsole": "https://host:port/streams/domain/console",
"urlsJmx": ["service:jmx:jmxmp://host:9975"
],
"urlsRest": ["https://host:9714/streams/resources"
],
"users": "https://host:port/streams/domains/{domainId}/users",
"zooKeeperConnectionString": "1.2.3.4:2000,1.2.3.5:2000,1.2.3.6:2000",
"zooKeeperEnsemble": "https://host:port/streams/domains/{domainId}/zookeeperensembles/1.2.3.4:2000,1.2.3.5:2000,1.2.3.6:2000"
}
],
"first": "https://host:port/streams/domains?count=10&page=1",
"last": "https://host:port/streams/domains?count=10&page=-1",
"next": "https://host:port/streams/domains?count=10&page=3",
"previous": "https://host:port/streams/domains?count=10&page=1",
"resourceType": "domainList",
"total": 50
}

Get domain

This element resource provides access to information about a Streams domain.

Authorizations:

authBasic

path Parameters

domainId

required

string

Example: myDomain

Specifies the unique identifier for the domain.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"activeServices": "string",
"activeVersion": {"architecture": "x86_64",
"buildVersion": "20250310145500",
"editionName": "Teracloud Streams",
"fullProductVersion": "7.2.0.0",
"hotFix": "string",
"minimumOSBaseVersion": "8",
"minimumOSPatchVersion": "0",
"minimumOSVersion": "Red Hat Enterprise Linux Server release 8.0 (Ootpa)",
"productName": "Teracloud Streams",
"productVersion": "7.2.0.0"
},
"applicationConfigurations": "https://host:port/streams/domains/{domainId}/applicationconfigurations",
"creationTime": "1741151569482",
"creationUser": "joeadmin",
"customResourceTags": "https://host:port/streams/domains/{domainId}/customresourcetags",
"groups": "https://host:port/streams/domains/{domainId}/groups",
"hosts": "Deprecated: This property is deprecated and might become obsolete.",
"id": "mydomainid",
"instances": "string",
"productLog": "https://host:port/streams/domains/{domainId}/productlog",
"productLogTrace": "https://host:port/streams/domains/{domainId}/productlogtrace",
"properties": "string",
"resourceAllocations": "Deprecated: This property is deprecated and might become obsolete.",
"resourceTags": [{"customDefinition": "string",
"definitionFormatProperties": true,
"description": "A management resource is one that can be used to run the Streams management services.",
"name": "management",
"propertiesDefinition": "{}",
"reserved": false
}
],
"resourceType": "domain",
"resources": "https://host:port/streams/domains/{domainId}/resources",
"restid": "myinstanceid",
"restrictedConfigurations": "https://host:port/streams/domains/{domainId}/restrictedconfigurations",
"roles": "https://host:port/streams/domains/{domainId}/roles",
"securedObjects": "https://host:port/streams/instances/{instanceId}/securedobjects",
"self": "https://host:port/streams/domains/{domainId}",
"startTime": 1537301102922,
"status": "running",
"trustedOrigins": "https://host:port/streams/instances/{instanceId}/trustedorigins",
"urlConsole": "https://host:port/streams/domain/console",
"urlsJmx": ["service:jmx:jmxmp://host:9975"
],
"urlsRest": ["https://host:9714/streams/resources"
],
"users": "https://host:port/streams/domains/{domainId}/users",
"zooKeeperConnectionString": "1.2.3.4:2000,1.2.3.5:2000,1.2.3.6:2000",
"zooKeeperEnsemble": "https://host:port/streams/domains/{domainId}/zookeeperensembles/1.2.3.4:2000,1.2.3.5:2000,1.2.3.6:2000"
}

Perform domain action

This method provides the ability to perform domain actions such as exporting a keystore.

Authorizations:

authBasic

path Parameters

domainId

required

string

Example: myDomain

Specifies the unique identifier for the domain.

Request Body schema: application/json
required

type required	string Value: "exportKeystore" Identifies the action to perform: exportKeystore : For secure HTTPS support, the Streams data service, REST management API service, Streams Console (SWS) and JMX management API service's large data handler use a server certificate in the keystore file to identify itself to clients that are connecting to the service. The exported keystore can be used by a client to compare against the certificate sent by the Streams service.
keystoreType	string Enum: "data" "jmxHttp" "rest" "sws" Identifies the keystore to export. This property applies to the following action types: exportKeystore*. data : Keystore for the Streams data service. jmxHttp : Keystore for the JMX management API service's large data handling. rest : Keystore for the REST management API service. sws : Keystore for the Streams Console.
password	string Specifies a password to set for the exported keystore. This property applies to the following action types: exportKeystore*.

Responses

Request samples

Payload

Content type

application/json

{"type": "exportKeystore",
"keystoreType": "jmxHttp",
"password": "mypassword"
}

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

Download product log

This method provides the ability to retrieve the product log for the domain.

Authorizations:

authBasic

path Parameters

domainId

required

string

Example: myDomain

Specifies the unique identifier for the domain.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
endTime	integer <int64> Example: endTime=1487373013042 Specifies a time identifying which items to retrieve. Only items with a time before the specified time are returned. The unit of time is milliseconds since midnight Greenwich mean time (GMT) January 1, 1970. By default, all items are returned regardless of time.
startTime	integer <int64> Example: startTime=1487373013042 Specifies a time identifying which items to retrieve. Only items with a time after the specified time are returned. The unit of time is milliseconds since midnight Greenwich mean time (GMT) January 1, 1970. If the If-Modified-Since-Milliseconds header is also specified, the header value is ignored. By default, all items are returned regardless of time.

header Parameters

If-Modified-Since-Milliseconds

integer <int64>

Example: 1537301102922

Specifies a time identifying which items to retrieve. Only items with a time after the specified time are returned. The unit of time is milliseconds since midnight Greenwich mean time (GMT) January 1, 1970. To retrieve only items with a time after the last items returned, set this header value to the time that was returned by the Last-Modified-Milliseconds response header from the previous request.

Responses

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

Download product log and trace files

This method provides the ability to retrieve log and trace files for the domain.

Authorizations:

authBasic

path Parameters

domainId

required

string

Example: myDomain

Specifies the unique identifier for the domain.

Responses

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

List domain configuration properties

This collection resource provides access to information about all configuration properties for the domain.

Authorizations:

authBasic

path Parameters

domainId

required

string

Example: myDomain

Specifies the unique identifier for the domain.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/properties?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/properties?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/properties?count=10&page=3",
"previous": "https://host:port/streams/instances/{instanceId}/properties?count=10&page=1",
"properties": [{"constrainingRegularExpression": ".+",
"constraintType": "greaterOrEqual",
"defaultContentType": "constant",
"defaultValue": "en_US.UTF-8",
"description": "Specifies whether the Streams Console is enabled.",
"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"maximumContentType": "constant",
"maximumValue": "instance.jobsCpuMaximum",
"minimumContentType": "constant",
"minimumValue": "job.cpuMaximum",
"name": "auditlog.level",
"pendingValue": "enabled",
"possibleValues": ["warning"
],
"propertyGroup": "job",
"resolvedDefaultValue": "warning",
"resourceType": "property",
"restid": "auditlog.level",
"self": "https://host:port/rest/instances/{instanceId}/properties/{propertyName}",
"updateType": "anyTime",
"value": "5000",
"valueHidden": "true",
"valueInherited": "false",
"valueType": "integer"
}
],
"resourceType": "propertyList",
"total": 50
}

Get domain configuration property

This element resource provides access to information about a domain configuration property.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
propertyName required	string Example: domain.sslOption Identifies the property name.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"constrainingRegularExpression": ".+",
"constraintType": "greaterOrEqual",
"defaultContentType": "constant",
"defaultValue": "en_US.UTF-8",
"description": "Specifies whether the Streams Console is enabled.",
"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"maximumContentType": "constant",
"maximumValue": "instance.jobsCpuMaximum",
"minimumContentType": "constant",
"minimumValue": "job.cpuMaximum",
"name": "auditlog.level",
"pendingValue": "enabled",
"possibleValues": ["warning"
],
"propertyGroup": "job",
"resolvedDefaultValue": "warning",
"resourceType": "property",
"restid": "auditlog.level",
"self": "https://host:port/rest/instances/{instanceId}/properties/{propertyName}",
"updateType": "anyTime",
"value": "5000",
"valueHidden": "true",
"valueInherited": "false",
"valueType": "integer"
}

Update domain configuration property

This method provides the ability to update a domain property.

Note: If your REST client does not support the PATCH method, you can use the POST method with the request header X-HTTP-Method-Override=PATCH specified.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
propertyName required	string Example: domain.sslOption Identifies the property name.

Request Body schema: application/json
required

value

required

string

Specifies the new property value. To reset a property value to its default, specify null for the value.

Responses

Request samples

Payload

Content type

application/json

{"value": "trace"
}

Response samples

200
400
403
404
500

Content type

application/json

{"constrainingRegularExpression": ".+",
"constraintType": "greaterOrEqual",
"defaultContentType": "constant",
"defaultValue": "en_US.UTF-8",
"description": "Specifies whether the Streams Console is enabled.",
"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"maximumContentType": "constant",
"maximumValue": "instance.jobsCpuMaximum",
"minimumContentType": "constant",
"minimumValue": "job.cpuMaximum",
"name": "auditlog.level",
"pendingValue": "enabled",
"possibleValues": ["warning"
],
"propertyGroup": "job",
"resolvedDefaultValue": "warning",
"resourceType": "property",
"restid": "auditlog.level",
"self": "https://host:port/rest/instances/{instanceId}/properties/{propertyName}",
"updateType": "anyTime",
"value": "5000",
"valueHidden": "true",
"valueInherited": "false",
"valueType": "integer"
}

Instance

APIs to access instance information, configurations and perform instance level actions.

List instances

This collection resource provides access to information about the instances to which the current user has access.

Authorizations:

authBasic

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
403
500

Content type

application/json

{"first": "https://host:port/streams/instances?count=10&page=1",
"instances": [{"activeServices": "string",
"activeVersion": {"architecture": "x86_64",
"buildVersion": "20250310145500",
"editionName": "Teracloud Streams",
"fullProductVersion": "7.2.0.0",
"hotFix": "string",
"minimumOSBaseVersion": "8",
"minimumOSPatchVersion": "0",
"minimumOSVersion": "Red Hat Enterprise Linux Server release 8.0 (Ootpa)",
"productName": "Teracloud Streams",
"productVersion": "7.2.0.0"
},
"applicationConfigurations": "https://host:port/streams/instances/{instanceId}/applicationconfigurations",
"applicationEnvironmentVariables": "https://host:port/streams/instances/{instanceId}/applicationenvironmentvariables",
"applicationNetwork": "192.0.2.0/24,198.51.100.0/24",
"applicationResourceTags": ["string"
],
"creationTime": "1741151569482",
"creationUser": "joeadmin",
"domain": "https://host:port/streams/domains/{domainId}",
"exportedStreams": "https://host:port/streams/instances/{instanceId}/exportedstreams",
"groups": "https://host:port/streams/domains/{domainId}/groups",
"health": "healthy",
"hosts": "Deprecated: This property is deprecated and might become obsolete.",
"id": "myinstanceid",
"importedStreams": "https://host:port/streams/instances/{instanceId}/importedstreams",
"jobGroups": "https://host:port/streams/instances/{instanceId}/jobgroups",
"jobMetricMetadata": "https://host:port/streams/instances/{instanceId}/jobmetricmetadata",
"jobs": "https://host:port/streams/instances/{instanceId}/jobs",
"jobsMetricsSnapshot": "https://host:port/streams/instances/{instanceId}/jobs/metricssnapshot",
"jobsSnapshot": "https://host:port/streams/instances/{instanceId}/jobs/snapshot",
"operatorConnections": "https://host:port/streams/instances/{instanceId}/operatorconnections",
"operators": "https://host:port/streams/instances/{instanceId}/operators",
"owner": "streamsadmin",
"peConnections": "https://host:port/streams/instances/{instanceId}/peconnections",
"pes": "https://host:port/streams/instances/{instanceId}/pes",
"properties": "string",
"resourceAllocations": "Deprecated: This property is deprecated and might become obsolete.",
"resourceType": "instance",
"resources": "https://host:port/streams/domains/{domainId}/resources",
"restid": "myinstanceid",
"restrictedConfigurations": "https://host:port/streams/instances/{instanceId}/restrictedconfigurations",
"restrictedTags": "1741151569482",
"roles": "https://host:port/streams/domains/{domainId}/roles",
"securedObjects": "https://host:port/streams/instances/{instanceId}/securedobjects",
"self": "https://host:port/streams/instances/{instanceId}",
"startTime": 1537301102922,
"startedBy": "streamsadmin",
"status": "running",
"urlsData": ["https://host:34719/streams/dataxjobs"
],
"users": "https://host:port/streams/domains/{domainId}/users",
"views": "https://host:port/streams/instances/{instanceId}/views"
}
],
"last": "https://host:port/streams/instances?count=10&page=-1",
"next": "https://host:port/streams/instances?count=10&page=3",
"previous": "https://host:port/streams/instances?count=10&page=1",
"resourceType": "instanceList",
"total": 50
}

Create instance

This method provides the ability to create a new Streams instance.

Authorizations:

authBasic

Request Body schema: application/json
required

name required	string Identifies the name of the instance to create.
administratorGroup	string Specifies a group whose members can administer the instance. If not specified, only the current user and any user that has the DomainAdministrator or InstanceAdministrator role can administer the instance.
	object Provides property names and values to set in the configuration.
	Array of objects Specifies resource specifications to use for adding resources to the instance.
userGroup	string Specifies a group whose members can use the instance. If not specified, only the current user and any user that has the InstanceUser role can use the instance.

Responses

Request samples

Payload

Content type

application/json

{"name": "instanceA",
"administratorGroup": "itdept",
"properties": {"[property-name]": "trace"
},
"resourceSpecifications": [{"exclusive": false,
"resourceCount": 2,
"restrictedTags": ["operations"
],
"tags": ["large"
]
}
],
"userGroup": "sales"
}

Response samples

201
400
403
404
500

Content type

application/json

{"activeServices": "string",
"activeVersion": {"architecture": "x86_64",
"buildVersion": "20250310145500",
"editionName": "Teracloud Streams",
"fullProductVersion": "7.2.0.0",
"hotFix": "string",
"minimumOSBaseVersion": "8",
"minimumOSPatchVersion": "0",
"minimumOSVersion": "Red Hat Enterprise Linux Server release 8.0 (Ootpa)",
"productName": "Teracloud Streams",
"productVersion": "7.2.0.0"
},
"applicationConfigurations": "https://host:port/streams/instances/{instanceId}/applicationconfigurations",
"applicationEnvironmentVariables": "https://host:port/streams/instances/{instanceId}/applicationenvironmentvariables",
"applicationNetwork": "192.0.2.0/24,198.51.100.0/24",
"applicationResourceTags": ["string"
],
"creationTime": "1741151569482",
"creationUser": "joeadmin",
"domain": "https://host:port/streams/domains/{domainId}",
"exportedStreams": "https://host:port/streams/instances/{instanceId}/exportedstreams",
"groups": "https://host:port/streams/domains/{domainId}/groups",
"health": "healthy",
"hosts": "Deprecated: This property is deprecated and might become obsolete.",
"id": "myinstanceid",
"importedStreams": "https://host:port/streams/instances/{instanceId}/importedstreams",
"jobGroups": "https://host:port/streams/instances/{instanceId}/jobgroups",
"jobMetricMetadata": "https://host:port/streams/instances/{instanceId}/jobmetricmetadata",
"jobs": "https://host:port/streams/instances/{instanceId}/jobs",
"jobsMetricsSnapshot": "https://host:port/streams/instances/{instanceId}/jobs/metricssnapshot",
"jobsSnapshot": "https://host:port/streams/instances/{instanceId}/jobs/snapshot",
"operatorConnections": "https://host:port/streams/instances/{instanceId}/operatorconnections",
"operators": "https://host:port/streams/instances/{instanceId}/operators",
"owner": "streamsadmin",
"peConnections": "https://host:port/streams/instances/{instanceId}/peconnections",
"pes": "https://host:port/streams/instances/{instanceId}/pes",
"properties": "string",
"resourceAllocations": "Deprecated: This property is deprecated and might become obsolete.",
"resourceType": "instance",
"resources": "https://host:port/streams/domains/{domainId}/resources",
"restid": "myinstanceid",
"restrictedConfigurations": "https://host:port/streams/instances/{instanceId}/restrictedconfigurations",
"restrictedTags": "1741151569482",
"roles": "https://host:port/streams/domains/{domainId}/roles",
"securedObjects": "https://host:port/streams/instances/{instanceId}/securedobjects",
"self": "https://host:port/streams/instances/{instanceId}",
"startTime": 1537301102922,
"startedBy": "streamsadmin",
"status": "running",
"urlsData": ["https://host:34719/streams/dataxjobs"
],
"users": "https://host:port/streams/domains/{domainId}/users",
"views": "https://host:port/streams/instances/{instanceId}/views"
}

Delete instance

This method provides the ability to delete an instance from the domain.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

Responses

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

Get instance

This element resource provides access to information about an IBM Streams instance.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"activeServices": "string",
"activeVersion": {"architecture": "x86_64",
"buildVersion": "20250310145500",
"editionName": "Teracloud Streams",
"fullProductVersion": "7.2.0.0",
"hotFix": "string",
"minimumOSBaseVersion": "8",
"minimumOSPatchVersion": "0",
"minimumOSVersion": "Red Hat Enterprise Linux Server release 8.0 (Ootpa)",
"productName": "Teracloud Streams",
"productVersion": "7.2.0.0"
},
"applicationConfigurations": "https://host:port/streams/instances/{instanceId}/applicationconfigurations",
"applicationEnvironmentVariables": "https://host:port/streams/instances/{instanceId}/applicationenvironmentvariables",
"applicationNetwork": "192.0.2.0/24,198.51.100.0/24",
"applicationResourceTags": ["string"
],
"creationTime": "1741151569482",
"creationUser": "joeadmin",
"domain": "https://host:port/streams/domains/{domainId}",
"exportedStreams": "https://host:port/streams/instances/{instanceId}/exportedstreams",
"groups": "https://host:port/streams/domains/{domainId}/groups",
"health": "healthy",
"hosts": "Deprecated: This property is deprecated and might become obsolete.",
"id": "myinstanceid",
"importedStreams": "https://host:port/streams/instances/{instanceId}/importedstreams",
"jobGroups": "https://host:port/streams/instances/{instanceId}/jobgroups",
"jobMetricMetadata": "https://host:port/streams/instances/{instanceId}/jobmetricmetadata",
"jobs": "https://host:port/streams/instances/{instanceId}/jobs",
"jobsMetricsSnapshot": "https://host:port/streams/instances/{instanceId}/jobs/metricssnapshot",
"jobsSnapshot": "https://host:port/streams/instances/{instanceId}/jobs/snapshot",
"operatorConnections": "https://host:port/streams/instances/{instanceId}/operatorconnections",
"operators": "https://host:port/streams/instances/{instanceId}/operators",
"owner": "streamsadmin",
"peConnections": "https://host:port/streams/instances/{instanceId}/peconnections",
"pes": "https://host:port/streams/instances/{instanceId}/pes",
"properties": "string",
"resourceAllocations": "Deprecated: This property is deprecated and might become obsolete.",
"resourceType": "instance",
"resources": "https://host:port/streams/domains/{domainId}/resources",
"restid": "myinstanceid",
"restrictedConfigurations": "https://host:port/streams/instances/{instanceId}/restrictedconfigurations",
"restrictedTags": "1741151569482",
"roles": "https://host:port/streams/domains/{domainId}/roles",
"securedObjects": "https://host:port/streams/instances/{instanceId}/securedobjects",
"self": "https://host:port/streams/instances/{instanceId}",
"startTime": 1537301102922,
"startedBy": "streamsadmin",
"status": "running",
"urlsData": ["https://host:34719/streams/dataxjobs"
],
"users": "https://host:port/streams/domains/{domainId}/users",
"views": "https://host:port/streams/instances/{instanceId}/views"
}

Perform instance action

This method provides the ability to perform instance actions such as starting and stopping.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

Request Body schema: application/json
required

type required	string Enum: "start" "stop" Identifies the action to perform: start : Starts the instance. stop : Stops the instance.
force	boolean Indicates whether the instance is forced to stop when the authentication service is not available. If a value is not specified, the instance fails to stop when the authentication service is not available. This property applies to the following action types: stop.
version	string Specifies the version of Streams to use when starting the instance. The format of the version is v.r.m.f<.h> where v, r, m, f, and h are all numeric values identifying the version, release, modification, fix, and optional hot fix levels. The specified version must be installed on the resource where the management API service is running and it must be within the same base installation path as the version used to start the domain; otherwise, the instance fails to start. If this value is null or not specified, the instance is started using the version specified by the instance.startAsVersion property. If that property is not set, the active domain version is used. This property applies to the following action types: start.

Responses

Request samples

Payload

Content type

application/json

{"type": "stop",
"force": true
}

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

List configuration properties

This collection resource provides access to information about all configuration properties for the instance.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/properties?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/properties?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/properties?count=10&page=3",
"previous": "https://host:port/streams/instances/{instanceId}/properties?count=10&page=1",
"properties": [{"constrainingRegularExpression": ".+",
"constraintType": "greaterOrEqual",
"defaultContentType": "constant",
"defaultValue": "en_US.UTF-8",
"description": "Specifies whether the Streams Console is enabled.",
"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"maximumContentType": "constant",
"maximumValue": "instance.jobsCpuMaximum",
"minimumContentType": "constant",
"minimumValue": "job.cpuMaximum",
"name": "auditlog.level",
"pendingValue": "enabled",
"possibleValues": ["warning"
],
"propertyGroup": "job",
"resolvedDefaultValue": "warning",
"resourceType": "property",
"restid": "auditlog.level",
"self": "https://host:port/rest/instances/{instanceId}/properties/{propertyName}",
"updateType": "anyTime",
"value": "5000",
"valueHidden": "true",
"valueInherited": "false",
"valueType": "integer"
}
],
"resourceType": "propertyList",
"total": 50
}

Get instance configuration property

This element resource provides access to information about an instance configuration property.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
propertyName required	string Example: domain.sslOption Identifies the property name.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"constrainingRegularExpression": ".+",
"constraintType": "greaterOrEqual",
"defaultContentType": "constant",
"defaultValue": "en_US.UTF-8",
"description": "Specifies whether the Streams Console is enabled.",
"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"maximumContentType": "constant",
"maximumValue": "instance.jobsCpuMaximum",
"minimumContentType": "constant",
"minimumValue": "job.cpuMaximum",
"name": "auditlog.level",
"pendingValue": "enabled",
"possibleValues": ["warning"
],
"propertyGroup": "job",
"resolvedDefaultValue": "warning",
"resourceType": "property",
"restid": "auditlog.level",
"self": "https://host:port/rest/instances/{instanceId}/properties/{propertyName}",
"updateType": "anyTime",
"value": "5000",
"valueHidden": "true",
"valueInherited": "false",
"valueType": "integer"
}

Update instance configuration property.

This method provides the ability to update an instance property.

Note: If your REST client does not support the PATCH method, you can use the POST method with the request header X-HTTP-Method-Override=PATCH specified.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
propertyName required	string Example: domain.sslOption Identifies the property name.

Request Body schema: application/json
required

value

required

string

Specifies the new property value. To reset a property value to its default, specify null for the value.

Responses

Request samples

Payload

Content type

application/json

{"value": "trace"
}

Response samples

200
400
403
404
500

Content type

application/json

{"constrainingRegularExpression": ".+",
"constraintType": "greaterOrEqual",
"defaultContentType": "constant",
"defaultValue": "en_US.UTF-8",
"description": "Specifies whether the Streams Console is enabled.",
"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"maximumContentType": "constant",
"maximumValue": "instance.jobsCpuMaximum",
"minimumContentType": "constant",
"minimumValue": "job.cpuMaximum",
"name": "auditlog.level",
"pendingValue": "enabled",
"possibleValues": ["warning"
],
"propertyGroup": "job",
"resolvedDefaultValue": "warning",
"resourceType": "property",
"restid": "auditlog.level",
"self": "https://host:port/rest/instances/{instanceId}/properties/{propertyName}",
"updateType": "anyTime",
"value": "5000",
"valueHidden": "true",
"valueInherited": "false",
"valueType": "integer"
}

Job - Life cycle

APIs for job life cycle management.

Upload application bundle

This method provides the ability to upload an application bundle. If a job is submitted using the uploaded bundle, the bundle is held in the application cache repository while the job is running and remains in the cache for four hours after the job stops running. If the bundle is not used to submit a job, it is held in the application cache repository for four hours.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

Request Body schema: application/x-jar
required

Post content is application bundle (SAB file).

object

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"bundleId": "bundleId:abfa009e-4cb0-4304-84cb-59b7bb6d0191"
}

Submit job

This method provides the ability to submit a job to run in the instance. Alternatively, you can preview a job submission.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

Request Body schema: application/json
required

application required	string Specifies the application to submit. This can be a bundleId that was returned on a POST call to the application bundles collection. Another option is to provide a URL to the Streams application bundle file (.sab) to run.
	object Contains the credentials to set in the Authorization header when retrieving the application from a URL. This property value is ignored if the value of the application property does not start with http: or https:.
	object Contains name-value pairs for submission-time configuration. See the product reference documentation for the format of job configuration overlays.
jobGroup	string Identifies the job group to which the job is added. The job group is used to control permissions to the job.
jobName	string Identifies a name to associate with the job. This name must be unique within the instance. If a name is not specified, a default name is generated.
preview	boolean Indicates whether a preview should be generated of the job configuration overlay that would be used if the application is submitted with any specified parameters values and job configuration overlay. If a value is not specified, false is used.
	Array of objects Provides the parameter names and corresponding values to set when the job is submitted.

Responses

Request samples

Payload

Content type

application/json

{"application": "bundleId:343eb9fd-5f36-442e-9a1b-10817c76e66d",
"applicationCredentials": {"password": "secret",
"user": "mrsmith"
},
"jobConfigurationOverlay": {"jobConfigOverlays": [{"deploymentConfig": {"parallelRegionConfig": {"fusionType": "channelIsolation"
}
}
}
]
},
"jobGroup": "default",
"jobName": "myJob",
"preview": false,
"submitParameters": [{"name": "period",
"value": "5"
}
]
}

Response samples

Content type

application/json

{"jobConfigOverlays": [{"jobConfig": {"jobGroup": "default"
},
"deploymentConfig": {"placementScheme": "balancedInstance"
},
"operatorConfigs": {"poolPlacementGroups": [{"name": "$default",
"operatorsInPool": [{"nameSpec": "Generator"
}
],
"tags": [ ]
}
],
"operators": [{"nameSpec": "Generator"
}
]
}
}
],
"results": {"deploymentConfig": {"placementScheme": "balancedInstance"
},
"placementResults": [{"names": ["Generator"
],
"peId": 7,
"hostPlacement": "PreviewResource_0",
"tags": [ ]
}
],
"jobResources": [{"amountOfMemory": -99,
"resourceId": "PreviewResource_0",
"networkBandwidth": -1,
"tags": [ ]
}
]
}
}

Cancel job

This method provides the ability to cancel the job.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.

query Parameters

force

boolean

Example: force=true

Indicates whether the operation should be forced to complete if it cannot complete normally.

Responses

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

Update operators

This method provides the ability to make changes to the job such as: update the configuration for a sub-graph of the job, adjust the number of resources allocated to a sub-graph of the job, change the size of a parallel region.

Note: If your REST client does not support the PATCH method, you can use the POST method with the request header X-HTTP-Method-Override=PATCH specified.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.

Request Body schema: application/json
required

required

object

Contains name-value pairs for submission-time configuration. See the product reference documentation for the format of job configuration overlays.

Responses

Request samples

Payload

Content type

application/json

{"jobConfigurationOverlay": {"jobConfigOverlays": [{"deploymentConfig": {"parallelRegionConfig": {"fusionType": "channelIsolation"
}
}
}
]
}
}

Response samples

200
400
403
404
500

Content type

application/json

{"jobConfigOverlays": [{"jobConfig": {"jobGroup": "default"
},
"deploymentConfig": {"placementScheme": "balancedInstance"
},
"operatorConfigs": {"poolPlacementGroups": [{"name": "$default",
"operatorsInPool": [{"nameSpec": "Generator"
}
],
"tags": [ ]
}
],
"operators": [{"nameSpec": "Generator"
}
]
}
}
],
"results": {"deploymentConfig": {"placementScheme": "balancedInstance"
},
"placementResults": [{"names": ["Generator"
],
"peId": 7,
"hostPlacement": "PreviewResource_0",
"tags": [ ]
}
],
"jobResources": [{"amountOfMemory": -99,
"resourceId": "PreviewResource_0",
"networkBandwidth": -1,
"tags": [ ]
}
]
}
}

Job

APIs for managing jobs.

List exported streams

This collection resource provides access to information about the streams that are exported by all of the jobs in the instance.

The collection resource includes the following information for each exported stream: the operator output port that exports the stream and the active dynamic connections between this port and operator input ports from other jobs.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"exportedStreams": [{"operatorConnections": "https://host:port/streams/instances/{instanceId}/operatorconnections",
"operatorOutputPort": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}",
"resourceType": "exportedStream"
}
],
"first": "https://host:port/streams/instances/{instanceId}/exportedstreams?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/exportedstreams?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/exportedstreams?count=10&page=3",
"previous": "https://host:port/streams/instances/{instanceId}/exportedstreams?count=10&page=1",
"resourceType": "exportedStreamList",
"total": 50
}

List imported streams

This collection resource provides access to information about streams that are imported by jobs that are running in the instance.

The collection resource includes the following information for each imported stream: the operator input port that imports the stream and the active dynamic connections between this port and operator output ports from other jobs.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/importedstreams?count=10&page=1",
"importedStreams": [{"operatorConnections": "https://host:port/streams/instances/{instanceId}/operatorconnections",
"operatorInputPort": 0,
"resourceType": "importedStream"
}
],
"last": "https://host:port/streams/instances/{instanceId}/importedstreams?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/importedstreams?count=10&page=3",
"previous": "https://host:port/streams/instances/{instanceId}/importedstreams?count=10&page=1",
"resourceType": "importedStreamList",
"total": 50
}

List jobs

This collection resource provides access to information about the jobs that are running within the instance.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
resource.restid	string Example: resource.restid=management-0 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 resources for the specified Streams instance resource.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/jobs?count=10&page=1",
"jobs": [{"adlFile": "output/Main.adl",
"applicationLogTrace": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/applicationlogtrace",
"applicationName": "Main",
"applicationPath": "toolkits/customMetrics",
"applicationScope": "Default",
"applicationVersion": "1.0.0",
"checkpointPath": "/mypath/testapps/customMetrics/data/ckpt",
"dataPath": "/myapps/mydata",
"domain": "https://host:port/streams/domains/{domainId}",
"dynamicThreadingElastic": true,
"dynamicThreadingThreadCount": 2,
"fusionScheme": "automatic",
"generationId": 1,
"health": "healthy",
"hosts": "Deprecated: This property is deprecated and might become obsolete.",
"id": "0",
"instance": "https://host:port/streams/instances/{instanceId}",
"jobGroup": "https://host:port/streams/instances/{instanceId}/jobgroups/{jobGroupName}",
"jobResourceSharing": "sameInstance",
"metricsSnapshot": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/metricssnapshot",
"name": "Main_0",
"operatorConnections": "https://host:port/streams/instances/{instanceId}/operatorconnections",
"operators": "https://host:port/streams/instances/{instanceId}/operators",
"outputPath": "output",
"peConnections": "https://host:port/streams/instances/{instanceId}/peconnections",
"pes": "https://host:port/streams/instances/{instanceId}/pes",
"productLog": "https://host:port/streams/domains/{domainId}/productlog",
"productVersion": "7.2.0.0",
"proposedOperatorsPerResource": 8,
"resourceAllocations": "Deprecated: This property is deprecated and might become obsolete.",
"resourceType": "job",
"resources": "https://host:port/streams/instances/{instanceId}/resources?job.restid={jobId}",
"restid": "0",
"self": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"snapshot": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/snapshot",
"startedBy": "streamsadmin",
"status": "running",
"submitParameters": [{"composite": "application::AllDataTypes",
"defaultValue": "10000",
"name": "iterations",
"parameterKind": "named",
"required": false,
"values": ["1000"
]
}
],
"submitTime": 1538172886000,
"threadingModel": "notSpecified",
"topologyUpdating": false,
"views": "https://host:port/streams/instances/{instanceId}/views"
}
],
"last": "https://host:port/streams/instances/{instanceId}/jobs?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/jobs?count=10&page=3",
"previous": "https://host:port/streams/instances/{instanceId}/jobs?count=10&page=1",
"resourceType": "jobList",
"total": 50
}

Download metrics snapshot for jobs

This method provides access to a metrics snapshot for jobs in the instance.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

query Parameters

restid

string

Example: restid=0

Specifies the value of the restid property for one or more job resources separated by commas. If this parameter is used, the snapshot is limited to the specified jobs.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"id": "0",
"pes": [{"indexWithinJob": 3,
"operators": [{"outputPorts": [ ],
"name": "ScalarsForward",
"inputPorts": [{"indexWithinOperator": 0,
"metrics": [{"name": "queueSize",
"value": 0
},
{"name": "nEnqueueWaits",
"value": 0
}
]
}
],
"metrics": [{"name": "relativeOperatorCost",
"value": 0
}
]
}
],
"lastTimeRetrieved": 1539106030000
}
]
}

Download jobs snapshot

This method provides access to a properties snapshot for jobs and their child resources.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

query Parameters

includeStatics	boolean Example: includeStatics=false Indicates whether static properties should be included in a snapshot. A static property is a property whose value does not change. If this parameter is not specified, static properties are included. Identifier properties are always included.
maximumDepth	integer <int64> Example: maximumDepth=-1 Specifies which descendant object properties should be included in a snapshot. If this parameter is not specified, all descendant properties are included. Values are handled as follows: less than zero - all descendant properties are included. zero - no descendant properties are included. one - only properties for immediate child objects are included. greater than one - properties for descendants are included up to the level specified.
restid	string Example: restid=0 Specifies the value of the restid property for one or more job resources separated by commas. If this parameter is used, the snapshot is limited to the specified jobs.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"jobs": [{"adlFile": "notSpecified",
"applicationName": "myapps::app1",
"applicationPath": "toolkits/customMetrics",
"applicationScope": "default",
"applicationVersion": "1.0.0",
"checkpointPath": "/mypath/testapps/customMetrics/data/ckpt",
"dataPath": "/mydatapath",
"dynamicThreadingElastic": true,
"dynamicThreadingThreadCount": 2,
"fusionScheme": "automatic",
"generationId": 0,
"health": "healthy",
"id": "9",
"jobGroup": "default",
"jobResourceSharing": "sameInstance",
"name": "Main_0",
"outputPath": "output",
"pes": [{"health": "healthy",
"id": "0",
"indexWithinJob": 0,
"inputPorts": [{"connections": [{"id": "o0p1i0p2",
"required": true,
"source": {"job": null,
"outputPort": null,
"pe": null
},
"status": "connected",
"target": {"inputPort": null,
"job": null,
"pe": null
}
}
],
"id": "1",
"indexWithinPE": 0,
"operatorInputPorts": [0
],
"transportType": "tcp"
}
],
"launchCount": 1,
"operators": [{"indexWithinJob": 2,
"inputPorts": [{"connections": [{ }
],
"import": {"applicationScope": null,
"filter": null,
"operator": null,
"subscription": null,
"type": null
},
"indexWithinOperator": 0,
"name": "fSource1",
"peInputPorts": [null
]
}
],
"name": "operatorName",
"operatorKind": "spl.utility::Beacon",
"outputPorts": [{"connections": [{ }
],
"export": {"filterAllowed": null,
"name": null,
"operator": null,
"type": null
},
"indexWithinOperator": 0,
"name": "fSource1",
"peOutputPorts": [null
],
"streamViewable": true
}
]
}
],
"optionalConnections": "connected",
"outputPorts": [{"connections": [{"id": "o0p1i0p2",
"required": true,
"source": {"job": null,
"outputPort": null,
"pe": null
},
"status": "connected",
"target": {"inputPort": null,
"job": null,
"pe": null
}
}
],
"id": "1",
"indexWithinPE": 0,
"operatorOutputPorts": [0
],
"transportType": "tcp"
}
],
"processId": "1001",
"relocatable": true,
"requiredConnections": "conneted",
"resource": "app-9",
"resourceTags": ["application"
],
"restartable": true,
"status": "running",
"statusReason": "userRequest",
"traceLevel": "trace"
}
],
"productVersion": "5.0.0.0.20190814150153",
"proposedOperatorsPerResource": 34,
"resources": ["app-9"
],
"startedBy": "admin",
"status": "running",
"submitParameters": [{"composite": "application::AllDataTypes",
"defaultValue": "10000",
"name": "iterations",
"parameterKind": "named",
"required": false,
"values": ["1000"
]
}
],
"submitTime": 1538172886000,
"threadingModel": "notSpecified",
"topologyUpdating": false
}
]
}

Get job

This element resource provides access to information about a submitted job within the instance.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"adlFile": "output/Main.adl",
"applicationLogTrace": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/applicationlogtrace",
"applicationName": "Main",
"applicationPath": "toolkits/customMetrics",
"applicationScope": "Default",
"applicationVersion": "1.0.0",
"checkpointPath": "/mypath/testapps/customMetrics/data/ckpt",
"dataPath": "/myapps/mydata",
"domain": "https://host:port/streams/domains/{domainId}",
"dynamicThreadingElastic": true,
"dynamicThreadingThreadCount": 2,
"fusionScheme": "automatic",
"generationId": 1,
"health": "healthy",
"hosts": "Deprecated: This property is deprecated and might become obsolete.",
"id": "0",
"instance": "https://host:port/streams/instances/{instanceId}",
"jobGroup": "https://host:port/streams/instances/{instanceId}/jobgroups/{jobGroupName}",
"jobResourceSharing": "sameInstance",
"metricsSnapshot": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/metricssnapshot",
"name": "Main_0",
"operatorConnections": "https://host:port/streams/instances/{instanceId}/operatorconnections",
"operators": "https://host:port/streams/instances/{instanceId}/operators",
"outputPath": "output",
"peConnections": "https://host:port/streams/instances/{instanceId}/peconnections",
"pes": "https://host:port/streams/instances/{instanceId}/pes",
"productLog": "https://host:port/streams/domains/{domainId}/productlog",
"productVersion": "7.2.0.0",
"proposedOperatorsPerResource": 8,
"resourceAllocations": "Deprecated: This property is deprecated and might become obsolete.",
"resourceType": "job",
"resources": "https://host:port/streams/instances/{instanceId}/resources?job.restid={jobId}",
"restid": "0",
"self": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"snapshot": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/snapshot",
"startedBy": "streamsadmin",
"status": "running",
"submitParameters": [{"composite": "application::AllDataTypes",
"defaultValue": "10000",
"name": "iterations",
"parameterKind": "named",
"required": false,
"values": ["1000"
]
}
],
"submitTime": 1538172886000,
"threadingModel": "notSpecified",
"topologyUpdating": false,
"views": "https://host:port/streams/instances/{instanceId}/views"
}

Perform job action

This method provides the ability to perform job actions such as: setting PE tracing levels, starting PEs, and stopping PEs.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.

Request Body schema: application/json
required

type required	string Enum: "setPeTracingLevel" "startPes" "stopPes" Specifies the action to perform: setPeTracingLevel : Assigns the granularity of trace information stored for all PEs in the job. startPes : Starts the specified set of processing elements (PEs) if pes are specified, otherwise starts any stopped processing elements (PEs) in the job. stopPes : Stops the specified set of processing elements (PEs) if pes are specified, otherwise stops all of the processing elements (PEs) in the job.
pes	Array of strings Provides a list of target PE identifiers for the action. This property applies to the following action types: startPes, stopPes.
tracingLevel	string Enum: "debug" "error" "information" "off" "trace" "warning" Identifies the new PE trace granularity to set. This property applies to the following action types: setPeTracingLevel*. debug : Debug, informational, warning, and error messages are written to the trace file. error : Only error messages are written to the trace file. information : Informational, warning, and error messages are written to the trace file. off : No messages are written to the trace file. trace : Low-level trace, debug, informational, warning, and error messages are written to the trace file. warning : Warning and error messages are written to the trace file.

Responses

Request samples

Payload

Content type

application/json

{"Set PE tracing level example": {"type": "setPeTracingLevel",
"tracingLevel": "error"
},
"Start PEs example": {"type": "startPes",
"pes": ["0"
]
},
"Stop PEs example": {"type": "stopPes",
"pes": ["0"
]
}
}

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

Download application log and trace files

This method provides the ability to retrieve application log for a job.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.

Responses

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

Download job metrics snapshot

This method provides the ability to retrieve a metrics snapshot for a job.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"id": "0",
"pes": [{"indexWithinJob": 3,
"operators": [{"outputPorts": [ ],
"name": "ScalarsForward",
"inputPorts": [{"indexWithinOperator": 0,
"metrics": [{"name": "queueSize",
"value": 0
},
{"name": "nEnqueueWaits",
"value": 0
}
]
}
],
"metrics": [{"name": "relativeOperatorCost",
"value": 0
}
]
}
],
"lastTimeRetrieved": 1539106030000
}
]
}

Download job product log entries

This method provides ability to retrieve the product log entries associated with the job.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
endTime	integer <int64> Example: endTime=1487373013042 Specifies a time identifying which items to retrieve. Only items with a time before the specified time are returned. The unit of time is milliseconds since midnight Greenwich mean time (GMT) January 1, 1970. By default, all items are returned regardless of time.
startTime	integer <int64> Example: startTime=1487373013042 Specifies a time identifying which items to retrieve. Only items with a time after the specified time are returned. The unit of time is milliseconds since midnight Greenwich mean time (GMT) January 1, 1970. If the If-Modified-Since-Milliseconds header is also specified, the header value is ignored. By default, all items are returned regardless of time.

header Parameters

If-Modified-Since-Milliseconds

integer <int64>

Example: 1537301102922

Specifies a time identifying which items to retrieve. Only items with a time after the specified time are returned. The unit of time is milliseconds since midnight Greenwich mean time (GMT) January 1, 1970. To retrieve only items with a time after the last items returned, set this header value to the time that was returned by the Last-Modified-Milliseconds response header from the previous request.

Responses

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

Download job snapshot

This method provides access to a properties snapshot for a job and its child resources.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.

query Parameters

includeStatics

boolean

Example: includeStatics=false

Indicates whether static properties should be included in a snapshot. A static property is a property whose value does not change. If this parameter is not specified, static properties are included. Identifier properties are always included.

maximumDepth

integer <int64>

Example: maximumDepth=-1

Specifies which descendant object properties should be included in a snapshot. If this parameter is not specified, all descendant properties are included. Values are handled as follows:

less than zero - all descendant properties are included.
zero - no descendant properties are included.
one - only properties for immediate child objects are included.
greater than one - properties for descendants are included up to the level specified.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"adlFile": "notSpecified",
"applicationName": "myapps::app1",
"applicationPath": "toolkits/customMetrics",
"applicationScope": "default",
"applicationVersion": "1.0.0",
"checkpointPath": "/mypath/testapps/customMetrics/data/ckpt",
"dataPath": "/mydatapath",
"dynamicThreadingElastic": true,
"dynamicThreadingThreadCount": 2,
"fusionScheme": "automatic",
"generationId": 0,
"health": "healthy",
"id": "9",
"instance": "myinstance",
"jobGroup": "default",
"jobResourceSharing": "sameInstance",
"name": "Main_0",
"outputPath": "output",
"pes": [{"health": "healthy",
"id": "0",
"indexWithinJob": 0,
"inputPorts": [{"connections": [{"id": "o0p1i0p2",
"required": true,
"source": {"job": "9",
"outputPort": 0,
"pe": "0"
},
"status": "connected",
"target": {"inputPort": 0,
"job": "9",
"pe": "0"
}
}
],
"id": "1",
"indexWithinPE": 0,
"operatorInputPorts": [0
],
"transportType": "tcp"
}
],
"launchCount": 1,
"operators": [{"indexWithinJob": 2,
"inputPorts": [{"connections": [{"id": "o3r12j0i0r16j0",
"peConnection": "o0p5i0p10",
"source": {"job": null,
"operator": null,
"outputPort": null,
"pe": null
},
"target": {"inputPort": null,
"job": null,
"operator": null,
"pe": null
}
}
],
"import": {"applicationScope": "default",
"filter": "myfilter",
"operator": "ESource2",
"subscription": "rstring",
"type": "name"
},
"indexWithinOperator": 0,
"name": "fSource1",
"peInputPorts": [0
]
}
],
"name": "operatorName",
"operatorKind": "spl.utility::Beacon",
"outputPorts": [{"connections": [{"id": "o3r12j0i0r16j0",
"peConnection": "o0p5i0p10",
"source": {"job": null,
"operator": null,
"outputPort": null,
"pe": null
},
"target": {"inputPort": null,
"job": null,
"operator": null,
"pe": null
}
}
],
"export": {"filterAllowed": true,
"name": "fSource1",
"operator": "Source1",
"type": "name"
},
"indexWithinOperator": 0,
"name": "fSource1",
"peOutputPorts": [0
],
"streamViewable": true
}
]
}
],
"optionalConnections": "connected",
"outputPorts": [{"connections": [{"id": "o0p1i0p2",
"required": true,
"source": {"job": "9",
"outputPort": 0,
"pe": "0"
},
"status": "connected",
"target": {"inputPort": 0,
"job": "9",
"pe": "0"
}
}
],
"id": "1",
"indexWithinPE": 0,
"operatorOutputPorts": [0
],
"transportType": "tcp"
}
],
"processId": "1001",
"relocatable": true,
"requiredConnections": "conneted",
"resource": "app-9",
"resourceTags": ["application"
],
"restartable": true,
"status": "running",
"statusReason": "userRequest",
"traceLevel": "trace"
}
],
"productVersion": "5.0.0.0.20190814150153",
"proposedOperatorsPerResource": 34,
"resources": ["app-9"
],
"startedBy": "admin",
"status": "running",
"submitParameters": [{"composite": "application::AllDataTypes",
"defaultValue": "10000",
"name": "iterations",
"parameterKind": "named",
"required": false,
"values": ["1000"
]
}
],
"submitTime": 1538172886000,
"threadingModel": "notSpecified",
"topologyUpdating": false
}

Job - PEs

APIs for managing processing elements (PEs).

List PEs for instance

This collection resource provides access to information about the PEs that are running within the instance.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
job.restid	string Example: job.restid=0 Specifies the value of the restid property for a job resource. If this parameter is used, the list is limited to the resources for the specified job.
resource.restid	string Example: resource.restid=management-0 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 resources for the specified Streams instance resource.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/pes?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/pes?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/pes?count=10&page=3",
"pes": [{"applicationTrace": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/applicationtrace",
"connections": "https://host:port/streams/instances/{instanceId}/peconnections?pe.restid={peId}",
"consoleLog": "https://host:port/streams/instances/{instanceId}/pes/{peId}/consolelog",
"currentWorkingPath": "/mydir/myworkingdir",
"domain": "https://host:port/streams/domains/{domainId}",
"health": "healthy",
"host": "Deprecated: This property is deprecated and might become obsolete.",
"id": "0",
"indexWithinJob": 1,
"inputPorts": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/inputports/{portId}/peinputports",
"instance": "https://host:port/streams/instances/{instanceId}",
"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"launchCount": 1,
"metrics": "https://host:port/streams/instances/{instanceId}/resources/{resourceId}/metrics",
"metricsSnapshot": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/metrics",
"operators": "https://host:port/streams/instances/{instanceId}/operators",
"optionalConnections": "connected",
"osCapabilities": ["CAP_SETPCAP"
],
"outputPorts": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}/peoutputports",
"pendingTracingLevel": "error",
"processId": "1001",
"productLog": "https://host:port/streams/instances/{instanceId}/pes/{peId}/productlog",
"relocatable": true,
"requiredConnections": "connected",
"resource": "https://host:port/streams/instances/{instanceId}/resources/{resourceId}",
"resourceAllocation": "Deprecated: This property is deprecated and might become obsolete.",
"resourceTags": ["application"
],
"resourceType": "pe",
"restartPriority": "none",
"restartable": true,
"restid": "0",
"self": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"snapshot": "https://host:port/streams/instances/{instanceId}/pes/{peId}/snapshot",
"status": "running",
"statusReason": "userRequest",
"tracingLevel": "error"
}
],
"previous": "https://host:port/streams/instances/{instanceId}/pes?count=10&page=1",
"resourceType": "peList",
"total": 50
}

Get PE

This element resource provides access to information about a PE.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
peId required	string Example: 0 Specifies the unique identifier for the PE.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"applicationTrace": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/applicationtrace",
"connections": "https://host:port/streams/instances/{instanceId}/peconnections?pe.restid={peId}",
"consoleLog": "https://host:port/streams/instances/{instanceId}/pes/{peId}/consolelog",
"currentWorkingPath": "/mydir/myworkingdir",
"domain": "https://host:port/streams/domains/{domainId}",
"health": "healthy",
"host": "Deprecated: This property is deprecated and might become obsolete.",
"id": "0",
"indexWithinJob": 1,
"inputPorts": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/inputports/{portId}/peinputports",
"instance": "https://host:port/streams/instances/{instanceId}",
"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"launchCount": 1,
"metrics": "https://host:port/streams/instances/{instanceId}/resources/{resourceId}/metrics",
"metricsSnapshot": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/metrics",
"operators": "https://host:port/streams/instances/{instanceId}/operators",
"optionalConnections": "connected",
"osCapabilities": ["CAP_SETPCAP"
],
"outputPorts": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}/peoutputports",
"pendingTracingLevel": "error",
"processId": "1001",
"productLog": "https://host:port/streams/instances/{instanceId}/pes/{peId}/productlog",
"relocatable": true,
"requiredConnections": "connected",
"resource": "https://host:port/streams/instances/{instanceId}/resources/{resourceId}",
"resourceAllocation": "Deprecated: This property is deprecated and might become obsolete.",
"resourceTags": ["application"
],
"resourceType": "pe",
"restartPriority": "none",
"restartable": true,
"restid": "0",
"self": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"snapshot": "https://host:port/streams/instances/{instanceId}/pes/{peId}/snapshot",
"status": "running",
"statusReason": "userRequest",
"tracingLevel": "error"
}

Update PE

This method provides the ability to update PE properties.

Note:

Updating the tracingLevel property is an asynchronous operation so the response body might not include the updated value.
If your REST client does not support the PATCH method, you can use the POST method with the request header X-HTTP-Method-Override=PATCH specified.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
peId required	string Example: 0 Specifies the unique identifier for the PE.

Request Body schema: application/json
required

tracingLevel

string

Enum: "debug" "error" "information" "off" "trace" "warning"

Identifies the new PE trace granularity to set.

Responses

Request samples

Payload

Content type

application/json

{"tracingLevel": "debug"
}

Response samples

200
400
403
404
500

Content type

application/json

{"applicationTrace": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/applicationtrace",
"connections": "https://host:port/streams/instances/{instanceId}/peconnections?pe.restid={peId}",
"consoleLog": "https://host:port/streams/instances/{instanceId}/pes/{peId}/consolelog",
"currentWorkingPath": "/mydir/myworkingdir",
"domain": "https://host:port/streams/domains/{domainId}",
"health": "healthy",
"host": "Deprecated: This property is deprecated and might become obsolete.",
"id": "0",
"indexWithinJob": 1,
"inputPorts": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/inputports/{portId}/peinputports",
"instance": "https://host:port/streams/instances/{instanceId}",
"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"launchCount": 1,
"metrics": "https://host:port/streams/instances/{instanceId}/resources/{resourceId}/metrics",
"metricsSnapshot": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/metrics",
"operators": "https://host:port/streams/instances/{instanceId}/operators",
"optionalConnections": "connected",
"osCapabilities": ["CAP_SETPCAP"
],
"outputPorts": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}/peoutputports",
"pendingTracingLevel": "error",
"processId": "1001",
"productLog": "https://host:port/streams/instances/{instanceId}/pes/{peId}/productlog",
"relocatable": true,
"requiredConnections": "connected",
"resource": "https://host:port/streams/instances/{instanceId}/resources/{resourceId}",
"resourceAllocation": "Deprecated: This property is deprecated and might become obsolete.",
"resourceTags": ["application"
],
"resourceType": "pe",
"restartPriority": "none",
"restartable": true,
"restid": "0",
"self": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"snapshot": "https://host:port/streams/instances/{instanceId}/pes/{peId}/snapshot",
"status": "running",
"statusReason": "userRequest",
"tracingLevel": "error"
}

Perform PE action

This method provides the ability to perform PE actions such as: starting the PE, and stopping the PE.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
peId required	string Example: 0 Specifies the unique identifier for the PE.

Request Body schema: application/json
required

type

required

string

Enum: "start" "stop"

Specifies the action to perform:

start : Starts the PE.
stop : Stops the PE.

Responses

Request samples

Payload

Content type

application/json

{"type": "start"
}

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

Download PE trace file

This method provides the ability to retrieve the trace file for the PE.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
peId required	string Example: 0 Specifies the unique identifier for the PE.

Responses

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

Download PE console log

This method provides the ability to retrieve standard output and standard error log entries for the PE.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
peId required	string Example: 0 Specifies the unique identifier for the PE.

Responses

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

List PE metrics

This collection resource provides access to metrics for a PE.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
peId required	string Example: 0 Specifies the unique identifier for the PE.

query Parameters

fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=-1",
"metrics": [{"description": "metric description",
"lastTimeRetrieved": 1487373013042,
"metricKind": "gauge",
"metricType": "system",
"name": "nTuplesSubmitted",
"resourceType": "instance",
"value": 1234
}
],
"next": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=3",
"owner": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"previous": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"resourceType": "metricList",
"total": 50
}

Download PE metrics snapshot

This method provides access to a metrics snapshot for the PE.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
peId required	string Example: 0 Specifies the unique identifier for the PE.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"id": "0",
"pes": [{"indexWithinJob": 3,
"operators": [{"outputPorts": [ ],
"name": "ScalarsForward",
"inputPorts": [{"indexWithinOperator": 0,
"metrics": [{"name": "queueSize",
"value": 0
},
{"name": "nEnqueueWaits",
"value": 0
}
]
}
],
"metrics": [{"name": "relativeOperatorCost",
"value": 0
}
]
}
],
"lastTimeRetrieved": 1539106030000
}
]
}

Download PE product log entries

This method provides the ability to retrieve the product log entries associated with the PE.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
peId required	string Example: 0 Specifies the unique identifier for the PE.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
endTime	integer <int64> Example: endTime=1487373013042 Specifies a time identifying which items to retrieve. Only items with a time before the specified time are returned. The unit of time is milliseconds since midnight Greenwich mean time (GMT) January 1, 1970. By default, all items are returned regardless of time.
startTime	integer <int64> Example: startTime=1487373013042 Specifies a time identifying which items to retrieve. Only items with a time after the specified time are returned. The unit of time is milliseconds since midnight Greenwich mean time (GMT) January 1, 1970. If the If-Modified-Since-Milliseconds header is also specified, the header value is ignored. By default, all items are returned regardless of time.

header Parameters

If-Modified-Since-Milliseconds

integer <int64>

Example: 1537301102922

Specifies a time identifying which items to retrieve. Only items with a time after the specified time are returned. The unit of time is milliseconds since midnight Greenwich mean time (GMT) January 1, 1970. To retrieve only items with a time after the last items returned, set this header value to the time that was returned by the Last-Modified-Milliseconds response header from the previous request.

Responses

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

Download PE snapshot

This method provides access to a properties snapshot for a PE and its child resources.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
peId required	string Example: 0 Specifies the unique identifier for the PE.

query Parameters

includeStatics

boolean

Example: includeStatics=false

Indicates whether static properties should be included in a snapshot. A static property is a property whose value does not change. If this parameter is not specified, static properties are included. Identifier properties are always included.

maximumDepth

integer <int64>

Example: maximumDepth=-1

Specifies which descendant object properties should be included in a snapshot. If this parameter is not specified, all descendant properties are included. Values are handled as follows:

less than zero - all descendant properties are included.
zero - no descendant properties are included.
one - only properties for immediate child objects are included.
greater than one - properties for descendants are included up to the level specified.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"health": "healthy",
"id": "0",
"indexWithinJob": 0,
"inputPorts": [{"connections": [{"id": "o0p1i0p2",
"required": true,
"source": {"job": "9",
"outputPort": 0,
"pe": "0"
},
"status": "connected",
"target": {"inputPort": 0,
"job": "9",
"pe": "0"
}
}
],
"id": "1",
"indexWithinPE": 0,
"operatorInputPorts": [0
],
"transportType": "tcp"
}
],
"instance": "myinstance",
"job": "0",
"launchCount": 1,
"operators": [{"indexWithinJob": 2,
"inputPorts": [{"connections": [{"id": "o3r12j0i0r16j0",
"peConnection": "o0p5i0p10",
"source": {"job": "5",
"operator": "fSource2",
"outputPort": 0,
"pe": "5"
},
"target": {"inputPort": 0,
"job": "5",
"operator": "fSource2",
"pe": "5"
}
}
],
"import": {"applicationScope": "default",
"filter": "myfilter",
"operator": "ESource2",
"subscription": "rstring",
"type": "name"
},
"indexWithinOperator": 0,
"name": "fSource1",
"peInputPorts": [0
]
}
],
"name": "operatorName",
"operatorKind": "spl.utility::Beacon",
"outputPorts": [{"connections": [{"id": "o3r12j0i0r16j0",
"peConnection": "o0p5i0p10",
"source": {"job": "5",
"operator": "fSource2",
"outputPort": 0,
"pe": "5"
},
"target": {"inputPort": 0,
"job": "5",
"operator": "fSource2",
"pe": "5"
}
}
],
"export": {"filterAllowed": true,
"name": "fSource1",
"operator": "Source1",
"type": "name"
},
"indexWithinOperator": 0,
"name": "fSource1",
"peOutputPorts": [0
],
"streamViewable": true
}
]
}
],
"optionalConnections": "connected",
"outputPorts": [{"connections": [{"id": "o0p1i0p2",
"required": true,
"source": {"job": "9",
"outputPort": 0,
"pe": "0"
},
"status": "connected",
"target": {"inputPort": 0,
"job": "9",
"pe": "0"
}
}
],
"id": "1",
"indexWithinPE": 0,
"operatorOutputPorts": [0
],
"transportType": "tcp"
}
],
"processId": 1001,
"relocatable": true,
"requiredConnections": "conneted",
"resource": "app-9",
"resourceTags": ["application"
],
"restartable": true,
"status": "running",
"statusReason": "userRequest",
"traceLevel": "trace"
}

Job - PE ports

APIs for managing PE ports.

List PE input ports for an operator port

This collection resource provides access to information about the input ports for the PE for an operator input port

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.
operatorName required	string Example: sink Identifies the operator name.
portId required	string Example: 0 Specifies the unique identifier for the port.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
view.restid	string Example: view.restid=myInstance.Main_0.myView Specifies the value of the restid property for a view resource. If this parameter is used, the list is limited to the resources for the specified view.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/pes/{peId}/inputports?count=10&page=1",
"inputPorts": [{"connections": "https://host:port/streams/instances/{instanceId}/pes/{peId}/inputports/{portId}/peconnections",
"id": "0",
"indexWithinPE": 1,
"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"metrics": "https://host:port/streams/instances/{instanceId}/resources/{resourceId}/metrics",
"operatorInputPorts": "https://host:port/streams/instances/{instanceId}/pes/{peId}/inputports/{portId}/operatorinputports",
"pe": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"resourceType": "peInputPort",
"restid": "0",
"self": "https://host:port/streams/instances/{instanceId}/pes/{peId}/inputports/{portId}",
"transportType": "tcp"
}
],
"last": "https://host:port/streams/instances/{instanceId}/pes/{peId}/inputports?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/pes/{peId}/inputports?count=10&page=3",
"previous": "https://host:port/streams/instances/{instanceId}/pes/{peId}/inputports?count=10&page=1",
"resourceType": "peInputPortList",
"total": 50
}

List PE output ports for an operator port

This collection resource provides access to information about the output ports for the PE for an operator output port

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.
operatorName required	string Example: sink Identifies the operator name.
portId required	string Example: 0 Specifies the unique identifier for the port.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
view.restid	string Example: view.restid=myInstance.Main_0.myView Specifies the value of the restid property for a view resource. If this parameter is used, the list is limited to the resources for the specified view.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/pes/{peId}/outputports?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/pes/{peId}/outputports?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/pes/{peId}/outputports?count=10&page=3",
"outputPorts": [{"connections": "https://host:port/streams/instances/{instanceId}/pes/{peId}/outputports/{portId}/peconnections",
"id": "1",
"indexWithinPE": 1,
"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"metrics": "https://host:port/streams/instances/{instanceId}/resources/{resourceId}/metrics",
"operatorOutputPorts": "https://host:port/streams/instances/{instanceId}/pes/{peId}/outputports/{portId}/operatoroutputports",
"pe": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"resourceType": "peOutputPort",
"restid": "1",
"self": "https://host:port/streams/instances/{instanceId}/pes/{peId}/outputports/{portId}",
"transportType": "tcp"
}
],
"previous": "https://host:port/streams/instances/{instanceId}/pes/{peId}/outputports?count=10&page=1",
"resourceType": "peOutputPortList",
"total": 50
}

List PE input ports

This collection resource provides access to information about the input ports for the PE.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
peId required	string Example: 0 Specifies the unique identifier for the PE.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/pes/{peId}/inputports?count=10&page=1",
"inputPorts": [{"connections": "https://host:port/streams/instances/{instanceId}/pes/{peId}/inputports/{portId}/peconnections",
"id": "0",
"indexWithinPE": 1,
"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"metrics": "https://host:port/streams/instances/{instanceId}/resources/{resourceId}/metrics",
"operatorInputPorts": "https://host:port/streams/instances/{instanceId}/pes/{peId}/inputports/{portId}/operatorinputports",
"pe": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"resourceType": "peInputPort",
"restid": "0",
"self": "https://host:port/streams/instances/{instanceId}/pes/{peId}/inputports/{portId}",
"transportType": "tcp"
}
],
"last": "https://host:port/streams/instances/{instanceId}/pes/{peId}/inputports?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/pes/{peId}/inputports?count=10&page=3",
"previous": "https://host:port/streams/instances/{instanceId}/pes/{peId}/inputports?count=10&page=1",
"resourceType": "peInputPortList",
"total": 50
}

Get PE input port

This element resource provides access to information about an input port for a specific PE.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
peId required	string Example: 0 Specifies the unique identifier for the PE.
portId required	string Example: 0 Specifies the unique identifier for the port.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"connections": "https://host:port/streams/instances/{instanceId}/pes/{peId}/inputports/{portId}/peconnections",
"id": "0",
"indexWithinPE": 1,
"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"metrics": "https://host:port/streams/instances/{instanceId}/resources/{resourceId}/metrics",
"operatorInputPorts": "https://host:port/streams/instances/{instanceId}/pes/{peId}/inputports/{portId}/operatorinputports",
"pe": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"resourceType": "peInputPort",
"restid": "0",
"self": "https://host:port/streams/instances/{instanceId}/pes/{peId}/inputports/{portId}",
"transportType": "tcp"
}

List PE input port metrics

This collection resource provides access to metrics for a PE input port.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
peId required	string Example: 0 Specifies the unique identifier for the PE.
portId required	string Example: 0 Specifies the unique identifier for the port.

query Parameters

fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=-1",
"metrics": [{"description": "metric description",
"lastTimeRetrieved": 1487373013042,
"metricKind": "gauge",
"metricType": "system",
"name": "nTuplesSubmitted",
"resourceType": "instance",
"value": 1234
}
],
"next": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=3",
"owner": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"previous": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"resourceType": "metricList",
"total": 50
}

List operator input ports for a PE port

This collection resource provides access to information about the input ports for the operator for a PE input port.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
peId required	string Example: 0 Specifies the unique identifier for the PE.
portId required	string Example: 0 Specifies the unique identifier for the port.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/operators/{operatorName}/inputports?count=10&page=1",
"inputPorts": [{"connections": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorId}/inputports/{portId}/operatorconnections",
"import": {"applicationScope": "default",
"filter": "myfilter",
"names": [{"applicationScope": "default",
"name": "mystream",
"operator": "operator1"
}
],
"operator": "myoperator",
"subscription": "rstring",
"type": "name"
},
"indexWithinOperator": 1,
"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"metrics": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/inputports/{portId}/metrics",
"name": "Scalars",
"operator": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}",
"pe": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"peInputPorts": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/inputports/{portId}/peinputports",
"resourceType": "operatorInputPort",
"restid": "1",
"self": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/inputports/{portId}"
}
],
"last": "https://host:port/streams/instances/{instanceId}/operators/{operatorName}/inputports?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/operators/{operatorName}/inputports?count=10&page=3",
"previous": "https://host:port/streams/instances/{instanceId}/operators/{operatorName}/inputports?count=10&page=1",
"resourceType": "operatorInputPortList",
"total": 50
}

List PE output ports

This collection resource provides access to information about the output ports for the PE.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
peId required	string Example: 0 Specifies the unique identifier for the PE.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/pes/{peId}/outputports?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/pes/{peId}/outputports?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/pes/{peId}/outputports?count=10&page=3",
"outputPorts": [{"connections": "https://host:port/streams/instances/{instanceId}/pes/{peId}/outputports/{portId}/peconnections",
"id": "1",
"indexWithinPE": 1,
"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"metrics": "https://host:port/streams/instances/{instanceId}/resources/{resourceId}/metrics",
"operatorOutputPorts": "https://host:port/streams/instances/{instanceId}/pes/{peId}/outputports/{portId}/operatoroutputports",
"pe": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"resourceType": "peOutputPort",
"restid": "1",
"self": "https://host:port/streams/instances/{instanceId}/pes/{peId}/outputports/{portId}",
"transportType": "tcp"
}
],
"previous": "https://host:port/streams/instances/{instanceId}/pes/{peId}/outputports?count=10&page=1",
"resourceType": "peOutputPortList",
"total": 50
}

Get PE output port

This element resource provides access to information about an output port for a specific PE.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
peId required	string Example: 0 Specifies the unique identifier for the PE.
portId required	string Example: 0 Specifies the unique identifier for the port.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"connections": "https://host:port/streams/instances/{instanceId}/pes/{peId}/outputports/{portId}/peconnections",
"id": "1",
"indexWithinPE": 1,
"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"metrics": "https://host:port/streams/instances/{instanceId}/resources/{resourceId}/metrics",
"operatorOutputPorts": "https://host:port/streams/instances/{instanceId}/pes/{peId}/outputports/{portId}/operatoroutputports",
"pe": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"resourceType": "peOutputPort",
"restid": "1",
"self": "https://host:port/streams/instances/{instanceId}/pes/{peId}/outputports/{portId}",
"transportType": "tcp"
}

List PE output port metrics

This collection resource provides access to metrics for a PE output port.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
peId required	string Example: 0 Specifies the unique identifier for the PE.
portId required	string Example: 0 Specifies the unique identifier for the port.

query Parameters

fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=-1",
"metrics": [{"description": "metric description",
"lastTimeRetrieved": 1487373013042,
"metricKind": "gauge",
"metricType": "system",
"name": "nTuplesSubmitted",
"resourceType": "instance",
"value": 1234
}
],
"next": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=3",
"owner": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"previous": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"resourceType": "metricList",
"total": 50
}

List operator output ports for a PE port

This collection resource provides access to information about the output ports for the operator for a PE output port.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
peId required	string Example: 0 Specifies the unique identifier for the PE.
portId required	string Example: 0 Specifies the unique identifier for the port.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/operators/{operatorName}/outputports?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/operators/{operatorName}/outputports?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/operators/{operatorName}/outputports?count=10&page=3",
"outputPorts": [{"connections": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}/operatorconnections",
"exceptionPort": false,
"export": {"filterAllowed": true,
"name": "myExportName",
"operator": "myOperatorName",
"properties": [{"name": "mypropname",
"type": "rstring",
"values": ["mypropvalue"
]
}
],
"type": "name"
},
"indexWithinOperator": 1,
"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"metrics": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}/metrics",
"name": "Stream2",
"operator": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}",
"pe": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"peOutputPorts": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}/peoutputports",
"resourceType": "operatorOutputPort",
"restid": "1",
"self": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}",
"streamName": "tradeQuote",
"streamViewable": true,
"tupleAttributes": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}/tupleattributes"
}
],
"previous": "https://host:port/streams/instances/{instanceId}/operators/{operatorName}/outputports?count=10&page=1",
"resourceType": "operatorOutputPortList",
"total": 50
}

Job - PE connections

APIs for managing PE connections.

List PE connections for the instance

This collection resource provides access to information about the connections for the instance.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
job.restid	string Example: job.restid=0 Specifies the value of the restid property for a job resource. If this parameter is used, the list is limited to the resources for the specified job.
pe.restid	string Example: pe.restid=0 Specifies the value of the restid property for a PE resource. If this parameter is used, the list is limited to the resources for the specified PE.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"connections": [{"id": "o0p1i0p2",
"metrics": "https://host:port/streams/instances/{instanceId}/resources/{resourceId}/metrics",
"required": true,
"resourceType": "peConnection",
"restid": "o0p1i0p2",
"self": "https://host:port/streams/instances/{instanceId}/pes/{peId}/peconnections/{connectionId}",
"source": {"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"outputPort": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}",
"pe": "https://host:port/streams/instances/{instanceId/pes/{peId}"
},
"status": "connected",
"target": {"inputPort": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/inputports/{portId}",
"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"pe": "https://host:port/streams/instances/{instanceId}/pes/{peId}"
}
}
],
"first": "https://host:port/streams/instances/{instanceId}/peconnections?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/peconnections?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/peconnections?count=10&page=3",
"previous": "https://host:port/streams/instances/{instanceId}/peconnections?count=10&page=1",
"resourceType": "peConnectionList",
"total": 50
}

Get PE connection

This element resource provides access to information about a connection between two processing element (PE) ports.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
connectionId required	string Example: o0p0i0p1 Specifies the unique identifier for the connection.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"id": "o0p1i0p2",
"metrics": "https://host:port/streams/instances/{instanceId}/resources/{resourceId}/metrics",
"required": true,
"resourceType": "peConnection",
"restid": "o0p1i0p2",
"self": "https://host:port/streams/instances/{instanceId}/pes/{peId}/peconnections/{connectionId}",
"source": {"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"outputPort": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}",
"pe": "https://host:port/streams/instances/{instanceId/pes/{peId}"
},
"status": "connected",
"target": {"inputPort": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/inputports/{portId}",
"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"pe": "https://host:port/streams/instances/{instanceId}/pes/{peId}"
}
}

List PE connection metrics

This collection resource provides access to metrics for a PE connection.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
connectionId required	string Example: o0p0i0p1 Specifies the unique identifier for the connection.

query Parameters

fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=-1",
"metrics": [{"description": "metric description",
"lastTimeRetrieved": 1487373013042,
"metricKind": "gauge",
"metricType": "system",
"name": "nTuplesSubmitted",
"resourceType": "instance",
"value": 1234
}
],
"next": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=3",
"owner": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"previous": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"resourceType": "metricList",
"total": 50
}

List PE connections for a PE input port

This collection resource provides access to information about the connections for a PE input port.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
peId required	string Example: 0 Specifies the unique identifier for the PE.
portId required	string Example: 0 Specifies the unique identifier for the port.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"connections": [{"id": "o0p1i0p2",
"metrics": "https://host:port/streams/instances/{instanceId}/resources/{resourceId}/metrics",
"required": true,
"resourceType": "peConnection",
"restid": "o0p1i0p2",
"self": "https://host:port/streams/instances/{instanceId}/pes/{peId}/peconnections/{connectionId}",
"source": {"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"outputPort": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}",
"pe": "https://host:port/streams/instances/{instanceId/pes/{peId}"
},
"status": "connected",
"target": {"inputPort": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/inputports/{portId}",
"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"pe": "https://host:port/streams/instances/{instanceId}/pes/{peId}"
}
}
],
"first": "https://host:port/streams/instances/{instanceId}/peconnections?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/peconnections?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/peconnections?count=10&page=3",
"previous": "https://host:port/streams/instances/{instanceId}/peconnections?count=10&page=1",
"resourceType": "peConnectionList",
"total": 50
}

List PE connections for a PE output port

This collection resource provides access to information about the connections for a PE output port.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
peId required	string Example: 0 Specifies the unique identifier for the PE.
portId required	string Example: 0 Specifies the unique identifier for the port.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"connections": [{"id": "o0p1i0p2",
"metrics": "https://host:port/streams/instances/{instanceId}/resources/{resourceId}/metrics",
"required": true,
"resourceType": "peConnection",
"restid": "o0p1i0p2",
"self": "https://host:port/streams/instances/{instanceId}/pes/{peId}/peconnections/{connectionId}",
"source": {"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"outputPort": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}",
"pe": "https://host:port/streams/instances/{instanceId/pes/{peId}"
},
"status": "connected",
"target": {"inputPort": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/inputports/{portId}",
"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"pe": "https://host:port/streams/instances/{instanceId}/pes/{peId}"
}
}
],
"first": "https://host:port/streams/instances/{instanceId}/peconnections?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/peconnections?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/peconnections?count=10&page=3",
"previous": "https://host:port/streams/instances/{instanceId}/peconnections?count=10&page=1",
"resourceType": "peConnectionList",
"total": 50
}

Job - Operators

APIs for managing operators.

Get operator

This element resource provides access to information about a specific operator in a job.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.
operatorName required	string Example: sink Identifies the operator name.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"applicationTrace": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/applicationtrace",
"channel": 1,
"channels": [{"indexWithinRegion": 1,
"logicalOperatorName": "operatorName"
}
],
"connections": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/operatorconnections",
"domain": "https://host:port/streams/domains/{domainId}",
"exceptionPorts": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports?exceptionPorts=true",
"host": "Deprecated: This property is deprecated and might become obsolete.",
"indexWithinJob": 1,
"inputPorts": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/inputports",
"instance": "https://host:port/streams/instances/{instanceId}",
"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"logicalName": "logicalName",
"metrics": "https://host:port/streams/instances/{instanceId}/resources/{resourceId}/metrics",
"name": "operatorName",
"operatorKind": "spl.utility::Beacon",
"outputPorts": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports",
"pe": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"productLog": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/productlog",
"resource": "https://host:port/streams/instances/{instanceId}/resources/{resourceId}",
"resourceAllocation": "Deprecated: This property is deprecated and might become obsolete.",
"resourceType": "operator",
"restid": "operatorName",
"self": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}"
}

Download operator trace entries

This method provides the ability to retrieve the PE trace file entries associated with the operator.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.
operatorName required	string Example: sink Identifies the operator name.

Responses

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

List operator metrics

This collection resource provides access to metrics for an operator.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.
operatorName required	string Example: sink Identifies the operator name.

query Parameters

fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=-1",
"metrics": [{"description": "metric description",
"lastTimeRetrieved": 1487373013042,
"metricKind": "gauge",
"metricType": "system",
"name": "nTuplesSubmitted",
"resourceType": "instance",
"value": 1234
}
],
"next": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=3",
"owner": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"previous": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"resourceType": "metricList",
"total": 50
}

Download operator product log entries

This method provides the ability to retrieve the product log entries associated with the operator.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.
operatorName required	string Example: sink Identifies the operator name.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
endTime	integer <int64> Example: endTime=1487373013042 Specifies a time identifying which items to retrieve. Only items with a time before the specified time are returned. The unit of time is milliseconds since midnight Greenwich mean time (GMT) January 1, 1970. By default, all items are returned regardless of time.
startTime	integer <int64> Example: startTime=1487373013042 Specifies a time identifying which items to retrieve. Only items with a time after the specified time are returned. The unit of time is milliseconds since midnight Greenwich mean time (GMT) January 1, 1970. If the If-Modified-Since-Milliseconds header is also specified, the header value is ignored. By default, all items are returned regardless of time.

header Parameters

If-Modified-Since-Milliseconds

integer <int64>

Example: 1537301102922

Specifies a time identifying which items to retrieve. Only items with a time after the specified time are returned. The unit of time is milliseconds since midnight Greenwich mean time (GMT) January 1, 1970. To retrieve only items with a time after the last items returned, set this header value to the time that was returned by the Last-Modified-Milliseconds response header from the previous request.

Responses

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

List operators for the instance

This collection resource provides access to information about the operators in the instance.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
job.restid	string Example: job.restid=0 Specifies the value of the restid property for a job resource. If this parameter is used, the list is limited to the resources for the specified job.
pe.restid	string Example: pe.restid=0 Specifies the value of the restid property for a PE resource. If this parameter is used, the list is limited to the resources for the specified PE.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/operators?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/operators?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/operators?count=10&page=3",
"operators": [{"applicationTrace": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/applicationtrace",
"channel": 1,
"channels": [{"indexWithinRegion": 1,
"logicalOperatorName": "operatorName"
}
],
"connections": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/operatorconnections",
"domain": "https://host:port/streams/domains/{domainId}",
"exceptionPorts": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports?exceptionPorts=true",
"host": "Deprecated: This property is deprecated and might become obsolete.",
"indexWithinJob": 1,
"inputPorts": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/inputports",
"instance": "https://host:port/streams/instances/{instanceId}",
"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"logicalName": "logicalName",
"metrics": "https://host:port/streams/instances/{instanceId}/resources/{resourceId}/metrics",
"name": "operatorName",
"operatorKind": "spl.utility::Beacon",
"outputPorts": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports",
"pe": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"productLog": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/productlog",
"resource": "https://host:port/streams/instances/{instanceId}/resources/{resourceId}",
"resourceAllocation": "Deprecated: This property is deprecated and might become obsolete.",
"resourceType": "operator",
"restid": "operatorName",
"self": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}"
}
],
"previous": "https://host:port/streams/instances/{instanceId}/operators?count=10&page=1",
"resourceType": "operatorList",
"total": 50
}

Job - Operator ports

APIs for managing operator ports.

List operator input ports

This collection resource provides access to information about the input ports for the operator.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.
operatorName required	string Example: sink Identifies the operator name.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/operators/{operatorName}/inputports?count=10&page=1",
"inputPorts": [{"connections": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorId}/inputports/{portId}/operatorconnections",
"import": {"applicationScope": "default",
"filter": "myfilter",
"names": [{"applicationScope": "default",
"name": "mystream",
"operator": "operator1"
}
],
"operator": "myoperator",
"subscription": "rstring",
"type": "name"
},
"indexWithinOperator": 1,
"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"metrics": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/inputports/{portId}/metrics",
"name": "Scalars",
"operator": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}",
"pe": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"peInputPorts": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/inputports/{portId}/peinputports",
"resourceType": "operatorInputPort",
"restid": "1",
"self": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/inputports/{portId}"
}
],
"last": "https://host:port/streams/instances/{instanceId}/operators/{operatorName}/inputports?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/operators/{operatorName}/inputports?count=10&page=3",
"previous": "https://host:port/streams/instances/{instanceId}/operators/{operatorName}/inputports?count=10&page=1",
"resourceType": "operatorInputPortList",
"total": 50
}

Get operator input port

This element resource provides access to information about an input port for a specific operator.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.
operatorName required	string Example: sink Identifies the operator name.
portId required	string Example: 0 Specifies the unique identifier for the port.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"connections": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorId}/inputports/{portId}/operatorconnections",
"import": {"applicationScope": "default",
"filter": "myfilter",
"names": [{"applicationScope": "default",
"name": "mystream",
"operator": "operator1"
}
],
"operator": "myoperator",
"subscription": "rstring",
"type": "name"
},
"indexWithinOperator": 1,
"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"metrics": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/inputports/{portId}/metrics",
"name": "Scalars",
"operator": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}",
"pe": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"peInputPorts": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/inputports/{portId}/peinputports",
"resourceType": "operatorInputPort",
"restid": "1",
"self": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/inputports/{portId}"
}

List operator input port metrics

This collection resource provides access to metrics for an operator input port.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.
operatorName required	string Example: sink Identifies the operator name.
portId required	string Example: 0 Specifies the unique identifier for the port.

query Parameters

fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=-1",
"metrics": [{"description": "metric description",
"lastTimeRetrieved": 1487373013042,
"metricKind": "gauge",
"metricType": "system",
"name": "nTuplesSubmitted",
"resourceType": "instance",
"value": 1234
}
],
"next": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=3",
"owner": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"previous": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"resourceType": "metricList",
"total": 50
}

List PE input ports for an operator port

This collection resource provides access to information about the input ports for the PE for an operator input port

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.
operatorName required	string Example: sink Identifies the operator name.
portId required	string Example: 0 Specifies the unique identifier for the port.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
view.restid	string Example: view.restid=myInstance.Main_0.myView Specifies the value of the restid property for a view resource. If this parameter is used, the list is limited to the resources for the specified view.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/pes/{peId}/inputports?count=10&page=1",
"inputPorts": [{"connections": "https://host:port/streams/instances/{instanceId}/pes/{peId}/inputports/{portId}/peconnections",
"id": "0",
"indexWithinPE": 1,
"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"metrics": "https://host:port/streams/instances/{instanceId}/resources/{resourceId}/metrics",
"operatorInputPorts": "https://host:port/streams/instances/{instanceId}/pes/{peId}/inputports/{portId}/operatorinputports",
"pe": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"resourceType": "peInputPort",
"restid": "0",
"self": "https://host:port/streams/instances/{instanceId}/pes/{peId}/inputports/{portId}",
"transportType": "tcp"
}
],
"last": "https://host:port/streams/instances/{instanceId}/pes/{peId}/inputports?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/pes/{peId}/inputports?count=10&page=3",
"previous": "https://host:port/streams/instances/{instanceId}/pes/{peId}/inputports?count=10&page=1",
"resourceType": "peInputPortList",
"total": 50
}

List operator output ports

This collection resource provides access to information about the output ports for the operator.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.
operatorName required	string Example: sink Identifies the operator name.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
view.restid	string Example: view.restid=myInstance.Main_0.myView Specifies the value of the restid property for a view resource. If this parameter is used, the list is limited to the resources for the specified view.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/operators/{operatorName}/outputports?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/operators/{operatorName}/outputports?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/operators/{operatorName}/outputports?count=10&page=3",
"outputPorts": [{"connections": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}/operatorconnections",
"exceptionPort": false,
"export": {"filterAllowed": true,
"name": "myExportName",
"operator": "myOperatorName",
"properties": [{"name": "mypropname",
"type": "rstring",
"values": ["mypropvalue"
]
}
],
"type": "name"
},
"indexWithinOperator": 1,
"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"metrics": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}/metrics",
"name": "Stream2",
"operator": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}",
"pe": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"peOutputPorts": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}/peoutputports",
"resourceType": "operatorOutputPort",
"restid": "1",
"self": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}",
"streamName": "tradeQuote",
"streamViewable": true,
"tupleAttributes": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}/tupleattributes"
}
],
"previous": "https://host:port/streams/instances/{instanceId}/operators/{operatorName}/outputports?count=10&page=1",
"resourceType": "operatorOutputPortList",
"total": 50
}

Get operator output port

This element resource provides access to information about an output port for a specific operator.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.
operatorName required	string Example: sink Identifies the operator name.
portId required	string Example: 0 Specifies the unique identifier for the port.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"connections": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}/operatorconnections",
"exceptionPort": false,
"export": {"filterAllowed": true,
"name": "myExportName",
"operator": "myOperatorName",
"properties": [{"name": "mypropname",
"type": "rstring",
"values": ["mypropvalue"
]
}
],
"type": "name"
},
"indexWithinOperator": 1,
"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"metrics": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}/metrics",
"name": "Stream2",
"operator": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}",
"pe": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"peOutputPorts": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}/peoutputports",
"resourceType": "operatorOutputPort",
"restid": "1",
"self": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}",
"streamName": "tradeQuote",
"streamViewable": true,
"tupleAttributes": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}/tupleattributes"
}

List operator output port metrics

This collection resource provides access to metrics for an operator output port.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.
operatorName required	string Example: sink Identifies the operator name.
portId required	string Example: 0 Specifies the unique identifier for the port.

query Parameters

fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=-1",
"metrics": [{"description": "metric description",
"lastTimeRetrieved": 1487373013042,
"metricKind": "gauge",
"metricType": "system",
"name": "nTuplesSubmitted",
"resourceType": "instance",
"value": 1234
}
],
"next": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=3",
"owner": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"previous": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"resourceType": "metricList",
"total": 50
}

List PE output ports for an operator port

This collection resource provides access to information about the output ports for the PE for an operator output port

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.
operatorName required	string Example: sink Identifies the operator name.
portId required	string Example: 0 Specifies the unique identifier for the port.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
view.restid	string Example: view.restid=myInstance.Main_0.myView Specifies the value of the restid property for a view resource. If this parameter is used, the list is limited to the resources for the specified view.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/pes/{peId}/outputports?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/pes/{peId}/outputports?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/pes/{peId}/outputports?count=10&page=3",
"outputPorts": [{"connections": "https://host:port/streams/instances/{instanceId}/pes/{peId}/outputports/{portId}/peconnections",
"id": "1",
"indexWithinPE": 1,
"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"metrics": "https://host:port/streams/instances/{instanceId}/resources/{resourceId}/metrics",
"operatorOutputPorts": "https://host:port/streams/instances/{instanceId}/pes/{peId}/outputports/{portId}/operatoroutputports",
"pe": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"resourceType": "peOutputPort",
"restid": "1",
"self": "https://host:port/streams/instances/{instanceId}/pes/{peId}/outputports/{portId}",
"transportType": "tcp"
}
],
"previous": "https://host:port/streams/instances/{instanceId}/pes/{peId}/outputports?count=10&page=1",
"resourceType": "peOutputPortList",
"total": 50
}

List tuple attributes

This collection resource provides access to the tuple attributes for the stream associated with an operator output port

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.
operatorName required	string Example: sink Identifies the operator name.
portId required	string Example: 0 Specifies the unique identifier for the port.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}/tupleattributes?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}/tupleattributes?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}/tupleattributes?count=10&page=3",
"previous": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}/tupleattributes?count=10&page=1",
"resourceType": "tupleAttributeList",
"total": 50,
"tupleAttributes": [{"boundedSize": 64,
"elementType": {"boundedSize": 64,
"elementType": { },
"keyType": { },
"possibleValues": ["warning"
],
"schemaUri": "https://host:port/myschemas/schema",
"tupleAttributes": [{ }
],
"type": "int64",
"underlyingType": { },
"valueType": { }
},
"keyType": {"boundedSize": 64,
"elementType": { },
"keyType": { },
"possibleValues": ["warning"
],
"schemaUri": "https://host:port/myschemas/schema",
"tupleAttributes": [{ }
],
"type": "int64",
"underlyingType": { },
"valueType": { }
},
"name": "unsignedint128kList",
"possibleValues": ["warning"
],
"schemaUri": "https://host:port/myschemas/schema",
"splType": "list<uint32>[32768]",
"tupleAttributes": [{"boundedSize": 64,
"elementType": {"boundedSize": 64,
"elementType": { },
"keyType": { },
"possibleValues": ["warning"
],
"schemaUri": "https://host:port/myschemas/schema",
"tupleAttributes": [{ }
],
"type": "int64",
"underlyingType": { },
"valueType": { }
},
"keyType": {"boundedSize": 64,
"elementType": { },
"keyType": { },
"possibleValues": ["warning"
],
"schemaUri": "https://host:port/myschemas/schema",
"tupleAttributes": [{ }
],
"type": "int64",
"underlyingType": { },
"valueType": { }
},
"name": "unsignedint128kList",
"possibleValues": ["warning"
],
"schemaUri": "https://host:port/myschemas/schema",
"splType": "list<uint32>[32768]",
"tupleAttributes": [{ }
],
"type": "int64",
"underlyingType": {"boundedSize": 64,
"elementType": { },
"keyType": { },
"possibleValues": ["warning"
],
"schemaUri": "https://host:port/myschemas/schema",
"tupleAttributes": [{ }
],
"type": "int64",
"underlyingType": { },
"valueType": { }
},
"valueType": {"boundedSize": 64,
"elementType": { },
"keyType": { },
"possibleValues": ["warning"
],
"schemaUri": "https://host:port/myschemas/schema",
"tupleAttributes": [{ }
],
"type": "int64",
"underlyingType": { },
"valueType": { }
}
}
],
"type": "int64",
"underlyingType": {"boundedSize": 64,
"elementType": { },
"keyType": { },
"possibleValues": ["warning"
],
"schemaUri": "https://host:port/myschemas/schema",
"tupleAttributes": [{ }
],
"type": "int64",
"underlyingType": { },
"valueType": { }
},
"valueType": {"boundedSize": 64,
"elementType": { },
"keyType": { },
"possibleValues": ["warning"
],
"schemaUri": "https://host:port/myschemas/schema",
"tupleAttributes": [{ }
],
"type": "int64",
"underlyingType": { },
"valueType": { }
}
}
]
}

List operator input ports for a PE port

This collection resource provides access to information about the input ports for the operator for a PE input port.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
peId required	string Example: 0 Specifies the unique identifier for the PE.
portId required	string Example: 0 Specifies the unique identifier for the port.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/operators/{operatorName}/inputports?count=10&page=1",
"inputPorts": [{"connections": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorId}/inputports/{portId}/operatorconnections",
"import": {"applicationScope": "default",
"filter": "myfilter",
"names": [{"applicationScope": "default",
"name": "mystream",
"operator": "operator1"
}
],
"operator": "myoperator",
"subscription": "rstring",
"type": "name"
},
"indexWithinOperator": 1,
"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"metrics": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/inputports/{portId}/metrics",
"name": "Scalars",
"operator": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}",
"pe": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"peInputPorts": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/inputports/{portId}/peinputports",
"resourceType": "operatorInputPort",
"restid": "1",
"self": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/inputports/{portId}"
}
],
"last": "https://host:port/streams/instances/{instanceId}/operators/{operatorName}/inputports?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/operators/{operatorName}/inputports?count=10&page=3",
"previous": "https://host:port/streams/instances/{instanceId}/operators/{operatorName}/inputports?count=10&page=1",
"resourceType": "operatorInputPortList",
"total": 50
}

List operator output ports for a PE port

This collection resource provides access to information about the output ports for the operator for a PE output port.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
peId required	string Example: 0 Specifies the unique identifier for the PE.
portId required	string Example: 0 Specifies the unique identifier for the port.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/operators/{operatorName}/outputports?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/operators/{operatorName}/outputports?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/operators/{operatorName}/outputports?count=10&page=3",
"outputPorts": [{"connections": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}/operatorconnections",
"exceptionPort": false,
"export": {"filterAllowed": true,
"name": "myExportName",
"operator": "myOperatorName",
"properties": [{"name": "mypropname",
"type": "rstring",
"values": ["mypropvalue"
]
}
],
"type": "name"
},
"indexWithinOperator": 1,
"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"metrics": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}/metrics",
"name": "Stream2",
"operator": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}",
"pe": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"peOutputPorts": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}/peoutputports",
"resourceType": "operatorOutputPort",
"restid": "1",
"self": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}",
"streamName": "tradeQuote",
"streamViewable": true,
"tupleAttributes": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}/tupleattributes"
}
],
"previous": "https://host:port/streams/instances/{instanceId}/operators/{operatorName}/outputports?count=10&page=1",
"resourceType": "operatorOutputPortList",
"total": 50
}

Job - Operator connections

APIs for managing operator connections.

List operator connections for an operator input port

This collection resource provides access to information about the operator connections for an operator input port.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.
operatorName required	string Example: sink Identifies the operator name.
portId required	string Example: 0 Specifies the unique identifier for the port.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
job.restid	string Example: job.restid=0 Specifies the value of the restid property for a job resource. If this parameter is used, the list is limited to the resources for the specified job.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"connections": [{"id": "o3r12j0i0r16j0",
"peConnection": "https://host:port/streams/instances/{instanceId}/peconnections/{connectionId}",
"required": true,
"resourceType": "operatorConnection",
"restid": "o0r3j2i0r4j2",
"self": "https://host:port/streams/instances/{instanceId}/operatorconnections/{connectionId}",
"source": {"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"operator": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}",
"outputPort": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}",
"pe": "https://host:port/streams/instances/{instanceId/pes/{peId}"
},
"target": {"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"inputPort": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/inputports/{portId}",
"operator": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}",
"pe": "https://host:port/streams/instances/{instanceId}/pes/{peId}"
}
}
],
"first": "https://host:port/streams/instances/{instanceId}/operatorconnections?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/operatorconnections?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/operatorconnections?count=10&page=1",
"previous": "https://host:port/streams/instances/{instanceId}/operatorconnections?count=10&page=1",
"resourceType": "operatorConnectionList",
"total": 50
}

List operator connections for an operator

This collection resource provides access to information about the operator connections for an operator.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.
operatorName required	string Example: sink Identifies the operator name.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"connections": [{"id": "o3r12j0i0r16j0",
"peConnection": "https://host:port/streams/instances/{instanceId}/peconnections/{connectionId}",
"required": true,
"resourceType": "operatorConnection",
"restid": "o0r3j2i0r4j2",
"self": "https://host:port/streams/instances/{instanceId}/operatorconnections/{connectionId}",
"source": {"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"operator": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}",
"outputPort": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}",
"pe": "https://host:port/streams/instances/{instanceId/pes/{peId}"
},
"target": {"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"inputPort": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/inputports/{portId}",
"operator": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}",
"pe": "https://host:port/streams/instances/{instanceId}/pes/{peId}"
}
}
],
"first": "https://host:port/streams/instances/{instanceId}/operatorconnections?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/operatorconnections?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/operatorconnections?count=10&page=1",
"previous": "https://host:port/streams/instances/{instanceId}/operatorconnections?count=10&page=1",
"resourceType": "operatorConnectionList",
"total": 50
}

List operator connections for an operator output port

This collection resource provides access to information about the operator connections for an operator output port.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.
operatorName required	string Example: sink Identifies the operator name.
portId required	string Example: 0 Specifies the unique identifier for the port.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
job.restid	string Example: job.restid=0 Specifies the value of the restid property for a job resource. If this parameter is used, the list is limited to the resources for the specified job.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"connections": [{"id": "o3r12j0i0r16j0",
"peConnection": "https://host:port/streams/instances/{instanceId}/peconnections/{connectionId}",
"required": true,
"resourceType": "operatorConnection",
"restid": "o0r3j2i0r4j2",
"self": "https://host:port/streams/instances/{instanceId}/operatorconnections/{connectionId}",
"source": {"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"operator": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}",
"outputPort": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}",
"pe": "https://host:port/streams/instances/{instanceId/pes/{peId}"
},
"target": {"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"inputPort": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/inputports/{portId}",
"operator": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}",
"pe": "https://host:port/streams/instances/{instanceId}/pes/{peId}"
}
}
],
"first": "https://host:port/streams/instances/{instanceId}/operatorconnections?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/operatorconnections?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/operatorconnections?count=10&page=1",
"previous": "https://host:port/streams/instances/{instanceId}/operatorconnections?count=10&page=1",
"resourceType": "operatorConnectionList",
"total": 50
}

List operator connections for the instance

This collection resource provides access to information about the operator connections for the instance.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
job.restid	string Example: job.restid=0 Specifies the value of the restid property for a job resource. If this parameter is used, the list is limited to the resources for the specified job.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"connections": [{"id": "o3r12j0i0r16j0",
"peConnection": "https://host:port/streams/instances/{instanceId}/peconnections/{connectionId}",
"required": true,
"resourceType": "operatorConnection",
"restid": "o0r3j2i0r4j2",
"self": "https://host:port/streams/instances/{instanceId}/operatorconnections/{connectionId}",
"source": {"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"operator": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}",
"outputPort": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}",
"pe": "https://host:port/streams/instances/{instanceId/pes/{peId}"
},
"target": {"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"inputPort": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/inputports/{portId}",
"operator": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}",
"pe": "https://host:port/streams/instances/{instanceId}/pes/{peId}"
}
}
],
"first": "https://host:port/streams/instances/{instanceId}/operatorconnections?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/operatorconnections?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/operatorconnections?count=10&page=1",
"previous": "https://host:port/streams/instances/{instanceId}/operatorconnections?count=10&page=1",
"resourceType": "operatorConnectionList",
"total": 50
}

Get operator connection

This element resource provides access to information about a connection between two operator ports.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
connectionId required	string Example: o0p0i0p1 Specifies the unique identifier for the connection.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"id": "o3r12j0i0r16j0",
"peConnection": "https://host:port/streams/instances/{instanceId}/peconnections/{connectionId}",
"required": true,
"resourceType": "operatorConnection",
"restid": "o0r3j2i0r4j2",
"self": "https://host:port/streams/instances/{instanceId}/operatorconnections/{connectionId}",
"source": {"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"operator": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}",
"outputPort": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports/{portId}",
"pe": "https://host:port/streams/instances/{instanceId/pes/{peId}"
},
"target": {"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"inputPort": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/inputports/{portId}",
"operator": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}",
"pe": "https://host:port/streams/instances/{instanceId}/pes/{peId}"
}
}

Job - Job groups

APIs for managing job groups.

List job groups

This collection resource provides access to information about the job groups for the instance.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/jobgroups?count=10&page=1",
"jobGroups": [{"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"name": "jobGroup1",
"resourceType": "jobGroup",
"restid": "jobGroup1",
"self": "https://host:port/rest/instances/{instanceId}/jobgroups/{jobGroupName}"
}
],
"last": "https://host:port/streams/instances/{instanceId}/jobgroups?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/jobgroups?count=10&page=3",
"previous": "https://host:port/streams/instances/{instanceId}/jobgroups?count=10&page=1",
"resourceType": "jobGroupList",
"total": 50
}

Create job group

This method provides the ability to create a new job group.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

Request Body schema: application/json
required

name

required

string

Identifies the name of the job group to create.

Responses

Request samples

Payload

Content type

application/json

{"name": "dept123"
}

Response samples

201
400
403
404
500

Content type

application/json

{"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"name": "jobGroup1",
"resourceType": "jobGroup",
"restid": "jobGroup1",
"self": "https://host:port/rest/instances/{instanceId}/jobgroups/{jobGroupName}"
}

Delete job group

This method provides the ability to remove a job group from the instance.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobGroupName required	string Example: myJobGroup Identifies the job group name.

Responses

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

Get job group

This element resource provides access to information about a job group.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobGroupName required	string Example: myJobGroup Identifies the job group name.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"name": "jobGroup1",
"resourceType": "jobGroup",
"restid": "jobGroup1",
"self": "https://host:port/rest/instances/{instanceId}/jobgroups/{jobGroupName}"
}

Views

APIs for managing views.

List views

This collection resource provides access to information about all of the views that are associated with active jobs.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
job.restid	string Example: job.restid=0 Specifies the value of the restid property for a job resource. If this parameter is used, the list is limited to the resources for the specified job.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/views?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/views?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/views?count=10&page=3",
"previous": "https://host:port/streams/instances/{instanceId}/views?count=10&page=1",
"resourceType": "viewList",
"total": 50,
"views": [{"activateOption": "automatic",
"attributes": [{"name": "tradePrice",
"type": "rstring"
}
],
"bufferCapacitySeconds": 30,
"bufferCapacityTuples": 100,
"bufferCapacityUnits": "seconds",
"description": "myView",
"domain": "https://host:port/streams/domains/{domainId}",
"filterAttribute": "maxCount",
"filterData": false,
"filterExpression": "^July",
"id": "jwView",
"instance": "https://host:port/streams/instances/{instanceId}",
"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"logicalOperatorName": "myOperator",
"maximumTupleRate": 10,
"name": "jwView",
"ports": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports?rest.viewid=jwView",
"resourceType": "view",
"restid": "jwView",
"self": "https://host:port/streams/instances/{instanceId}/views/{viewId}",
"started": true,
"viewItems": "https://host:port/streams/instances/{instanceId}/views/{viewId}/viewitems"
}
]
}

Get view

This element resource provides access to information about a view that is associated with an active job. You can use the view to access job data. You can use View actions to submit actions to a view.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
viewId required	string Example: myInstance.Main_0.myView Specifies the unique identifier for the view.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"activateOption": "automatic",
"attributes": [{"name": "tradePrice",
"type": "rstring"
}
],
"bufferCapacitySeconds": 30,
"bufferCapacityTuples": 100,
"bufferCapacityUnits": "seconds",
"description": "myView",
"domain": "https://host:port/streams/domains/{domainId}",
"filterAttribute": "maxCount",
"filterData": false,
"filterExpression": "^July",
"id": "jwView",
"instance": "https://host:port/streams/instances/{instanceId}",
"job": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}",
"logicalOperatorName": "myOperator",
"maximumTupleRate": 10,
"name": "jwView",
"ports": "https://host:port/streams/instances/{instanceId}/jobs/{jobId}/operators/{operatorName}/outputports?rest.viewid=jwView",
"resourceType": "view",
"restid": "jwView",
"self": "https://host:port/streams/instances/{instanceId}/views/{viewId}",
"started": true,
"viewItems": "https://host:port/streams/instances/{instanceId}/views/{viewId}/viewitems"
}

Perform view action

This method provides the ability to perform view actions such as: starting the view and stopping the view.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
viewId required	string Example: myInstance.Main_0.myView Specifies the unique identifier for the view.

Request Body schema: application/json
required

type

required

string

Enum: "start" "stop"

Specifies the action to perform:

start : Starts the view. The view starts to collect tuple data.
stop : Stops the view. The view stops collecting tuple data.

Responses

Request samples

Payload

Content type

application/json

{"type": "start"
}

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

List view items

This collection resource provides access to the tuple data that is buffered by a view. For example, you can use the REST API to display the buffered tuple data in a custom application or a third-party charting tool. In addition, the collection resource provides information about the data, such as the time it was collected.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
viewId required	string Example: myInstance.Main_0.myView Specifies the unique identifier for the view.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

header Parameters

If-Modified-Since-Milliseconds

integer <int64>

Example: 1537301102922

Specifies a time identifying which items to retrieve. Only items with a time after the specified time are returned. The unit of time is milliseconds since midnight Greenwich mean time (GMT) January 1, 1970. To retrieve only items with a time after the last items returned, set this header value to the time that was returned by the Last-Modified-Milliseconds response header from the previous request.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/views/{viewId}/viewitems?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/views/{viewId}/viewitems?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/views/{viewId}/viewitems?count=10&page=3",
"previous": "https://host:port/streams/instances/{instanceId}/views/{viewId}/viewitems?count=10&page=1",
"resourceType": "viewItemList",
"total": 50,
"viewItems": [{"channel": 1,
"channels": [1
],
"collectionTime": 1487373013042,
"data": "{\"id\":\"myid\"}",
"resourceType": "viewItem"
}
]
}

Metrics

APIs for accessing metrics for resources, jobs, PEs and operators.

List resource metrics

This collection resource provides access to metrics for a resource.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
resourceId required	string Example: management-0 Specifies the unique identifier for the resource.

query Parameters

fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=-1",
"metrics": [{"description": "metric description",
"lastTimeRetrieved": 1487373013042,
"metricKind": "gauge",
"metricType": "system",
"name": "nTuplesSubmitted",
"resourceType": "instance",
"value": 1234
}
],
"next": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=3",
"owner": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"previous": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"resourceType": "metricList",
"total": 50
}

List job metric metadata

This collection resource provides access to the metadata for job metrics.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/jobmetricmetadata?count=10&page=1",
"jobMetricMetadata": [{"description": "Metric description.",
"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"metricKind": "gauge",
"metricType": "system",
"name": "nTuplesSubmitted",
"resourceType": "metricMetadata",
"restid": "nTuplesSubmitted",
"self": "https://host:port/streams/instances/{instanceId}/jobmetricmetadata/{metricName}",
"valueType": "long"
}
],
"last": "https://host:port/streams/instances/{instanceId}/jobmetricmetadata?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/jobmetricmetadata?count=10&page=3",
"previous": "https://host:port/streams/instances/{instanceId}/jobmetricmetadata?count=10&page=1",
"resourceType": "metricMetadataList",
"total": 50
}

Get job metric metadata

This element resource provides access to the metadata for a metric.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
metricName required	string Example: nTuplesProcessed Identifies the metric name.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"description": "Metric description.",
"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"metricKind": "gauge",
"metricType": "system",
"name": "nTuplesSubmitted",
"resourceType": "metricMetadata",
"restid": "nTuplesSubmitted",
"self": "https://host:port/streams/instances/{instanceId}/jobmetricmetadata/{metricName}",
"valueType": "long"
}

Download metrics snapshot for jobs

This method provides access to a metrics snapshot for jobs in the instance.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

query Parameters

restid

string

Example: restid=0

Specifies the value of the restid property for one or more job resources separated by commas. If this parameter is used, the snapshot is limited to the specified jobs.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"id": "0",
"pes": [{"indexWithinJob": 3,
"operators": [{"outputPorts": [ ],
"name": "ScalarsForward",
"inputPorts": [{"indexWithinOperator": 0,
"metrics": [{"name": "queueSize",
"value": 0
},
{"name": "nEnqueueWaits",
"value": 0
}
]
}
],
"metrics": [{"name": "relativeOperatorCost",
"value": 0
}
]
}
],
"lastTimeRetrieved": 1539106030000
}
]
}

Download job metrics snapshot

This method provides the ability to retrieve a metrics snapshot for a job.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"id": "0",
"pes": [{"indexWithinJob": 3,
"operators": [{"outputPorts": [ ],
"name": "ScalarsForward",
"inputPorts": [{"indexWithinOperator": 0,
"metrics": [{"name": "queueSize",
"value": 0
},
{"name": "nEnqueueWaits",
"value": 0
}
]
}
],
"metrics": [{"name": "relativeOperatorCost",
"value": 0
}
]
}
],
"lastTimeRetrieved": 1539106030000
}
]
}

List operator input port metrics

This collection resource provides access to metrics for an operator input port.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.
operatorName required	string Example: sink Identifies the operator name.
portId required	string Example: 0 Specifies the unique identifier for the port.

query Parameters

fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=-1",
"metrics": [{"description": "metric description",
"lastTimeRetrieved": 1487373013042,
"metricKind": "gauge",
"metricType": "system",
"name": "nTuplesSubmitted",
"resourceType": "instance",
"value": 1234
}
],
"next": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=3",
"owner": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"previous": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"resourceType": "metricList",
"total": 50
}

List operator metrics

This collection resource provides access to metrics for an operator.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.
operatorName required	string Example: sink Identifies the operator name.

query Parameters

fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=-1",
"metrics": [{"description": "metric description",
"lastTimeRetrieved": 1487373013042,
"metricKind": "gauge",
"metricType": "system",
"name": "nTuplesSubmitted",
"resourceType": "instance",
"value": 1234
}
],
"next": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=3",
"owner": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"previous": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"resourceType": "metricList",
"total": 50
}

List operator output port metrics

This collection resource provides access to metrics for an operator output port.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
jobId required	string Example: 0 Specifies the unique identifier for the job.
operatorName required	string Example: sink Identifies the operator name.
portId required	string Example: 0 Specifies the unique identifier for the port.

query Parameters

fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=-1",
"metrics": [{"description": "metric description",
"lastTimeRetrieved": 1487373013042,
"metricKind": "gauge",
"metricType": "system",
"name": "nTuplesSubmitted",
"resourceType": "instance",
"value": 1234
}
],
"next": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=3",
"owner": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"previous": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"resourceType": "metricList",
"total": 50
}

List PE connection metrics

This collection resource provides access to metrics for a PE connection.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
connectionId required	string Example: o0p0i0p1 Specifies the unique identifier for the connection.

query Parameters

fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=-1",
"metrics": [{"description": "metric description",
"lastTimeRetrieved": 1487373013042,
"metricKind": "gauge",
"metricType": "system",
"name": "nTuplesSubmitted",
"resourceType": "instance",
"value": 1234
}
],
"next": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=3",
"owner": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"previous": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"resourceType": "metricList",
"total": 50
}

List PE input port metrics

This collection resource provides access to metrics for a PE input port.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
peId required	string Example: 0 Specifies the unique identifier for the PE.
portId required	string Example: 0 Specifies the unique identifier for the port.

query Parameters

fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=-1",
"metrics": [{"description": "metric description",
"lastTimeRetrieved": 1487373013042,
"metricKind": "gauge",
"metricType": "system",
"name": "nTuplesSubmitted",
"resourceType": "instance",
"value": 1234
}
],
"next": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=3",
"owner": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"previous": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"resourceType": "metricList",
"total": 50
}

List PE metrics

This collection resource provides access to metrics for a PE.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
peId required	string Example: 0 Specifies the unique identifier for the PE.

query Parameters

fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=-1",
"metrics": [{"description": "metric description",
"lastTimeRetrieved": 1487373013042,
"metricKind": "gauge",
"metricType": "system",
"name": "nTuplesSubmitted",
"resourceType": "instance",
"value": 1234
}
],
"next": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=3",
"owner": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"previous": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"resourceType": "metricList",
"total": 50
}

Download PE metrics snapshot

This method provides access to a metrics snapshot for the PE.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
peId required	string Example: 0 Specifies the unique identifier for the PE.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"id": "0",
"pes": [{"indexWithinJob": 3,
"operators": [{"outputPorts": [ ],
"name": "ScalarsForward",
"inputPorts": [{"indexWithinOperator": 0,
"metrics": [{"name": "queueSize",
"value": 0
},
{"name": "nEnqueueWaits",
"value": 0
}
]
}
],
"metrics": [{"name": "relativeOperatorCost",
"value": 0
}
]
}
],
"lastTimeRetrieved": 1539106030000
}
]
}

List PE output port metrics

This collection resource provides access to metrics for a PE output port.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
peId required	string Example: 0 Specifies the unique identifier for the PE.
portId required	string Example: 0 Specifies the unique identifier for the port.

query Parameters

fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=-1",
"metrics": [{"description": "metric description",
"lastTimeRetrieved": 1487373013042,
"metricKind": "gauge",
"metricType": "system",
"name": "nTuplesSubmitted",
"resourceType": "instance",
"value": 1234
}
],
"next": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=3",
"owner": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"previous": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"resourceType": "metricList",
"total": 50
}

Application configuration

APIs for managing application configuration and environment.

List domain application configurations

This collection resource provides access to information about the application configurations for the domain.

Authorizations:

authBasic

path Parameters

domainId

required

string

Example: myDomain

Specifies the unique identifier for the domain.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"applicationConfigurations": [{"creationTime": 1537301102922,
"description": "This configuration is used to store the URL to be used by our application.",
"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"lastModifiedTime": 1537301102922,
"name": "myAppConfig",
"owner": "streamsadmin",
"properties": {"name-of-property+": "propertyValue"
},
"resourceType": "applicationConfiguration",
"restid": "myAppConfig",
"self": "https://host:port/streams/instance/{instanceId}/applicationconfigurations/{applicationConfigurationName}"
}
],
"first": "https://host:port/streams/instances/{instanceId}/applicationconfigurations?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/applicationconfigurations?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/applicationconfigurations?count=10&page=3",
"previous": "https://host:port/streams/instances/{instanceId}/applicationconfigurations?count=10&page=1",
"resourceType": "applicationConfigurationList",
"total": 50
}

Create application configuration

This method provides the ability to create a new application configuration.

Authorizations:

authBasic

path Parameters

domainId

required

string

Example: myDomain

Specifies the unique identifier for the domain.

Request Body schema: application/json
required

name required	string Identifies the name of the application configuration.
required	object The properties to store for the application configuration
description	string The description for the application configuration.

Responses

Request samples

Payload

Content type

application/json

{"name": "myConfig",
"properties": {"name-of-property+": "propertyValue"
},
"description": "My description"
}

Response samples

201
400
403
404
500

Content type

application/json

{"creationTime": 1537301102922,
"description": "This configuration is used to store the URL to be used by our application.",
"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"lastModifiedTime": 1537301102922,
"name": "myAppConfig",
"owner": "streamsadmin",
"properties": {"name-of-property+": "propertyValue"
},
"resourceType": "applicationConfiguration",
"restid": "myAppConfig",
"self": "https://host:port/streams/instance/{instanceId}/applicationconfigurations/{applicationConfigurationName}"
}

Delete application configuration

This method provides the ability to remove an application configuration.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
applicationConfigurationName required	string Example: myAppConfig Identifies the application configuration name.

Responses

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

Get domain application configuration

This element resource provides access to information about a domain application configuration.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
applicationConfigurationName required	string Example: myAppConfig Identifies the application configuration name.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"creationTime": 1537301102922,
"description": "This configuration is used to store the URL to be used by our application.",
"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"lastModifiedTime": 1537301102922,
"name": "myAppConfig",
"owner": "streamsadmin",
"properties": {"name-of-property+": "propertyValue"
},
"resourceType": "applicationConfiguration",
"restid": "myAppConfig",
"self": "https://host:port/streams/instance/{instanceId}/applicationconfigurations/{applicationConfigurationName}"
}

Update domain application configuration

This method provides the ability to update an application configuration.

Note: If your REST client does not support the PATCH method, you can use the POST method with the request header X-HTTP-Method-Override=PATCH specified.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
applicationConfigurationName required	string Example: myAppConfig Identifies the application configuration name.

Request Body schema: application/json
required

description	string The new description for the application configuration.
	object The set of properties to update.

Responses

Request samples

Payload

Content type

application/json

{"description": "My new description",
"properties": {"name-of-property+": "newValue"
}
}

Response samples

200
400
403
404
500

Content type

application/json

{"creationTime": 1537301102922,
"description": "This configuration is used to store the URL to be used by our application.",
"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"lastModifiedTime": 1537301102922,
"name": "myAppConfig",
"owner": "streamsadmin",
"properties": {"name-of-property+": "propertyValue"
},
"resourceType": "applicationConfiguration",
"restid": "myAppConfig",
"self": "https://host:port/streams/instance/{instanceId}/applicationconfigurations/{applicationConfigurationName}"
}

List restricted configurations

This collection resource provides access to information about restricted configurations for the domain.

Authorizations:

authBasic

path Parameters

domainId

required

string

Example: myDomain

Specifies the unique identifier for the domain.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/restrictedconfiguration?name=myconfig Filtering is not supported on the value property since its value could contain sensitive content. Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/restrictedconfigirations?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/restrictedconfigirations?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/restrictedconfigirations?count=10&page=3",
"previous": "https://host:port/streams/instances/{instanceId}/restrictedconfigirations?count=10&page=1",
"resourceType": "restrictedConfigurationList",
"restrictedConfigurations": [{"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"name": "restrictedConfig1",
"resourceType": "restrictedConfiguration",
"restid": "restrictedConfig1",
"self": "https://host:port/rest/instances/{instanceId}/restrictedconfigurations/{restrictedConfigurationName}",
"value": "restricted configuration value"
}
],
"total": 50
}

Create restricted configuration

This method provides the ability to create a new restricted configuration.

Authorizations:

authBasic

path Parameters

domainId

required

string

Example: myDomain

Specifies the unique identifier for the domain.

Request Body schema: application/json
required

name required	string Identifies the name of the restricted configuration.
value required	string Identifies the value of the restricted configuration.

Responses

Request samples

Payload

Content type

application/json

{"name": "myRestrictedConfig",
"value": "restrictedValue"
}

Response samples

201
400
403
404
500

Content type

application/json

{"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"name": "restrictedConfig1",
"resourceType": "restrictedConfiguration",
"restid": "restrictedConfig1",
"self": "https://host:port/rest/instances/{instanceId}/restrictedconfigurations/{restrictedConfigurationName}",
"value": "restricted configuration value"
}

Delete restricted configuration

This method provides the ability to remove the restricted configuration from the domain.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
restrictedConfigurationName required	string Example: myDbCredentials Identifies the restricted configuration name.

Responses

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

Get restricted configuration

This element resource provides access to information for a restricted configuration.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
restrictedConfigurationName required	string Example: myDbCredentials Identifies the restricted configuration name.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"name": "restrictedConfig1",
"resourceType": "restrictedConfiguration",
"restid": "restrictedConfig1",
"self": "https://host:port/rest/instances/{instanceId}/restrictedconfigurations/{restrictedConfigurationName}",
"value": "restricted configuration value"
}

Replace restricted configuration

This method provides the ability to replace a restricted configuration value.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
restrictedConfigurationName required	string Example: myDbCredentials Identifies the restricted configuration name.

Request Body schema: application/json
required

value

required

string

Identifies the value of the restricted configuration.

Responses

Request samples

Payload

Content type

application/json

{"value": "restrictedValue"
}

Response samples

200
400
403
404
500

Content type

application/json

{"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"name": "restrictedConfig1",
"resourceType": "restrictedConfiguration",
"restid": "restrictedConfig1",
"self": "https://host:port/rest/instances/{instanceId}/restrictedconfigurations/{restrictedConfigurationName}",
"value": "restricted configuration value"
}

List application configurations

This collection resource provides access to information about the application configurations for the instance.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"applicationConfigurations": [{"creationTime": 1537301102922,
"description": "This configuration is used to store the URL to be used by our application.",
"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"lastModifiedTime": 1537301102922,
"name": "myAppConfig",
"owner": "streamsadmin",
"properties": {"name-of-property+": "propertyValue"
},
"resourceType": "applicationConfiguration",
"restid": "myAppConfig",
"self": "https://host:port/streams/instance/{instanceId}/applicationconfigurations/{applicationConfigurationName}"
}
],
"first": "https://host:port/streams/instances/{instanceId}/applicationconfigurations?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/applicationconfigurations?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/applicationconfigurations?count=10&page=3",
"previous": "https://host:port/streams/instances/{instanceId}/applicationconfigurations?count=10&page=1",
"resourceType": "applicationConfigurationList",
"total": 50
}

Create application configuration

This method provides the ability to create a new application configuration.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

Request Body schema: application/json
required

name required	string Identifies the name of the application configuration.
required	object The properties to store for the application configuration
description	string The description for the application configuration.

Responses

Request samples

Payload

Content type

application/json

{"name": "myConfig",
"properties": {"name-of-property+": "propertyValue"
},
"description": "My description"
}

Response samples

201
400
403
404
500

Content type

application/json

{"creationTime": 1537301102922,
"description": "This configuration is used to store the URL to be used by our application.",
"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"lastModifiedTime": 1537301102922,
"name": "myAppConfig",
"owner": "streamsadmin",
"properties": {"name-of-property+": "propertyValue"
},
"resourceType": "applicationConfiguration",
"restid": "myAppConfig",
"self": "https://host:port/streams/instance/{instanceId}/applicationconfigurations/{applicationConfigurationName}"
}

Delete application configuration

This method provides the ability to remove an application configuration.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
applicationConfigurationName required	string Example: myAppConfig Identifies the application configuration name.

Responses

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

Get application configuration

This element resource provides access to information about an application configuration.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
applicationConfigurationName required	string Example: myAppConfig Identifies the application configuration name.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"creationTime": 1537301102922,
"description": "This configuration is used to store the URL to be used by our application.",
"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"lastModifiedTime": 1537301102922,
"name": "myAppConfig",
"owner": "streamsadmin",
"properties": {"name-of-property+": "propertyValue"
},
"resourceType": "applicationConfiguration",
"restid": "myAppConfig",
"self": "https://host:port/streams/instance/{instanceId}/applicationconfigurations/{applicationConfigurationName}"
}

Update application configuration

This method provides the ability to update an application configuration.

Note: If your REST client does not support the PATCH method, you can use the POST method with the request header X-HTTP-Method-Override=PATCH specified.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
applicationConfigurationName required	string Example: myAppConfig Identifies the application configuration name.

Request Body schema: application/json
required

description	string The new description for the application configuration.
	object The set of properties to update.

Responses

Request samples

Payload

Content type

application/json

{"description": "My new description",
"properties": {"name-of-property+": "newValue"
}
}

Response samples

200
400
403
404
500

Content type

application/json

{"creationTime": 1537301102922,
"description": "This configuration is used to store the URL to be used by our application.",
"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"lastModifiedTime": 1537301102922,
"name": "myAppConfig",
"owner": "streamsadmin",
"properties": {"name-of-property+": "propertyValue"
},
"resourceType": "applicationConfiguration",
"restid": "myAppConfig",
"self": "https://host:port/streams/instance/{instanceId}/applicationconfigurations/{applicationConfigurationName}"
}

List application environment variables

This collection resource provides access to information about application environment variables for the instance.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"applicationEnvironmentVariables": [{"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"name": "envVar1",
"resourceType": "applicationEnvironmentVariable",
"restid": "envVar1",
"self": "https://host:port/rest/instances/{instanceId}/applicationenvironmentvariables/{applicationEnvironmentVariableName}",
"value": "envVarValue1"
}
],
"first": "https://host:port/streams/instances/{instanceId}/applicationenvironmentvariables?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/applicationenvironmentvariables?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/applicationenvironmentvariables?count=10&page=3",
"previous": "https://host:port/streams/instances/{instanceId}/applicationenvironmentvariables?count=10&page=1",
"resourceType": "applicationEnvironmentVariableList",
"total": 50
}

Add application environment variable

This method provides the ability to add an application environment variable to the instance.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

Request Body schema: application/json
required

name required	string Identifies the name of the application environment variable.
value required	string Identifies the value of the application environment variable.

Responses

Request samples

Payload

Content type

application/json

{"name": "LANG",
"value": "en_US.UTF-8"
}

Response samples

201
400
403
404
500

Content type

application/json

{"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"name": "envVar1",
"resourceType": "applicationEnvironmentVariable",
"restid": "envVar1",
"self": "https://host:port/rest/instances/{instanceId}/applicationenvironmentvariables/{applicationEnvironmentVariableName}",
"value": "envVarValue1"
}

Remove application environment variable

This method provides the ability to remove an application environment variable from the instance.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
applicationEnvironmentVariableName required	string Example: myAppEnvVar Identifies the application environment variable name.

Responses

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

Get application environment variable

This element resource provides access to information about an application environment variable.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
applicationEnvironmentVariableName required	string Example: myAppEnvVar Identifies the application environment variable name.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"name": "envVar1",
"resourceType": "applicationEnvironmentVariable",
"restid": "envVar1",
"self": "https://host:port/rest/instances/{instanceId}/applicationenvironmentvariables/{applicationEnvironmentVariableName}",
"value": "envVarValue1"
}

Replace application environment variable

This method provides the ability to replace the value of an application environment variable.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
applicationEnvironmentVariableName required	string Example: myAppEnvVar Identifies the application environment variable name.

Request Body schema: application/json
required

value

required

string

Identifies the value of the application environment variable.

Responses

Request samples

Payload

Content type

application/json

{"value": "myEnvValue"
}

Response samples

200
400
403
404
500

Content type

application/json

{"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"name": "envVar1",
"resourceType": "applicationEnvironmentVariable",
"restid": "envVar1",
"self": "https://host:port/rest/instances/{instanceId}/applicationenvironmentvariables/{applicationEnvironmentVariableName}",
"value": "envVarValue1"
}

List restricted configurations

This collection resource provides access to information about restricted configurations for the instance.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/restrictedconfiguration?name=myconfig Filtering is not supported on the value property since its value could contain sensitive content. Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/restrictedconfigirations?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/restrictedconfigirations?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/restrictedconfigirations?count=10&page=3",
"previous": "https://host:port/streams/instances/{instanceId}/restrictedconfigirations?count=10&page=1",
"resourceType": "restrictedConfigurationList",
"restrictedConfigurations": [{"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"name": "restrictedConfig1",
"resourceType": "restrictedConfiguration",
"restid": "restrictedConfig1",
"self": "https://host:port/rest/instances/{instanceId}/restrictedconfigurations/{restrictedConfigurationName}",
"value": "restricted configuration value"
}
],
"total": 50
}

Create restricted configuration

This method provides the ability to create a new restricted configuration.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

Request Body schema: application/json
required

name required	string Identifies the name of the restricted configuration.
value required	string Identifies the value of the restricted configuration.

Responses

Request samples

Payload

Content type

application/json

{"name": "myRestrictedConfig",
"value": "restrictedValue"
}

Response samples

201
400
403
404
500

Content type

application/json

{"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"name": "restrictedConfig1",
"resourceType": "restrictedConfiguration",
"restid": "restrictedConfig1",
"self": "https://host:port/rest/instances/{instanceId}/restrictedconfigurations/{restrictedConfigurationName}",
"value": "restricted configuration value"
}

Delete restricted configuration

This method provides the ability to remove the restricted configuration from the instance.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
restrictedConfigurationName required	string Example: myDbCredentials Identifies the restricted configuration name.

Responses

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

Get restricted configuration

This element resource provides access to information for a restricted configuration.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
restrictedConfigurationName required	string Example: myDbCredentials Identifies the restricted configuration name.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"name": "restrictedConfig1",
"resourceType": "restrictedConfiguration",
"restid": "restrictedConfig1",
"self": "https://host:port/rest/instances/{instanceId}/restrictedconfigurations/{restrictedConfigurationName}",
"value": "restricted configuration value"
}

Replace restricted configuration

This method provides the ability to replace a restricted configuration value.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
restrictedConfigurationName required	string Example: myDbCredentials Identifies the restricted configuration name.

Request Body schema: application/json
required

value

required

string

Identifies the value of the restricted configuration.

Responses

Request samples

Payload

Content type

application/json

{"value": "restrictedValue"
}

Response samples

200
400
403
404
500

Content type

application/json

{"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"name": "restrictedConfig1",
"resourceType": "restrictedConfiguration",
"restid": "restrictedConfig1",
"self": "https://host:port/rest/instances/{instanceId}/restrictedconfigurations/{restrictedConfigurationName}",
"value": "restricted configuration value"
}

Resource

APIs for managing Streams resources.

List domain resources

This collection resource provides access to information about domain resources.

Authorizations:

authBasic

path Parameters

domainId

required

string

Example: myDomain

Specifies the unique identifier for the domain.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/resources?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/resources?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/resources?count=10&page=3",
"previous": "https://host:port/streams/domains/{domainId}/resources?count=10&page=1",
"resourceType": "resourceList",
"resources": [{"activeServices": "https://host:port/streams/domains/{domainId}/activeservices?resource.restid=systema.teracloud.com",
"allocations": "Deprecated: This property is deprecated and might become obsolete.",
"displayName": "systema.teracloud.com",
"domain": "https://host:port/streams/domains/{domainId}",
"exclusiveInstance": "instance1",
"id": "systemA",
"installations": "https://host:port/streams/domains/{domainId}/resources/{resourceId}/installations",
"ipAddress": "1.2.3.4",
"metrics": "https://host:port/streams/domains/{domainId}/resources/{resourceId}/metrics",
"resourceType": "resource",
"restid": "systema.teracloud.com",
"restrictedTags": ["operations"
],
"self": "https:port/streams/domains/{domainId}/resources/{resourceId}",
"serviceStatus": [{"name": "aas",
"status": "running"
}
],
"status": "running",
"systemService": true,
"tags": ["application"
],
"type": "streams"
}
],
"total": 50
}

Get domain resource

This element resource provides access to information for a domain resource.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
resourceId required	string Example: management-0 Specifies the unique identifier for the resource.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"activeServices": "https://host:port/streams/domains/{domainId}/activeservices?resource.restid=systema.teracloud.com",
"allocations": "Deprecated: This property is deprecated and might become obsolete.",
"displayName": "systema.teracloud.com",
"domain": "https://host:port/streams/domains/{domainId}",
"exclusiveInstance": "instance1",
"id": "systemA",
"installations": "https://host:port/streams/domains/{domainId}/resources/{resourceId}/installations",
"ipAddress": "1.2.3.4",
"metrics": "https://host:port/streams/domains/{domainId}/resources/{resourceId}/metrics",
"resourceType": "resource",
"restid": "systema.teracloud.com",
"restrictedTags": ["operations"
],
"self": "https:port/streams/domains/{domainId}/resources/{resourceId}",
"serviceStatus": [{"name": "aas",
"status": "running"
}
],
"status": "running",
"systemService": true,
"tags": ["application"
],
"type": "streams"
}

Perform resource action

This method provides the ability to perform resource actions such as quiescing and resuming the resource. It also provides support for performing actions specifically for resources managed by the Streams resource manager, such as adding and removing tags and restricting resource usage.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
resourceId required	string Example: management-0 Specifies the unique identifier for the resource.

Request Body schema: application/json
required

type

required

string

Enum: "addTag" "quiesce" "removeTag" "restrict" "resume" "unrestrict"

Identifies the action to perform:

addTag : Adds a resource tag to the resource.
quiesce : Stops all services and jobs running on the resource.
removeTag : Removes a resource tag from the resource.
restrict : Identifies a resource tag as a restricted resource tag for a resource. If a resource has restricted resource tags, only processing elements (PEs) which require this set of resource tags are allowed to run on the resource.
resume : Restarts services on the resource after the resource has been quiesced.
unrestrict : Removes a resource tag from the list of restricted resource tags for a resource. If a resource has restricted resource tags, only processing elements (PEs) which require this set of resource tags are allowed to run on the resource.

force

boolean

Indicates whether the quiesce operation should be run even if required services are running on the resource and there are no waiting services of the same type. This property applies to the following action types: quiesce.

Responses

Request samples

Payload

Content type

application/json

{"Quiesce resource": {"type": "quiesce",
"force": true
},
"Resume resource": {"type": "resume"
},
"Add tag to resource": {"type": "addTag",
"tag": "sensitive"
},
"Remove tag from resource": {"type": "removeTag",
"tag": "sensitive"
},
"Restict resource to running only PEs with specified tag, fail if Streams services or jobs are already running": {"type": "restrict",
"tag": "sensitive",
"allowActiveInstances": false
},
"Remove restriction of resource running only PEs with specified tag": {"type": "unrestrict",
"tag": "sensitive"
}
}

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

List resource installations

This collection resource provides information about all installations with the same base installation path as the installation that runs the domain controller service on the specified resource.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
resourceId required	string Example: management-0 Specifies the unique identifier for the resource.

query Parameters

fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/installations?count=10&page=1",
"installations": [{"architecture": "x86_64",
"buildVersion": "20250310145500",
"editionName": "Teracloud Streams",
"fullProductVersion": "7.2.0.0",
"hotFix": "string",
"installPath": "/home/joeuser/streams/7.2.0.0",
"minimumOSBaseVersion": "8",
"minimumOSPatchVersion": "0",
"minimumOSVersion": "Red Hat Enterprise Linux Server release 8.0 (Ootpa)",
"owner": "joeuser",
"productName": "Teracloud Streams",
"productVersion": "7.2.0.0",
"resourceType": "installation"
}
],
"last": "https://host:port/streams/installations?count=10&page=-1",
"next": "https://host:port/streams/installations?count=10&page=3",
"previous": "https://host:port/streams/installations?count=10&page=1",
"resourceType": "installationList",
"total": 50
}

List resource metrics

This collection resource provides access to metrics for a resource.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
resourceId required	string Example: management-0 Specifies the unique identifier for the resource.

query Parameters

fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=-1",
"metrics": [{"description": "metric description",
"lastTimeRetrieved": 1487373013042,
"metricKind": "gauge",
"metricType": "system",
"name": "nTuplesSubmitted",
"resourceType": "instance",
"value": 1234
}
],
"next": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=3",
"owner": "https://host:port/streams/instances/{instanceId}/pes/{peId}",
"previous": "https://host:port/streams/instances/{instanceId}/pes/{peId}/metrics?count=10&page=1",
"resourceType": "metricList",
"total": 50
}

List resources in use by an instance

This collection resource provides access to information about the resources in use by an instance.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
job.restid	string Example: job.restid=0 Specifies the value of the restid property for a job resource. If this parameter is used, the list is limited to the resources for the specified job.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/instances/{instanceId}/resources?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/resources?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/resources?count=10&page=3",
"previous": "https://host:port/streams/instances/{instanceId}/resources?count=10&page=1",
"resourceType": "resourceList",
"resources": [{"activeServices": "https://host:port/streams/instances/{instanceId}/activeservices?resource.restid=systema.teracloud.com",
"applicationResource": true,
"displayName": "systema.teracloud.com",
"domain": "https://host:port/streams/domains/{domainId}",
"exclusiveInstance": "instance1",
"id": "systemA",
"installations": "https://host:port/streams/domains/{domainId}/resources/{resourceId}/installations",
"instance": "https://host:port/streams/instances/{instanceId}",
"ipAddress": "1.2.3.4",
"jobs": "https://host:port/streams/instances/{instanceId}/jobs?resource.restid={resourceId}",
"metrics": "https://host:port/streams/domains/{domainId}/resources/{resourceId}/metrics",
"pes": "https://host:port/streams/instances/{instanceId}/pes?resource.restid={resourceId}",
"resourceSpecification": {"exclusive": false,
"id": "1",
"resourceCount": 2,
"restrictedTags": ["operations"
],
"tags": ["large"
]
},
"resourceType": "resource",
"restid": "systema.teracloud.com",
"restrictedTags": ["operations"
],
"schedulerStatus": "running",
"self": "https:port/streams/instances/{instnaceId}/resources/{resourceId}",
"serviceStatus": [{"name": "aas",
"status": "running"
}
],
"status": "running",
"systemService": true,
"tags": ["application"
],
"type": "streams"
}
],
"total": 50
}

Get resource in use by an instance

This element resource provides access to information for a resource in use by an instance.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
resourceId required	string Example: management-0 Specifies the unique identifier for the resource.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"activeServices": "https://host:port/streams/instances/{instanceId}/activeservices?resource.restid=systema.teracloud.com",
"applicationResource": true,
"displayName": "systema.teracloud.com",
"domain": "https://host:port/streams/domains/{domainId}",
"exclusiveInstance": "instance1",
"id": "systemA",
"installations": "https://host:port/streams/domains/{domainId}/resources/{resourceId}/installations",
"instance": "https://host:port/streams/instances/{instanceId}",
"ipAddress": "1.2.3.4",
"jobs": "https://host:port/streams/instances/{instanceId}/jobs?resource.restid={resourceId}",
"metrics": "https://host:port/streams/domains/{domainId}/resources/{resourceId}/metrics",
"pes": "https://host:port/streams/instances/{instanceId}/pes?resource.restid={resourceId}",
"resourceSpecification": {"exclusive": false,
"id": "1",
"resourceCount": 2,
"restrictedTags": ["operations"
],
"tags": ["large"
]
},
"resourceType": "resource",
"restid": "systema.teracloud.com",
"restrictedTags": ["operations"
],
"schedulerStatus": "running",
"self": "https:port/streams/instances/{instnaceId}/resources/{resourceId}",
"serviceStatus": [{"name": "aas",
"status": "running"
}
],
"status": "running",
"systemService": true,
"tags": ["application"
],
"type": "streams"
}

Custom resource tag

APIs for managing custom resource tags.

List custom resource tags

This collection resource provides access to information about the custom resource tags for the domain.

Authorizations:

authBasic

path Parameters

domainId

required

string

Example: myDomain

Specifies the unique identifier for the domain.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"customResourceTags": [{"description": "This configuration is used to store the URL to be used by our application.",
"domain": "https://host:port/streams/domains/{domainId}",
"inUseByAnyInstance": true,
"inUseByAnyJob": false,
"name": "myCustomTag",
"resourceType": "customResourceTag",
"restid": "myTag",
"self": "https://host:port/streams/domain/{domainId}/customresourcetags/{customResourceTagName}"
}
],
"first": "https://host:port/streams/domains/{domainId}/customresourcetags?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/customresourcetags?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/customresourcetags?count=10&page=3",
"previous": "https://host:port/streams/domains/{domainId}/customresourcetags?count=10&page=1",
"resourceType": "customResourceTagList",
"total": 50
}

Create custom resource tag

This method provides the ability to create a custom resource tag.

Authorizations:

authBasic

path Parameters

domainId

required

string

Example: myDomain

Specifies the unique identifier for the domain.

Request Body schema: application/json
required

name required	string Identifies the name of the custom resource tag.
description	string Specifies a description for the custom resource tag.

Responses

Request samples

Payload

Content type

application/json

{"name": "myTag",
"description": "My description"
}

Response samples

201
400
403
404
500

Content type

application/json

{"description": "This configuration is used to store the URL to be used by our application.",
"domain": "https://host:port/streams/domains/{domainId}",
"inUseByAnyInstance": true,
"inUseByAnyJob": false,
"name": "myCustomTag",
"resourceType": "customResourceTag",
"restid": "myTag",
"self": "https://host:port/streams/domain/{domainId}/customresourcetags/{customResourceTagName}"
}

Delete custom resource tag

This method provides the ability to remove a custom resource tag.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
customResourceTagName required	string Example: myCustomTag Identifies the custom resource tag name.

Responses

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

Get custom resource tag

This element resource provides access to information about a custom resource tag.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
customResourceTagName required	string Example: myCustomTag Identifies the custom resource tag name.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"description": "This configuration is used to store the URL to be used by our application.",
"domain": "https://host:port/streams/domains/{domainId}",
"inUseByAnyInstance": true,
"inUseByAnyJob": false,
"name": "myCustomTag",
"resourceType": "customResourceTag",
"restid": "myTag",
"self": "https://host:port/streams/domain/{domainId}/customresourcetags/{customResourceTagName}"
}

Update custom resource tag

This method provides the ability to update a custom resource tag.

Note: If your REST client does not support the PATCH method, you can use the POST method with the request header X-HTTP-Method-Override=PATCH specified.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
customResourceTagName required	string Example: myCustomTag Identifies the custom resource tag name.

Request Body schema: application/json
required

description

string

The new custom resource tag description to set.

Responses

Request samples

Payload

Content type

application/json

{"description": "My new description"
}

Response samples

200
400
403
404
500

Content type

application/json

{"description": "This configuration is used to store the URL to be used by our application.",
"domain": "https://host:port/streams/domains/{domainId}",
"inUseByAnyInstance": true,
"inUseByAnyJob": false,
"name": "myCustomTag",
"resourceType": "customResourceTag",
"restid": "myTag",
"self": "https://host:port/streams/domain/{domainId}/customresourcetags/{customResourceTagName}"
}

Service

APIs for managing Streams management services.

List domain active services

This collection resource provides access to information about the active Streams services in the domain.

Authorizations:

authBasic

path Parameters

domainId

required

string

Example: myDomain

Specifies the unique identifier for the domain.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
resource.restid	string Example: resource.restid=management-0 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 resources for the specified Streams instance resource.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"activeServices": [{"connectionUrl": "service:jmx:jmxmp://host:9975",
"domain": "https://host:port/streams/domains/{domainId}",
"leader": true,
"processId": "1001",
"resource": "https://host:port/streams/domains/{domainId}/resources/{resourceId}",
"resourceType": "activeService",
"restid": "sws.1234",
"self": "https:port/streams/domains/{domainId}/activeservices/{serviceId}",
"startTime": 1537301102922,
"status": "running",
"type": "jmx"
}
],
"first": "https://host:port/streams/domains/{domainId}/activeservices?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/activeservices?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/activeservices?count=10&page=3",
"previous": "https://host:port/streams/domains/{domainId}/activeservices?count=10&page=1",
"resourceType": "activeServiceList",
"total": 50
}

Get domain active service

This element resource provides access to information about an active Streams domain service.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
resourceId required	string Example: management-0 Specifies the unique identifier for the resource.
serviceId required	string Example: 4167755.sws Specifies the unique identifier for the service.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"connectionUrl": "service:jmx:jmxmp://host:9975",
"domain": "https://host:port/streams/domains/{domainId}",
"leader": true,
"processId": "1001",
"resource": "https://host:port/streams/domains/{domainId}/resources/{resourceId}",
"resourceType": "activeService",
"restid": "sws.1234",
"self": "https:port/streams/domains/{domainId}/activeservices/{serviceId}",
"startTime": 1537301102922,
"status": "running",
"type": "jmx"
}

Perform domain active service action

This method provides the ability to perform active service actions such as restarting and moving to a different resource.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
resourceId required	string Example: management-0 Specifies the unique identifier for the resource.
serviceId required	string Example: 4167755.sws Specifies the unique identifier for the service.

Request Body schema: application/json
required

resource required	string Identifies the target resource for the move. This property applies to the following action types: move.
type required	string Enum: "move" "restart" Identifies the action to perform: move : Moves the active service to a different resource. restart : Restarts the active service.
all	boolean move: Indicates whether all active services of this service type on the current resource should be moved to the target resource. If this value is false or not specified, only this active service is moved. restart: Indicates whether all active services of this service type should be restarted on all resources. If this value is false or not specified, only this active service is restarted. This property applies to the following action types: move, restart.

Responses

Request samples

Payload

Content type

application/json

{"Restart this active service": {"type": "restart",
"all": false
},
"Restart all active services with this service type on all resources": {"type": "restart",
"all": true
},
"Move all active services with this service type from this resource to resourceB": {"type": "move",
"resource": "resourceB",
"all": true
}
}

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

List instance active services

This collection resource provides access to information about the active Streams services in the instance.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
resource.restid	string Example: resource.restid=management-0 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 resources for the specified Streams instance resource.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"activeServices": [{"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"leader": true,
"processId": "1001",
"resource": "https://host:port/streams/instances/{instanceId}/resources/{resourceId}",
"resourceAllocation": "Deprecated: This property is deprecated and might become obsolete.",
"resourceType": "activeService",
"restid": "sam.1234",
"self": "https:port/streams/instances/{instanceId}/activeservices/{serviceId}",
"startTime": 1537301102922,
"status": "running",
"type": "view"
}
],
"first": "https://host:port/streams/instances/{instanceId}/activeservices?count=10&page=1",
"last": "https://host:port/streams/instances/{instanceId}/activeservices?count=10&page=-1",
"next": "https://host:port/streams/instances/{instanceId}/activeservices?count=10&page=3",
"previous": "https://host:port/streams/instances/{instanceId}/activeservices?count=10&page=1",
"resourceType": "activeServiceList",
"total": 50
}

Get instance active service

This element resource provides access to information about an active Streams instance service.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
resourceId required	string Example: management-0 Specifies the unique identifier for the resource.
serviceId required	string Example: 4167755.sws Specifies the unique identifier for the service.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"domain": "https://host:port/streams/domains/{domainId}",
"instance": "https://host:port/streams/instances/{instanceId}",
"leader": true,
"processId": "1001",
"resource": "https://host:port/streams/instances/{instanceId}/resources/{resourceId}",
"resourceAllocation": "Deprecated: This property is deprecated and might become obsolete.",
"resourceType": "activeService",
"restid": "sam.1234",
"self": "https:port/streams/instances/{instanceId}/activeservices/{serviceId}",
"startTime": 1537301102922,
"status": "running",
"type": "view"
}

Perform instance active service action

This method provides the ability to perform active service actions such as restarting and moving to a different resource.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
resourceId required	string Example: management-0 Specifies the unique identifier for the resource.
serviceId required	string Example: 4167755.sws Specifies the unique identifier for the service.

Request Body schema: application/json
required

resource required	string Identifies the target resource for the move. This property applies to the following action types: move.
type required	string Enum: "move" "restart" Identifies the action to perform: move : Moves the active service to a different resource. restart : Restarts the active service.
all	boolean move: Indicates whether all active services of this service type on the current resource should be moved to the target resource. If this value is false or not specified, only this active service is moved. restart: Indicates whether all active services of this service type should be restarted on all resources. If this value is false or not specified, only this active service is restarted. This property applies to the following action types: move, restart.

Responses

Request samples

Payload

Content type

application/json

{"Restart this active service": {"type": "restart",
"all": false
},
"Restart all active services with this service type on all resources": {"type": "restart",
"all": true
},
"Move all active services with this service type from this resource to resourceB": {"type": "move",
"resource": "resourceB",
"all": true
}
}

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

Security - Principals and objects

APIs for managing security principals (users, groups and roles) and objects.

List domain groups

This collection resource provides access to information about the groups in the domain.

Authorizations:

authBasic

path Parameters

domainId

required

string

Example: myDomain

Specifies the unique identifier for the domain.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
role.restid	string Example: role.restid=InstanceAdministrator Specifies the value of the restid property for a role resource. If this parameter is used, the list is limited to the resources for the specified role.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/groups?count=10&page=1",
"groups": [{"defaultPermissions": "https://host:port/streams/instances/{instanceId}/groups/{groupName}/defaultPermissions",
"domain": "https://host:port/streams/domains/{domainId}",
"name": "accounting",
"permissions": "https://host:port/streams/domains/{domainId}/groups/{groupName}/permissions",
"reserved": false,
"resourceType": "group",
"restid": "accounting",
"roles": "https://host:port/streams/domains/{domainId}/roles",
"self": "https://host:port/rest/instances/{instanceId}/groups/{groupName}"
}
],
"last": "https://host:port/streams/domains/{domainId}/groups?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/groups?count=10&page=3",
"previous": "https://host:port/streams/domains/{domainId}/groups?count=10&page=1",
"resourceType": "groupList",
"total": 50
}

Get domain group

This element resource provides access to information about a group.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
groupName required	string Example: myGroup Identifies the group name.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"defaultPermissions": "https://host:port/streams/instances/{instanceId}/groups/{groupName}/defaultPermissions",
"domain": "https://host:port/streams/domains/{domainId}",
"name": "accounting",
"permissions": "https://host:port/streams/domains/{domainId}/groups/{groupName}/permissions",
"reserved": false,
"resourceType": "group",
"restid": "accounting",
"roles": "https://host:port/streams/domains/{domainId}/roles",
"self": "https://host:port/rest/instances/{instanceId}/groups/{groupName}"
}

List domain roles

This collection resource provides access to information about the roles in the domain.

Authorizations:

authBasic

path Parameters

domainId

required

string

Example: myDomain

Specifies the unique identifier for the domain.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
group.restid	string Example: group.restid=myGroup Specifies the value of the restid property for a group resource. If this parameter is used, the list is limited to the resources for the specified group.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.
user.restid	string Example: user.restid=streamsadmin Specifies the value of the restid property for a user resource. If this parameter is used, the list is limited to the resources for the specified user.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/roles?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/roles?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/roles?count=10&page=3",
"previous": "https://host:port/streams/domains/{domainId}/roles?count=10&page=1",
"resourceType": "roleList",
"roles": [{"defaultPermissions": "https://host:port/streams/domains/{domainId}/roles/{roleName}/defaultPermissions",
"domain": "https://host:port/streams/domains/{domainId}",
"groups": "https://host:port/streams/domains/{domainId}/groups",
"name": "myRole",
"permissions": "https://host:port/streams/domains/{domainId}/roles/{roleName}/permissions",
"reserved": true,
"resourceType": "role",
"restid": "myRole",
"self": "https://host:port/rest/instances/{instanceId}/roles/{roleName}",
"users": "https://host:port/streams/domains/{domainId}/users"
}
],
"total": 50
}

Create domain role

This method provides the ability to create a new role.

Authorizations:

authBasic

path Parameters

domainId

required

string

Example: myDomain

Specifies the unique identifier for the domain.

Request Body schema: application/json
required

name

required

string

Identifies the name of the role to create.

Responses

Request samples

Payload

Content type

application/json

{"name": "myRole"
}

Response samples

201
400
403
404
500

Content type

application/json

{"defaultPermissions": "https://host:port/streams/domains/{domainId}/roles/{roleName}/defaultPermissions",
"domain": "https://host:port/streams/domains/{domainId}",
"groups": "https://host:port/streams/domains/{domainId}/groups",
"name": "myRole",
"permissions": "https://host:port/streams/domains/{domainId}/roles/{roleName}/permissions",
"reserved": true,
"resourceType": "role",
"restid": "myRole",
"self": "https://host:port/rest/instances/{instanceId}/roles/{roleName}",
"users": "https://host:port/streams/domains/{domainId}/users"
}

Delete domain role

This method provides the ability to remove the role from the domain.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
roleName required	string Example: InstanceAdministrator Identifies the role name

Responses

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

Get domain role

This element resource provides access to information about a role.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
roleName required	string Example: InstanceAdministrator Identifies the role name

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"defaultPermissions": "https://host:port/streams/domains/{domainId}/roles/{roleName}/defaultPermissions",
"domain": "https://host:port/streams/domains/{domainId}",
"groups": "https://host:port/streams/domains/{domainId}/groups",
"name": "myRole",
"permissions": "https://host:port/streams/domains/{domainId}/roles/{roleName}/permissions",
"reserved": true,
"resourceType": "role",
"restid": "myRole",
"self": "https://host:port/rest/instances/{instanceId}/roles/{roleName}",
"users": "https://host:port/streams/domains/{domainId}/users"
}

Update domain role

This method provides the ability to add and remove users and groups from a role.

Note: If your REST client does not support the PATCH method, you can use the POST method with the request header X-HTTP-Method-Override=PATCH specified.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
roleName required	string Example: InstanceAdministrator Identifies the role name

Request Body schema: application/json
required

groups.add	Array of strings (optional) Specifies a list of groups to add to the role.
groups.remove	Array of strings (optional) Specifies a list of groups to remove from the role.
users.add	Array of strings (optional) Specifies a list of users to add to the role.
users.remove	Array of strings (optional) Specifies a list of users to remove from the role.

Responses

Request samples

Payload

Content type

application/json

{"groups.add": ["twins"
],
"groups.remove": ["vikings"
],
"users.add": ["john"
],
"users.remove": ["mary"
]
}

Response samples

200
400
403
404
500

Content type

application/json

{"defaultPermissions": "https://host:port/streams/domains/{domainId}/roles/{roleName}/defaultPermissions",
"domain": "https://host:port/streams/domains/{domainId}",
"groups": "https://host:port/streams/domains/{domainId}/groups",
"name": "myRole",
"permissions": "https://host:port/streams/domains/{domainId}/roles/{roleName}/permissions",
"reserved": true,
"resourceType": "role",
"restid": "myRole",
"self": "https://host:port/rest/instances/{instanceId}/roles/{roleName}",
"users": "https://host:port/streams/domains/{domainId}/users"
}

List domain secured objects

This collection resource provides access to information about secured objects for the domain.

Authorizations:

authBasic

path Parameters

domainId

required

string

Example: myDomain

Specifies the unique identifier for the domain.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/securedobjects?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/securedobjects?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/securedobjects?count=10&page=3",
"previous": "https://host:port/streams/domains/{domainId}/securedobjects?count=10&page=1",
"resourceType": "securedObjectList",
"securedObjects": [{"defaultPermissions": "https://host:port/streams/instances/{instanceId}/securedobjects/{securedObjectName}/defaultPermissions",
"domain": "https://host:port/streams/domains/{domainId}",
"name": "config",
"owner": "streamsadmin",
"parent": "instance",
"permissions": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions",
"resourceType": "securedObject",
"restid": "config",
"self": "https://host:port/rest/instances/{instanceId}/securedobjects/{securedObjectName}"
}
],
"total": 50
}

Get domain secured object

This element resource provides access to information for a secured object.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
securedObjectName required	string Example: config Identifies the secured object name.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"defaultPermissions": "https://host:port/streams/instances/{instanceId}/securedobjects/{securedObjectName}/defaultPermissions",
"domain": "https://host:port/streams/domains/{domainId}",
"name": "config",
"owner": "streamsadmin",
"parent": "instance",
"permissions": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions",
"resourceType": "securedObject",
"restid": "config",
"self": "https://host:port/rest/instances/{instanceId}/securedobjects/{securedObjectName}"
}

List domain users

This collection resource provides access to information about the users known to the domain.

Authorizations:

authBasic

path Parameters

domainId

required

string

Example: myDomain

Specifies the unique identifier for the domain.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
role.restid	string Example: role.restid=InstanceAdministrator Specifies the value of the restid property for a role resource. If this parameter is used, the list is limited to the resources for the specified role.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/users?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/users?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/users?count=10&page=3",
"previous": "https://host:port/streams/domains/{domainId}/users?count=10&page=1",
"resourceType": "userList",
"total": 50,
"users": [{"defaultPermissions": "https://host:port/streams/domains/{domainId}/users/{userName}/defaultPermissions",
"domain": "https://host:port/streams/domains/{domainId}",
"name": "janet",
"permissions": "https://host:port/streams/domains/{domainId}/users/{userName}/permissions",
"reserved": true,
"resolvedPermissions": "https://host:port/streams/instances/{instanceId}/users/{userName}/resolvedpermissions",
"resourceType": "user",
"restid": "janet",
"roles": "https://host:port/streams/domains/{domainId}/roles",
"self": "https://host:port/rest/instances/{instanceId}/users/{userName}"
}
]
}

Get domain user

This element resource provides access to information for a user.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
userName required	string Example: streamsadmin Identifies the user name.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"defaultPermissions": "https://host:port/streams/domains/{domainId}/users/{userName}/defaultPermissions",
"domain": "https://host:port/streams/domains/{domainId}",
"name": "janet",
"permissions": "https://host:port/streams/domains/{domainId}/users/{userName}/permissions",
"reserved": true,
"resolvedPermissions": "https://host:port/streams/instances/{instanceId}/users/{userName}/resolvedpermissions",
"resourceType": "user",
"restid": "janet",
"roles": "https://host:port/streams/domains/{domainId}/roles",
"self": "https://host:port/rest/instances/{instanceId}/users/{userName}"
}

List instance groups

This collection resource provides access to information about the groups in the instance.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
role.restid	string Example: role.restid=InstanceAdministrator Specifies the value of the restid property for a role resource. If this parameter is used, the list is limited to the resources for the specified role.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/groups?count=10&page=1",
"groups": [{"defaultPermissions": "https://host:port/streams/instances/{instanceId}/groups/{groupName}/defaultPermissions",
"domain": "https://host:port/streams/domains/{domainId}",
"name": "accounting",
"permissions": "https://host:port/streams/domains/{domainId}/groups/{groupName}/permissions",
"reserved": false,
"resourceType": "group",
"restid": "accounting",
"roles": "https://host:port/streams/domains/{domainId}/roles",
"self": "https://host:port/rest/instances/{instanceId}/groups/{groupName}"
}
],
"last": "https://host:port/streams/domains/{domainId}/groups?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/groups?count=10&page=3",
"previous": "https://host:port/streams/domains/{domainId}/groups?count=10&page=1",
"resourceType": "groupList",
"total": 50
}

Get instance group

This element resource provides access to information about a group.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
groupName required	string Example: myGroup Identifies the group name.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"defaultPermissions": "https://host:port/streams/instances/{instanceId}/groups/{groupName}/defaultPermissions",
"domain": "https://host:port/streams/domains/{domainId}",
"name": "accounting",
"permissions": "https://host:port/streams/domains/{domainId}/groups/{groupName}/permissions",
"reserved": false,
"resourceType": "group",
"restid": "accounting",
"roles": "https://host:port/streams/domains/{domainId}/roles",
"self": "https://host:port/rest/instances/{instanceId}/groups/{groupName}"
}

List instance roles

This collection resource provides access to information about the roles in the instance.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
group.restid	string Example: group.restid=myGroup Specifies the value of the restid property for a group resource. If this parameter is used, the list is limited to the resources for the specified group.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.
user.restid	string Example: user.restid=streamsadmin Specifies the value of the restid property for a user resource. If this parameter is used, the list is limited to the resources for the specified user.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/roles?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/roles?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/roles?count=10&page=3",
"previous": "https://host:port/streams/domains/{domainId}/roles?count=10&page=1",
"resourceType": "roleList",
"roles": [{"defaultPermissions": "https://host:port/streams/domains/{domainId}/roles/{roleName}/defaultPermissions",
"domain": "https://host:port/streams/domains/{domainId}",
"groups": "https://host:port/streams/domains/{domainId}/groups",
"name": "myRole",
"permissions": "https://host:port/streams/domains/{domainId}/roles/{roleName}/permissions",
"reserved": true,
"resourceType": "role",
"restid": "myRole",
"self": "https://host:port/rest/instances/{instanceId}/roles/{roleName}",
"users": "https://host:port/streams/domains/{domainId}/users"
}
],
"total": 50
}

Create instance role

This method provides the ability to create a new role.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

Request Body schema: application/json
required

name

required

string

Identifies the name of the role to create.

Responses

Request samples

Payload

Content type

application/json

{"name": "myRole"
}

Response samples

201
400
403
404
500

Content type

application/json

{"defaultPermissions": "https://host:port/streams/domains/{domainId}/roles/{roleName}/defaultPermissions",
"domain": "https://host:port/streams/domains/{domainId}",
"groups": "https://host:port/streams/domains/{domainId}/groups",
"name": "myRole",
"permissions": "https://host:port/streams/domains/{domainId}/roles/{roleName}/permissions",
"reserved": true,
"resourceType": "role",
"restid": "myRole",
"self": "https://host:port/rest/instances/{instanceId}/roles/{roleName}",
"users": "https://host:port/streams/domains/{domainId}/users"
}

Delete instance role

This method provides the ability to remove the role from the instance.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
roleName required	string Example: InstanceAdministrator Identifies the role name

Responses

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

Get instance role

This element resource provides access to information about a role.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
roleName required	string Example: InstanceAdministrator Identifies the role name

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"defaultPermissions": "https://host:port/streams/domains/{domainId}/roles/{roleName}/defaultPermissions",
"domain": "https://host:port/streams/domains/{domainId}",
"groups": "https://host:port/streams/domains/{domainId}/groups",
"name": "myRole",
"permissions": "https://host:port/streams/domains/{domainId}/roles/{roleName}/permissions",
"reserved": true,
"resourceType": "role",
"restid": "myRole",
"self": "https://host:port/rest/instances/{instanceId}/roles/{roleName}",
"users": "https://host:port/streams/domains/{domainId}/users"
}

Update instance role

This method provides the ability to add and remove users and groups from a role.

Note: If your REST client does not support the PATCH method, you can use the POST method with the request header X-HTTP-Method-Override=PATCH specified.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
roleName required	string Example: InstanceAdministrator Identifies the role name

Request Body schema: application/json
required

groups.add	Array of strings (optional) Specifies a list of groups to add to the role.
groups.remove	Array of strings (optional) Specifies a list of groups to remove from the role.
users.add	Array of strings (optional) Specifies a list of users to add to the role.
users.remove	Array of strings (optional) Specifies a list of users to remove from the role.

Responses

Request samples

Payload

Content type

application/json

{"groups.add": ["twins"
],
"groups.remove": ["vikings"
],
"users.add": ["john"
],
"users.remove": ["mary"
]
}

Response samples

200
400
403
404
500

Content type

application/json

{"defaultPermissions": "https://host:port/streams/domains/{domainId}/roles/{roleName}/defaultPermissions",
"domain": "https://host:port/streams/domains/{domainId}",
"groups": "https://host:port/streams/domains/{domainId}/groups",
"name": "myRole",
"permissions": "https://host:port/streams/domains/{domainId}/roles/{roleName}/permissions",
"reserved": true,
"resourceType": "role",
"restid": "myRole",
"self": "https://host:port/rest/instances/{instanceId}/roles/{roleName}",
"users": "https://host:port/streams/domains/{domainId}/users"
}

List instance secured objects

This collection resource provides access to information about secured objects for the instance.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/securedobjects?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/securedobjects?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/securedobjects?count=10&page=3",
"previous": "https://host:port/streams/domains/{domainId}/securedobjects?count=10&page=1",
"resourceType": "securedObjectList",
"securedObjects": [{"defaultPermissions": "https://host:port/streams/instances/{instanceId}/securedobjects/{securedObjectName}/defaultPermissions",
"domain": "https://host:port/streams/domains/{domainId}",
"name": "config",
"owner": "streamsadmin",
"parent": "instance",
"permissions": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions",
"resourceType": "securedObject",
"restid": "config",
"self": "https://host:port/rest/instances/{instanceId}/securedobjects/{securedObjectName}"
}
],
"total": 50
}

Get instance secured object

This element resource provides access to information for a secured object.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
securedObjectName required	string Example: config Identifies the secured object name.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"defaultPermissions": "https://host:port/streams/instances/{instanceId}/securedobjects/{securedObjectName}/defaultPermissions",
"domain": "https://host:port/streams/domains/{domainId}",
"name": "config",
"owner": "streamsadmin",
"parent": "instance",
"permissions": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions",
"resourceType": "securedObject",
"restid": "config",
"self": "https://host:port/rest/instances/{instanceId}/securedobjects/{securedObjectName}"
}

List instance users

This collection resource provides access to information about the users known to the instance.

Authorizations:

authBasic

path Parameters

instanceId

required

string

Example: myInstance

Specifies the unique identifier for the instance.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
role.restid	string Example: role.restid=InstanceAdministrator Specifies the value of the restid property for a role resource. If this parameter is used, the list is limited to the resources for the specified role.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/users?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/users?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/users?count=10&page=3",
"previous": "https://host:port/streams/domains/{domainId}/users?count=10&page=1",
"resourceType": "userList",
"total": 50,
"users": [{"defaultPermissions": "https://host:port/streams/domains/{domainId}/users/{userName}/defaultPermissions",
"domain": "https://host:port/streams/domains/{domainId}",
"name": "janet",
"permissions": "https://host:port/streams/domains/{domainId}/users/{userName}/permissions",
"reserved": true,
"resolvedPermissions": "https://host:port/streams/instances/{instanceId}/users/{userName}/resolvedpermissions",
"resourceType": "user",
"restid": "janet",
"roles": "https://host:port/streams/domains/{domainId}/roles",
"self": "https://host:port/rest/instances/{instanceId}/users/{userName}"
}
]
}

Get instance user

This element resource provides access to information for a user.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
userName required	string Example: streamsadmin Identifies the user name.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"defaultPermissions": "https://host:port/streams/domains/{domainId}/users/{userName}/defaultPermissions",
"domain": "https://host:port/streams/domains/{domainId}",
"name": "janet",
"permissions": "https://host:port/streams/domains/{domainId}/users/{userName}/permissions",
"reserved": true,
"resolvedPermissions": "https://host:port/streams/instances/{instanceId}/users/{userName}/resolvedpermissions",
"resourceType": "user",
"restid": "janet",
"roles": "https://host:port/streams/domains/{domainId}/roles",
"self": "https://host:port/rest/instances/{instanceId}/users/{userName}"
}

Security - Permissions

APIs for managing security permissions.

List domain group default permissions

This collection resource provides access to information about the default permissions for a group.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
groupName required	string Example: myGroup Identifies the group name.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
securedObject.restid	string Example: securedObject.restid=config Specifies the value of the restid property for a secured object resource. If this parameter is used, the list is limited to the resources for the specified secured object.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=3",
"permissions": [{"add": true,
"delete": true,
"own": true,
"principal": "https://host:port/streams/domains/{domainId}/groups/{groupName}",
"read": true,
"resourceType": "permissions",
"search": true,
"securedObject": "https://host:port/streams/instances/{instanceId}/securedobjects/{securedObjectName}",
"write": true
}
],
"previous": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"resourceType": "instanceList",
"total": 50
}

List domain group permissions

This collection resource provides access to information about the permissions for a group.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
groupName required	string Example: myGroup Identifies the group name.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
securedObject.restid	string Example: securedObject.restid=config Specifies the value of the restid property for a secured object resource. If this parameter is used, the list is limited to the resources for the specified secured object.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=3",
"permissions": [{"add": true,
"delete": true,
"own": true,
"principal": "https://host:port/streams/domains/{domainId}/groups/{groupName}",
"read": true,
"resourceType": "permissions",
"search": true,
"securedObject": "https://host:port/streams/instances/{instanceId}/securedobjects/{securedObjectName}",
"write": true
}
],
"previous": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"resourceType": "instanceList",
"total": 50
}

List domain role default permissions

This collection resource provides access to information about the default permissions for a role.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
roleName required	string Example: InstanceAdministrator Identifies the role name

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
securedObject.restid	string Example: securedObject.restid=config Specifies the value of the restid property for a secured object resource. If this parameter is used, the list is limited to the resources for the specified secured object.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=3",
"permissions": [{"add": true,
"delete": true,
"own": true,
"principal": "https://host:port/streams/domains/{domainId}/groups/{groupName}",
"read": true,
"resourceType": "permissions",
"search": true,
"securedObject": "https://host:port/streams/instances/{instanceId}/securedobjects/{securedObjectName}",
"write": true
}
],
"previous": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"resourceType": "instanceList",
"total": 50
}

List domain role permissions

This collection resource provides access to information about permissions for a role.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
roleName required	string Example: InstanceAdministrator Identifies the role name

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
securedObject.restid	string Example: securedObject.restid=config Specifies the value of the restid property for a secured object resource. If this parameter is used, the list is limited to the resources for the specified secured object.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=3",
"permissions": [{"add": true,
"delete": true,
"own": true,
"principal": "https://host:port/streams/domains/{domainId}/groups/{groupName}",
"read": true,
"resourceType": "permissions",
"search": true,
"securedObject": "https://host:port/streams/instances/{instanceId}/securedobjects/{securedObjectName}",
"write": true
}
],
"previous": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"resourceType": "instanceList",
"total": 50
}

Remove domain secured object default permissions

This method provides the ability to remove secured object default permissions for a principal. The principal is specified by providing one of the following query parameters:

group.restid
role.restid
user.restid

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
securedObjectName required	string Example: config Identifies the secured object name.

query Parameters

group.restid	string Example: group.restid=myGroup Specifies the value of the restid property for a group resource. If this parameter is used, the list is limited to the resources for the specified group.
role.restid	string Example: role.restid=InstanceAdministrator Specifies the value of the restid property for a role resource. If this parameter is used, the list is limited to the resources for the specified role.
user.restid	string Example: user.restid=streamsadmin Specifies the value of the restid property for a user resource. If this parameter is used, the list is limited to the resources for the specified user.

Responses

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

List domain secured object default permissions

This collection resource provides access to information about default permissions for new child objects of a secured object.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
securedObjectName required	string Example: config Identifies the secured object name.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
group.restid	string Example: group.restid=myGroup Specifies the value of the restid property for a group resource. If this parameter is used, the list is limited to the resources for the specified group.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
role.restid	string Example: role.restid=InstanceAdministrator Specifies the value of the restid property for a role resource. If this parameter is used, the list is limited to the resources for the specified role.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.
user.restid	string Example: user.restid=streamsadmin Specifies the value of the restid property for a user resource. If this parameter is used, the list is limited to the resources for the specified user.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=3",
"permissions": [{"add": true,
"delete": true,
"own": true,
"principal": "https://host:port/streams/domains/{domainId}/groups/{groupName}",
"read": true,
"resourceType": "permissions",
"search": true,
"securedObject": "https://host:port/streams/instances/{instanceId}/securedobjects/{securedObjectName}",
"write": true
}
],
"previous": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"resourceType": "instanceList",
"total": 50
}

Update domain secured object default permissions

This method provides the ability to update default permissions to a secured object for a Streams principal.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
securedObjectName required	string Example: config Identifies the secured object name.

Request Body schema: application/json
required

principal required	string The user, group, or role for which the permissions apply.
principalType required	string Enum: "group" "role" "user" Identifies the type of the specified principal.
permissionTypes.add	Array of strings Items Enum: "add" "delete" "own" "read" "search" "write" Identifies the secured object permission types to add for the specified principal.
permissionTypes.remove	Array of strings Items Enum: "add" "delete" "own" "read" "search" "write" Identifies the secured object permission types to remove for the specified principal.

Responses

Request samples

Payload

Content type

application/json

{"principal": "Alex",
"principalType": "user",
"permissionTypes.add": ["read"
],
"permissionTypes.remove": ["delete"
]
}

Response samples

200
400
403
404
500

Content type

application/json

{"add": true,
"delete": true,
"own": true,
"principal": "https://host:port/streams/domains/{domainId}/groups/{groupName}",
"read": true,
"resourceType": "permissions",
"search": true,
"securedObject": "https://host:port/streams/instances/{instanceId}/securedobjects/{securedObjectName}",
"write": true
}

Remove domain secured object permissions

This method provides the ability to remove secured object permissions for a principal. The principal is specified by providing one of the following query parameters:

group.restid
role.restid
user.restid

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
securedObjectName required	string Example: config Identifies the secured object name.

query Parameters

group.restid	string Example: group.restid=myGroup Specifies the value of the restid property for a group resource. If this parameter is used, the list is limited to the resources for the specified group.
role.restid	string Example: role.restid=InstanceAdministrator Specifies the value of the restid property for a role resource. If this parameter is used, the list is limited to the resources for the specified role.
user.restid	string Example: user.restid=streamsadmin Specifies the value of the restid property for a user resource. If this parameter is used, the list is limited to the resources for the specified user.

Responses

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

List domain secured object permissions

This collection resource provides access to information about the permission for a secured object.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
securedObjectName required	string Example: config Identifies the secured object name.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
group.restid	string Example: group.restid=myGroup Specifies the value of the restid property for a group resource. If this parameter is used, the list is limited to the resources for the specified group.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
role.restid	string Example: role.restid=InstanceAdministrator Specifies the value of the restid property for a role resource. If this parameter is used, the list is limited to the resources for the specified role.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.
user.restid	string Example: user.restid=streamsadmin Specifies the value of the restid property for a user resource. If this parameter is used, the list is limited to the resources for the specified user.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=3",
"permissions": [{"add": true,
"delete": true,
"own": true,
"principal": "https://host:port/streams/domains/{domainId}/groups/{groupName}",
"read": true,
"resourceType": "permissions",
"search": true,
"securedObject": "https://host:port/streams/instances/{instanceId}/securedobjects/{securedObjectName}",
"write": true
}
],
"previous": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"resourceType": "instanceList",
"total": 50
}

Update domain secured object permissions

This method provides the ability to update permissions to a secured object for a Streams principal.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
securedObjectName required	string Example: config Identifies the secured object name.

Request Body schema: application/json
required

principal required	string The user, group, or role for which the permissions apply.
principalType required	string Enum: "group" "role" "user" Identifies the type of the specified principal.
permissionTypes.add	Array of strings Items Enum: "add" "delete" "own" "read" "search" "write" Identifies the secured object permission types to add for the specified principal.
permissionTypes.remove	Array of strings Items Enum: "add" "delete" "own" "read" "search" "write" Identifies the secured object permission types to remove for the specified principal.

Responses

Request samples

Payload

Content type

application/json

{"principal": "Alex",
"principalType": "user",
"permissionTypes.add": ["read"
],
"permissionTypes.remove": ["delete"
]
}

Response samples

200
400
403
404
500

Content type

application/json

{"add": true,
"delete": true,
"own": true,
"principal": "https://host:port/streams/domains/{domainId}/groups/{groupName}",
"read": true,
"resourceType": "permissions",
"search": true,
"securedObject": "https://host:port/streams/instances/{instanceId}/securedobjects/{securedObjectName}",
"write": true
}

List domain user default permissions

This collection resource provides access to information about the default permission for a user.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
userName required	string Example: streamsadmin Identifies the user name.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
securedObject.restid	string Example: securedObject.restid=config Specifies the value of the restid property for a secured object resource. If this parameter is used, the list is limited to the resources for the specified secured object.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=3",
"permissions": [{"add": true,
"delete": true,
"own": true,
"principal": "https://host:port/streams/domains/{domainId}/groups/{groupName}",
"read": true,
"resourceType": "permissions",
"search": true,
"securedObject": "https://host:port/streams/instances/{instanceId}/securedobjects/{securedObjectName}",
"write": true
}
],
"previous": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"resourceType": "instanceList",
"total": 50
}

List domain user permissions

This collection resource provides access to information about the permissions for a user.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
userName required	string Example: streamsadmin Identifies the user name.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
securedObject.restid	string Example: securedObject.restid=config Specifies the value of the restid property for a secured object resource. If this parameter is used, the list is limited to the resources for the specified secured object.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=3",
"permissions": [{"add": true,
"delete": true,
"own": true,
"principal": "https://host:port/streams/domains/{domainId}/groups/{groupName}",
"read": true,
"resourceType": "permissions",
"search": true,
"securedObject": "https://host:port/streams/instances/{instanceId}/securedobjects/{securedObjectName}",
"write": true
}
],
"previous": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"resourceType": "instanceList",
"total": 50
}

List domain user resolved permissions

This collection resource provides access to information about the resolved permissions for a user. A resolved permission is a permission a user has to a secured object either by permission being granted to the user, a group to which the user belongs, or a role which the user has been assigned.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
userName required	string Example: streamsadmin Identifies the user name.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
securedObject.restid	string Example: securedObject.restid=config Specifies the value of the restid property for a secured object resource. If this parameter is used, the list is limited to the resources for the specified secured object.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=3",
"permissions": [{"add": true,
"delete": true,
"own": true,
"principal": "https://host:port/streams/domains/{domainId}/groups/{groupName}",
"read": true,
"resourceType": "permissions",
"search": true,
"securedObject": "https://host:port/streams/instances/{instanceId}/securedobjects/{securedObjectName}",
"write": true
}
],
"previous": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"resourceType": "instanceList",
"total": 50
}

List instance group default permissions

This collection resource provides access to information about the default permissions for a group.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
groupName required	string Example: myGroup Identifies the group name.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
securedObject.restid	string Example: securedObject.restid=config Specifies the value of the restid property for a secured object resource. If this parameter is used, the list is limited to the resources for the specified secured object.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=3",
"permissions": [{"add": true,
"delete": true,
"own": true,
"principal": "https://host:port/streams/domains/{domainId}/groups/{groupName}",
"read": true,
"resourceType": "permissions",
"search": true,
"securedObject": "https://host:port/streams/instances/{instanceId}/securedobjects/{securedObjectName}",
"write": true
}
],
"previous": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"resourceType": "instanceList",
"total": 50
}

List instance group permissions

This collection resource provides access to information about the permissions for a group.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
groupName required	string Example: myGroup Identifies the group name.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
securedObject.restid	string Example: securedObject.restid=config Specifies the value of the restid property for a secured object resource. If this parameter is used, the list is limited to the resources for the specified secured object.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=3",
"permissions": [{"add": true,
"delete": true,
"own": true,
"principal": "https://host:port/streams/domains/{domainId}/groups/{groupName}",
"read": true,
"resourceType": "permissions",
"search": true,
"securedObject": "https://host:port/streams/instances/{instanceId}/securedobjects/{securedObjectName}",
"write": true
}
],
"previous": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"resourceType": "instanceList",
"total": 50
}

List instance role default permissions

This collection resource provides access to information about the default permissions for a role.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
roleName required	string Example: InstanceAdministrator Identifies the role name

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
securedObject.restid	string Example: securedObject.restid=config Specifies the value of the restid property for a secured object resource. If this parameter is used, the list is limited to the resources for the specified secured object.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=3",
"permissions": [{"add": true,
"delete": true,
"own": true,
"principal": "https://host:port/streams/domains/{domainId}/groups/{groupName}",
"read": true,
"resourceType": "permissions",
"search": true,
"securedObject": "https://host:port/streams/instances/{instanceId}/securedobjects/{securedObjectName}",
"write": true
}
],
"previous": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"resourceType": "instanceList",
"total": 50
}

List instance role permissions

This collection resource provides access to information about permissions for a role.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
roleName required	string Example: InstanceAdministrator Identifies the role name

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
securedObject.restid	string Example: securedObject.restid=config Specifies the value of the restid property for a secured object resource. If this parameter is used, the list is limited to the resources for the specified secured object.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=3",
"permissions": [{"add": true,
"delete": true,
"own": true,
"principal": "https://host:port/streams/domains/{domainId}/groups/{groupName}",
"read": true,
"resourceType": "permissions",
"search": true,
"securedObject": "https://host:port/streams/instances/{instanceId}/securedobjects/{securedObjectName}",
"write": true
}
],
"previous": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"resourceType": "instanceList",
"total": 50
}

Remove instance secured object default permissions

This method provides the ability to remove secured object default permissions for a principal. The principal is specified by providing one of the following query parameters:

group.restid
role.restid
user.restid

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
securedObjectName required	string Example: config Identifies the secured object name.

query Parameters

group.restid	string Example: group.restid=myGroup Specifies the value of the restid property for a group resource. If this parameter is used, the list is limited to the resources for the specified group.
role.restid	string Example: role.restid=InstanceAdministrator Specifies the value of the restid property for a role resource. If this parameter is used, the list is limited to the resources for the specified role.
user.restid	string Example: user.restid=streamsadmin Specifies the value of the restid property for a user resource. If this parameter is used, the list is limited to the resources for the specified user.

Responses

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

List instance secured object default permissions

This collection resource provides access to information about default permissions for new child objects of a secured object.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
securedObjectName required	string Example: config Identifies the secured object name.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
group.restid	string Example: group.restid=myGroup Specifies the value of the restid property for a group resource. If this parameter is used, the list is limited to the resources for the specified group.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
role.restid	string Example: role.restid=InstanceAdministrator Specifies the value of the restid property for a role resource. If this parameter is used, the list is limited to the resources for the specified role.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.
user.restid	string Example: user.restid=streamsadmin Specifies the value of the restid property for a user resource. If this parameter is used, the list is limited to the resources for the specified user.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=3",
"permissions": [{"add": true,
"delete": true,
"own": true,
"principal": "https://host:port/streams/domains/{domainId}/groups/{groupName}",
"read": true,
"resourceType": "permissions",
"search": true,
"securedObject": "https://host:port/streams/instances/{instanceId}/securedobjects/{securedObjectName}",
"write": true
}
],
"previous": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"resourceType": "instanceList",
"total": 50
}

Update instance secured object default permissions

This method provides the ability to update default permissions to a secured object for a Streams principal.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
securedObjectName required	string Example: config Identifies the secured object name.

Request Body schema: application/json
required

principal required	string The user, group, or role for which the permissions apply.
principalType required	string Enum: "group" "role" "user" Identifies the type of the specified principal.
permissionTypes.add	Array of strings Items Enum: "add" "delete" "own" "read" "search" "write" Identifies the secured object permission types to add for the specified principal.
permissionTypes.remove	Array of strings Items Enum: "add" "delete" "own" "read" "search" "write" Identifies the secured object permission types to remove for the specified principal.

Responses

Request samples

Payload

Content type

application/json

{"principal": "Alex",
"principalType": "user",
"permissionTypes.add": ["read"
],
"permissionTypes.remove": ["delete"
]
}

Response samples

200
400
403
404
500

Content type

application/json

{"add": true,
"delete": true,
"own": true,
"principal": "https://host:port/streams/domains/{domainId}/groups/{groupName}",
"read": true,
"resourceType": "permissions",
"search": true,
"securedObject": "https://host:port/streams/instances/{instanceId}/securedobjects/{securedObjectName}",
"write": true
}

Remove instance secured object permissions

This method provides the ability to remove secured object permissions for a principal. The principal is specified by providing one of the following query parameters:

group.restid
role.restid
user.restid

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
securedObjectName required	string Example: config Identifies the secured object name.

query Parameters

group.restid	string Example: group.restid=myGroup Specifies the value of the restid property for a group resource. If this parameter is used, the list is limited to the resources for the specified group.
role.restid	string Example: role.restid=InstanceAdministrator Specifies the value of the restid property for a role resource. If this parameter is used, the list is limited to the resources for the specified role.
user.restid	string Example: user.restid=streamsadmin Specifies the value of the restid property for a user resource. If this parameter is used, the list is limited to the resources for the specified user.

Responses

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

List instance secured object permissions

This collection resource provides access to information about the permission for a secured object.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
securedObjectName required	string Example: config Identifies the secured object name.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
group.restid	string Example: group.restid=myGroup Specifies the value of the restid property for a group resource. If this parameter is used, the list is limited to the resources for the specified group.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
role.restid	string Example: role.restid=InstanceAdministrator Specifies the value of the restid property for a role resource. If this parameter is used, the list is limited to the resources for the specified role.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.
user.restid	string Example: user.restid=streamsadmin Specifies the value of the restid property for a user resource. If this parameter is used, the list is limited to the resources for the specified user.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=3",
"permissions": [{"add": true,
"delete": true,
"own": true,
"principal": "https://host:port/streams/domains/{domainId}/groups/{groupName}",
"read": true,
"resourceType": "permissions",
"search": true,
"securedObject": "https://host:port/streams/instances/{instanceId}/securedobjects/{securedObjectName}",
"write": true
}
],
"previous": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"resourceType": "instanceList",
"total": 50
}

Update instance secured object permissions

This method provides the ability to update permissions to a secured object for a Streams principal.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
securedObjectName required	string Example: config Identifies the secured object name.

Request Body schema: application/json
required

principal required	string The user, group, or role for which the permissions apply.
principalType required	string Enum: "group" "role" "user" Identifies the type of the specified principal.
permissionTypes.add	Array of strings Items Enum: "add" "delete" "own" "read" "search" "write" Identifies the secured object permission types to add for the specified principal.
permissionTypes.remove	Array of strings Items Enum: "add" "delete" "own" "read" "search" "write" Identifies the secured object permission types to remove for the specified principal.

Responses

Request samples

Payload

Content type

application/json

{"principal": "Alex",
"principalType": "user",
"permissionTypes.add": ["read"
],
"permissionTypes.remove": ["delete"
]
}

Response samples

200
400
403
404
500

Content type

application/json

{"add": true,
"delete": true,
"own": true,
"principal": "https://host:port/streams/domains/{domainId}/groups/{groupName}",
"read": true,
"resourceType": "permissions",
"search": true,
"securedObject": "https://host:port/streams/instances/{instanceId}/securedobjects/{securedObjectName}",
"write": true
}

List instance user default permissions

This collection resource provides access to information about the default permission for a user.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
userName required	string Example: streamsadmin Identifies the user name.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
securedObject.restid	string Example: securedObject.restid=config Specifies the value of the restid property for a secured object resource. If this parameter is used, the list is limited to the resources for the specified secured object.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=3",
"permissions": [{"add": true,
"delete": true,
"own": true,
"principal": "https://host:port/streams/domains/{domainId}/groups/{groupName}",
"read": true,
"resourceType": "permissions",
"search": true,
"securedObject": "https://host:port/streams/instances/{instanceId}/securedobjects/{securedObjectName}",
"write": true
}
],
"previous": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"resourceType": "instanceList",
"total": 50
}

List instance user permissions

This collection resource provides access to information about the permissions for a user.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
userName required	string Example: streamsadmin Identifies the user name.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
securedObject.restid	string Example: securedObject.restid=config Specifies the value of the restid property for a secured object resource. If this parameter is used, the list is limited to the resources for the specified secured object.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=3",
"permissions": [{"add": true,
"delete": true,
"own": true,
"principal": "https://host:port/streams/domains/{domainId}/groups/{groupName}",
"read": true,
"resourceType": "permissions",
"search": true,
"securedObject": "https://host:port/streams/instances/{instanceId}/securedobjects/{securedObjectName}",
"write": true
}
],
"previous": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"resourceType": "instanceList",
"total": 50
}

List instance user resolved permissions

This collection resource provides access to information about the resolved permissions for a user. A resolved permission is a permission a user has to a secured object either by permission being granted to the user, a group to which the user belongs, or a role which the user has been assigned.

Authorizations:

authBasic

path Parameters

instanceId required	string Example: myInstance Specifies the unique identifier for the instance.
userName required	string Example: streamsadmin Identifies the user name.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
securedObject.restid	string Example: securedObject.restid=config Specifies the value of the restid property for a secured object resource. If this parameter is used, the list is limited to the resources for the specified secured object.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=3",
"permissions": [{"add": true,
"delete": true,
"own": true,
"principal": "https://host:port/streams/domains/{domainId}/groups/{groupName}",
"read": true,
"resourceType": "permissions",
"search": true,
"securedObject": "https://host:port/streams/instances/{instanceId}/securedobjects/{securedObjectName}",
"write": true
}
],
"previous": "https://host:port/streams/domains/{domainId}/securedobjects/{securedObjectName}/permissions?count=10&page=1",
"resourceType": "instanceList",
"total": 50
}

Security - Cross origin requests

APIs for managing cross origins request support.

List trusted origins

This collection resource provides access to information about trusted origins for the domain.

Authorizations:

authBasic

path Parameters

domainId

required

string

Example: myDomain

Specifies the unique identifier for the domain.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/trustedorigins?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/trustedorigins?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/trustedorigins?count=10&page=3",
"previous": "https://host:port/streams/domains/{domainId}/trustedorigins?count=10&page=1",
"resourceType": "trustedOriginList",
"total": 50,
"trustedOrigins": [{"domain": "https://host:port/streams/domains/{domainId}",
"name": "http://myserver.com:8080",
"resourceType": "trustedOrigin",
"restid": "http://myserver.com:8080",
"self": "https://host:port/rest/instances/{instanceId}/trustedorigins/{trustedOriginName}"
}
]
}

Add trusted origin

This method provides the ability to add a trusted origin to the domain.

Authorizations:

authBasic

path Parameters

domainId

required

string

Example: myDomain

Specifies the unique identifier for the domain.

Request Body schema: application/json
required

name

required

string

Identifies the trusted origin to add. The origin should contain the scheme, host, and port and be a case-sensitive match for the value provided by the HTTP Origin header on the cross-origin request.

Responses

Request samples

Payload

Content type

application/json

{"name": "https://host:port"
}

Response samples

201
400
403
404
500

Content type

application/json

{"domain": "https://host:port/streams/domains/{domainId}",
"name": "http://myserver.com:8080",
"resourceType": "trustedOrigin",
"restid": "http://myserver.com:8080",
"self": "https://host:port/rest/instances/{instanceId}/trustedorigins/{trustedOriginName}"
}

Remove trusted origin

This method provides the ability to remove the trusted origin from the domain.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
trustedOriginName required	string Example: https%3a%2f%2fhost%3aport Identifies the trusted origin name.

Responses

Response samples

400
403
404
500

Content type

application/json

{"messages": [{"id": "CDISWxxxxE",
"message": "CDISWxxxxE The message associated with the error.",
"status": "error"
}
]
}

Get trusted origin

This element resource provides access to information about a trusted origin.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
trustedOriginName required	string Example: https%3a%2f%2fhost%3aport Identifies the trusted origin name.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"domain": "https://host:port/streams/domains/{domainId}",
"name": "http://myserver.com:8080",
"resourceType": "trustedOrigin",
"restid": "http://myserver.com:8080",
"self": "https://host:port/rest/instances/{instanceId}/trustedorigins/{trustedOriginName}"
}

Installation

APIs for accessing Streams installation information.

List resource installations

This collection resource provides information about all installations with the same base installation path as the installation that runs the domain controller service on the specified resource.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
resourceId required	string Example: management-0 Specifies the unique identifier for the resource.

query Parameters

fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/installations?count=10&page=1",
"installations": [{"architecture": "x86_64",
"buildVersion": "20250310145500",
"editionName": "Teracloud Streams",
"fullProductVersion": "7.2.0.0",
"hotFix": "string",
"installPath": "/home/joeuser/streams/7.2.0.0",
"minimumOSBaseVersion": "8",
"minimumOSPatchVersion": "0",
"minimumOSVersion": "Red Hat Enterprise Linux Server release 8.0 (Ootpa)",
"owner": "joeuser",
"productName": "Teracloud Streams",
"productVersion": "7.2.0.0",
"resourceType": "installation"
}
],
"last": "https://host:port/streams/installations?count=10&page=-1",
"next": "https://host:port/streams/installations?count=10&page=3",
"previous": "https://host:port/streams/installations?count=10&page=1",
"resourceType": "installationList",
"total": 50
}

List installations

This collection resource provides information about all installations with the same base installation path used to run this management REST API service.

Authorizations:

authBasic

query Parameters

fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/installations?count=10&page=1",
"installations": [{"architecture": "x86_64",
"buildVersion": "20250310145500",
"editionName": "Teracloud Streams",
"fullProductVersion": "7.2.0.0",
"hotFix": "string",
"installPath": "/home/joeuser/streams/7.2.0.0",
"minimumOSBaseVersion": "8",
"minimumOSPatchVersion": "0",
"minimumOSVersion": "Red Hat Enterprise Linux Server release 8.0 (Ootpa)",
"owner": "joeuser",
"productName": "Teracloud Streams",
"productVersion": "7.2.0.0",
"resourceType": "installation"
}
],
"last": "https://host:port/streams/installations?count=10&page=-1",
"next": "https://host:port/streams/installations?count=10&page=3",
"previous": "https://host:port/streams/installations?count=10&page=1",
"resourceType": "installationList",
"total": 50
}

ZooKeeper

APIs for accessing ZooKeeper ensemble and node information.

Get ZooKeeper ensemble

This element resource provides access to information about the ZooKeeper ensemble associated with the domain.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
ensembleId required	string Example: 1.2.3.4:2000,1.2.3.5:2000,1.2.3.6:2000 Identifies the name of the ZooKeeper ensemble.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"domain": "https://host:port/streams/domains/{domainId}",
"name": "1.2.3.4:2000,1.2.3.5:2000,1.2.3.6:2000",
"nodes": "https://host:port/rest/domains/{domainId}/zookeeperensembles/{ensembleId}/nodes",
"resourceType": "zooKeeperEnsemble",
"restid": "1.2.3.4:2000,1.2.3.5:2000,1.2.3.6:2000",
"self": "https://host:port/rest/domains/{domainId}/zookeeperensembles/{ensembleId}",
"status": "up"
}

List ZooKeeper nodes

This collection resource provides access to information about the ZooKeeper nodes used by the domain.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
ensembleId required	string Example: 1.2.3.4:2000,1.2.3.5:2000,1.2.3.6:2000 Identifies the name of the ZooKeeper ensemble.

query Parameters

count	integer <int64> Example: count=10 Specifies the maximum number of items to return. By default, all items are returned.
fields	string Example: fields=restid,resourceType Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.
listFields	string Example: listFields=total Specifies a comma-separated list of collection property names to filter which collection properties to return. By default, all collection properties are returned. Note: Property names are case-sensitive.
page	integer <int64> Example: page=5 Specifies the page index to return within a collection. The page size is determined by the value of the count parameter. The default parameter value is 1, which identifies the first page. To specify the last page, use a value of -1.
[name-of-property]	string Example: [name-of-property]=restid Specifies a comma-separated list of property values to filter which resources to return. By default, all resources are returned. Notes: Replace [name-of-property] with the name of the resource property on which to filter. For example: https://host:port/streams/instances/{instanceId}/jobs?health=unhealthy,partiallyUnhealthy Property names are case-sensitive. If multiple name-of-property query parameters are specified, a logical AND operation is performed on the specified properties. If multiple property values are specified for a name-of-property query parameter, a logical OR operation is performed on the property values.
sort	string Example: sort=desc.status,asc.name Specifies a comma-separated list of property names, prefixed by either asc. or desc., to identify how returned items are sorted. You cannot sort on properties that are arrays; if they are specified for the sort parameter, they are ignored. To sort on members of object properties, specify the name as object.member. By default, the sort order for the resource is used. Note: Property names are case-sensitive.
unique	boolean Example: unique=false Indicates whether only unique items, after filtering is applied, are returned in the collection. By default, all items are returned.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"first": "https://host:port/streams/domains/{domainId}/zookeeperensembles/{ensembleId}/nodes?count=10&page=1",
"last": "https://host:port/streams/domains/{domainId}/zookeeperensembles/{ensembleId}/nodes?count=10&page=-1",
"next": "https://host:port/streams/domains/{domainId}/zookeeperensembles/{ensembleId}/nodes?count=10&page=3",
"previous": "https://host:port/streams/domains/{domainId}/zookeeperensembles/{ensembleId}/nodes?count=10&page=1",
"resourceType": "zooKeeperNodeList",
"total": 50,
"zooKeeperNodes": [{"averageRequestLatency": 0,
"clientPort": 2000,
"connectionCount": 47,
"domain": "https://host:port/streams/domains/{domainId}",
"ensemble": "https://host:port/rest/domains/{domainId}/zookeeperensembles/{ensembleId}",
"host": "1.2.3.4",
"lastZooKeeperTransactionId": "0x26013ef65e1",
"maximumRequestLatency": 0,
"minimumRequestLatency": 0,
"mode": "follower",
"name": "1.2.3.4:2000",
"outstandingRequestsCount": 0,
"packetsReceivedCount": 2813057957,
"packetsSentCount": 2817258117,
"resourceType": "zooKeeperNode",
"restid": "1.2.3.4:2000",
"self": "https://host:port/rest/domains/{domainId}/zookeeperensembles/{ensembleId}/nodes/{nodeName}",
"status": "serving",
"version": "3.8.4-9316c2a7a97e1666d8f4593f34dd6fc36ecc436c, built on 2024-02-12 22:16 UTC",
"znodeCount": 28373
}
]
}

Get ZooKeeper node

This element resource provides access to information about a ZooKeeper node.

Authorizations:

authBasic

path Parameters

domainId required	string Example: myDomain Specifies the unique identifier for the domain.
ensembleId required	string Example: 1.2.3.4:2000,1.2.3.5:2000,1.2.3.6:2000 Identifies the name of the ZooKeeper ensemble.
nodeName required	string Example: 1.2.3.4:2000 Identifies the name of the ZooKeeper node.

query Parameters

fields

string

Example: fields=restid,resourceType

Specifies a comma-separated list of resource property names to filter which properties to return. To include a subset of the members of an object property, include the member name (as object.member) instead of the object property name. By default, all fields are returned. Note: Property names are case-sensitive.

Responses

Response samples

200
400
403
404
500

Content type

application/json

{"averageRequestLatency": 0,
"clientPort": 2000,
"connectionCount": 47,
"domain": "https://host:port/streams/domains/{domainId}",
"ensemble": "https://host:port/rest/domains/{domainId}/zookeeperensembles/{ensembleId}",
"host": "1.2.3.4",
"lastZooKeeperTransactionId": "0x26013ef65e1",
"maximumRequestLatency": 0,
"minimumRequestLatency": 0,
"mode": "follower",
"name": "1.2.3.4:2000",
"outstandingRequestsCount": 0,
"packetsReceivedCount": 2813057957,
"packetsSentCount": 2817258117,
"resourceType": "zooKeeperNode",
"restid": "1.2.3.4:2000",
"self": "https://host:port/rest/domains/{domainId}/zookeeperensembles/{ensembleId}/nodes/{nodeName}",
"status": "serving",
"version": "3.8.4-9316c2a7a97e1666d8f4593f34dd6fc36ecc436c, built on 2024-02-12 22:16 UTC",
"znodeCount": 28373
}

Documentation

APIs for accessing Streams API documentation.

Get documentation links

This resource provides access to Streams documentation.

Authorizations:

authBasic

Responses

Response samples

200
403
500

Content type

application/json

{"managementJmx": "https://host:port/streams/documentation/managementjmx",
"managementRest": "https://host:port/streams/documentation/managementrest",
"operatorCPlusPlus": "https://host:port/streams/documentation/operatorcplusplus",
"operatorJava": "https://host:port/streams/documentation/operatorjava",
"operatorPython": "https://host:port/streams/documentation/operatorpython"
}

Teracloud Streams (7.2.0.0)

Using Streams REST Management APIs

Domain

List domains

Authorizations:

query Parameters

Responses

Response samples

Get domain

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Perform domain action

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Download product log

Authorizations:

path Parameters

query Parameters

header Parameters

Responses

Response samples

Download product log and trace files

Authorizations:

path Parameters

Responses

Response samples

List domain configuration properties

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Get domain configuration property

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Update domain configuration property

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Instance

List instances

Authorizations:

query Parameters

Responses

Response samples

Create instance

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete instance

Authorizations:

path Parameters

Responses

Response samples

Get instance

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Perform instance action

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/x-jar
required

Request Body schema: application/json
required

Request Body schema: application/json
required