Home
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
Commands
Teracloud® Streams provides a number of commands you use to perform tasks.
streamtool
Streamtool is the Streams command-line interface.
Miscellaneous
streamtool getiid

Welcome
Learn about the core capabilities of Teracloud® Streams, its architecture, and key concepts.
Installing
Use this information to install, upgrade, and uninstall the Teracloud® Streams product.
Configuring
Create a basic or an enterprise domain which is a single point for configuring and managing common resources, security, and instances.
Administering
Administer the product by using the Teracloud® Streams graphical user interface, APIs, or the streamtool command-line interface.
Developing
Develop stream applications with the Streams Processing Language (SPL), Java, and Python.
Troubleshooting
Resolve problems with Teracloud® Streams using the troubleshooting tools provided with the product as well as the resources offered by Teracloud Support.
Reference
Find details on the SPL language, toolkits, APIs, commands, and more.
- APIs
  Application programming interfaces (APIs) provide functions that simplify applications development.
- Job configuration overlays
  You can specify or change configuration parameters when you use the submitjob or updateoperators operations. The settings control submission constraints, host constraints and locations, and operator status. Parameters are captured and updated in the configuration JSON file. When you change the values in the job configuration overlay file, the changes override any previously set values.
- Commands
  Teracloud® Streams provides a number of commands you use to perform tasks.
  - streamtool
    Streamtool is the Streams command-line interface.
    - Configuration
      Commands in this section are related to the creation and configuration of Streams domains and instances.
    - Administration
      Commands in this section are related to starting and managing running Streams domains and instances.
    - Jobs
      Commands in this section are related to submitting and managing jobs for Streams applications.
    - Security
      Commands in this section are related to managing the security policy that is associated with an Streams domain or instance.
    - Certificates
      Commands in this section are related to managing the certificates that are used by Streams services.
    - Miscellaneous
  - Metrics
    Teracloud® Streams provides metrics to help evaluate the health of Teracloud Streams services, to aid in diagnosing performance issues, and to analyze throughput of requests. You can use the streamtool checkinstancemetrics, streamtool checkdomainmetrics, streamtool getdomainmetrics, and streamtool checkresourcemetrics commands to view the metrics data.
  - Reading syntax diagrams in the documentation
    There is a syntax convention for how parameters and values are represented in the command syntax diagrams in the Teracloud® Streams documentation.
  - sc command
    The sc command compiles SPL applications.
  - spl-app-info command
    The spl-app-info command reports information about a application bundle file.
  - spl-make-doc command
    The spl-make-doc command generates documentation for your toolkits.
  - spl-make-operator command
    The spl-make-operator command creates code generator modules from template files. The command can also create skeleton code generator templates and a default operator model if they do not exist.
  - spl-make-toolkit command
    The spl-make-toolkit command indexes a toolkit and makes the functions and operators it contains ready for use by SPL programs.
  - spl-schema-from-xml command
    The spl-schema-from-xml command creates an SPL tuple declaration from an XML document.
  - spl-transport-stats command
    The spl-transport-stats command creates a transport statistics model by running a transport performance test.
- Operator model
  An operator model is an XML document that describes the basic properties of a primitive operator.
- Streams Processing Language (SPL)
  Streams Processing Language (SPL) is a distributed data flow composition language that is used in Teracloud® Streams. SPL has primitive types, program structures, and definitions that are tailored for streaming data.
- Toolkits
  A toolkit is a set of SPL artifacts, which are organized into a package. Toolkits make SPL or native functions and primitive or composite operators reusable across different applications.
- SPLDOC markup
  You can use SPLDOC markup in the descriptions associated with the SPL artifacts in a toolkit. The spl-make-doc command generates HTML documentation from the marked up artifacts.
Glossary
Use this glossary to find terms and definitions for Teracloud® Streams.

streamtool getiid

Usage

getiid [-s,--short] [-h,--help] [--trace <level>] [-v,--verbose <level>] [--zkconnect {<host>:<port>},... | --embeddedzk]

The streamtool getiid command reports the Streams default instance ID value.

Authority

You do not need any authority to run this command.

Description

If a default instance ID value is not set, the command returns a value of ** NONE **.

See the streamtool man command for a description of default instance IDs.

Options

--embeddedzk

Specifies to use the embedded copy of ZooKeeper. This option is not supported within the interactive streamtool interface.

If you are not using the interactive streamtool interface and you do not specify either this option or the --zkconnect option, Streams uses the ZooKeeper connection that is associated with the active domain or the domain that is specified in the --domain-id option. Streams determines which connection maps to the domain by using cached information about the domains. In this scenario, if the domain identifier is not unique in the Streams configuration cache, the command fails.

-h,--help

Specifies to show the command syntax.

-s,--short

Specifies to return a shortened list of information. In particular, the command returns only the instance names.

--trace <level>

Specifies the trace setting. The following valid levels are listed in order of increasing verbosity, which is to say that the first level in the list generates the least amount of information:

off
error
warn
info
debug
trace

The default value is off.

-v,--verbose <level>

Specifies to provide more detailed command output. The verbosity level can be 0-3, where 0 disables detailed reporting and each increment provides more detailed output.

--zkconnect <{<host>:<port>},...>

The name of one or more host and port pairs that specify the configured ZooKeeper servers. This option is not supported within the interactive streamtool interface.

If you are not using the interactive streamtool interface and you do not specify this option, Streams tries to use:

The --embeddedzk option
The value from the STREAMS_ZKCONNECT environment variable
A ZooKeeper connection string that is derived from cached information about the current domain.