Home
Administering
Administer the product by using the Teracloud® Streams graphical user interface, APIs, or the streamtool command-line interface.
Domain and instance services
Before you can perform Teracloud® Streams tasks, Teracloud Streams domain and instance services need to be running on resources in the domain. Domain services are started by starting the domain and instance services are started by starting the instance.
Changing the secure port number for the REST management API service
By default, the REST management API service runs on port 9714. You can specify a port number when you create or update a domain.

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.
- Domains
  After you create a Teracloud® Streams domain, you can administer it by using the Streams Console graphical user interface and the streamtool command-line interface.
- Resources
  After you add resources to domains and instances, you can administer them by using the Streams Console or the streamtool command-line interface.
- Instances
  To create and manage instances, you can use the Streams Console or the streamtool command-line interface.
- Domain and instance services
  Before you can perform Teracloud® Streams tasks, Teracloud Streams domain and instance services need to be running on resources in the domain. Domain services are started by starting the domain and instance services are started by starting the instance.
  - Changing the secure port number for the web management service
    By default, the web management service runs on port 8443. You can specify a different port number when you create or update a domain.
  - Changing the secure port number for the REST management API service
    By default, the REST management API service runs on port 9714. You can specify a port number when you create or update a domain.
  - Changing the secure port number for the JMX management API service
    By default, the JMX management API service runs on port 9975. The JMX management API service uses an HTTP service for handling large data operations. By default, an open port is dynamically chosen for this HTTP service when the domain is started. You can specify port numbers for each of these services when you create or update a domain.
  - Changing the secure port number for the Teracloud® Streams data service
    By default, an open port is dynamically chosen for the Teracloud® Streams data service when an instance is started. This is done to avoid port conflict errors when starting multiple instances on the same resource. You can override this behavior by specifying a port number when you create or update an instance. If you try to start an instance and the port is already being used, the instance fails to start and you receive a message that the port is in use.
  - Monitoring domain and instance services
    Use the Streams Console to view the status of Teracloud® Streams services.
- Jobs
  You can start and administer jobs by using Streams Console or the streamtool command-line interface.
- Recovery
  You can back up your Teracloud® Streams system files and directories and then restore them later if necessary. In general, you can recover from application and runtime failures without restoring Teracloud Streams from a backup.
- Streams Console
  You can use the Streams Console to monitor and manage the Teracloud® Streams instances and applications in your domain from any computer that has HTTP connectivity to the server that is running the web management service.
- Logs and traces
  Teracloud® Streams provides options that enable administrators, instance owners, and application developers to manage log and trace data.
- Managing and monitoring Teracloud® Streams using management APIs
  Teracloud® Streams provides two API sets to manage and monitor Streams services and jobs.
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.
Glossary
Use this glossary to find terms and definitions for Teracloud® Streams.

Changing the secure port number for the REST management API service

By default, the REST management API service runs on port 9714. You can specify a port number when you create or update a domain.

About this task

If you have multiple copies of Teracloud® Streams on the same resource, you must use non-default port numbers because separate ports are required for each domain. If you try to start a domain and the port is already being used, the domain fails to start and you receive a message that the port is in use.

The new port number must be a value between 0 and 65535. If the domain.portRange domain property is set, the new port number must be within the specified port range. If you specify a value of 0, an open port is dynamically chosen when the domain is started. After the domain starts, you can determine the port number by using the

streamtool geturl
          --api

command.

Note: If you use the dynamic port allocation option, the URL for the REST management API service might change each time the service restarts. If you have applications that use the REST management API, you must reestablish a connection to the REST management API service after it restarts and use the updated URL. For these reasons, consider using an assigned port number in these scenarios.

Procedure

To use a non-default port number:

Create a domain and specify the rest.port domain property.
Specify the following parameter in the streamtool mkdomain command: --property rest.port=port-number
Update the rest.port domain property value for the domain:
1. Update the domain property using the streamtool setdomainproperty command.
2. Stop and restart the domain.
For more information, refer to Firewall configuration guidelines for Teracloud Streams.