streamtool geturl

Usage

geturl [-d,--domain-id <did>] [[--api] | [--console]] [--external] [-U,--User <user>] [-h,--help] [--trace <level>] [-v,--verbose <level>] [--zkconnect {<host>:<port>},... | --embeddedzk]

The streamtool geturl command prints the web server URLs for the domain. By default, the command returns the URL that is associated with the Streams Console.

Authority

You do not need any authority to run this command.

Description

By default, the web management service (SWS) runs on port 8443. You can specify a different port number when you create a domain. For example, you can specify the sws.port property value in the streamtool mkdomain command. After the domain is created, you can update the port number by using the streamtool setdomainproperty command. After the domain starts, you can determine the port number by using the streamtool geturl command. You can then use that URL to start the Streams Console in a web browser.

Options

--api
Specifies to print the URL for the REST API web server.
--console
Specifies to print the URL for the Streams Console.
-d,--domain-id <did>
Specifies the domain identifier.

If you do not specify this option, Streams uses the domain name that is set in the STREAMS_DOMAIN_ID environment variable. By default, that domain name is StreamsDomain. If you are using the interactive streamtool interface, it uses the name of the active domain for the current streamtool session or else it prompts you for the domain name.

The active domain for the current streamtool session is set every time that you successfully run a streamtool command with a -d or --domain-id option. Alternatively, you can run the streamtool domain command in the interactive interface.

--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.

--external
Specifies to show the external IP address in Streams URL values.
-h,--help
Specifies to show the command syntax.
--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.
-U,--User <user>
Specifies an Streams user ID that has authority to run the command.
-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:

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

Examples

The following command obtains the URL for the Streams Console in the domain mydomain:

streamtool geturl -d mydomain --console 
https://host1.teracloud.com:8443/streams/domain/console