discover_streams

This API returns the number of AWS data streams for the specified cloud DB service account (cloudTitle) and region.

To find details about a stream, use the get_streams API.

This API is available in Guardium V10.6 and later.

REST API syntax

This API is available as a REST service with the GET method. Call this API as follows:

GET https://[Guardium hostname or IP address]:8443/restAPI/discover_datastream

GuardAPI syntax

discover_streams parameter=value

Parameters

Parameter Value type Description

Parameter	Value type	Description
cloudTitle	String	Required. The name of the cloud DB service account. For valid values, call discover_streams from the command line with `--help=true`. For more information, see Define, modify, and delete AWS cloud DB service accounts.
regions	String	Requires for AWS only. For valid values, call discover_streams from the command line with `--help=true`.
api_target_host	String	Specifies the target hosts where the API executes. Valid values: `all_managed`: execute on all managed units but not the central manager `all`: execute on all managed units and the central manager `group:<group name>`: execute on all managed units identified by `<group name>` host name or IP address of a managed unit: specified from the central manager to execute on a managed unit. For example, `api_target_host=10.0.1.123`. host name or IP address of the central manager: specified from a managed unit to execute on the central manager. For example, `api_target_host=10.0.1.123`. IP addresses must conform to the IP mode of your network. For dual IP mode, use the same IP protocol with which the managed unit is registered with the central manager. For example, if the registration uses IPv6, specify an IPv6 address. The hostname is independent of IP mode and can be used with any mode.

cloudTitle

String

Required. The name of the cloud DB service account. For valid values, call discover_streams from the command line with --help=true.

For more information, see Define, modify, and delete AWS cloud DB service accounts.

regions String Requires for AWS only. For valid values, call discover_streams from the command line with --help=true.

api_target_host

String

Specifies the target hosts where the API executes. Valid values:

all_managed: execute on all managed units but not the central manager
all: execute on all managed units and the central manager
group:<group name>: execute on all managed units identified by <group name>
host name or IP address of a managed unit: specified from the central manager to execute on a managed unit. For example, api_target_host=10.0.1.123.
host name or IP address of the central manager: specified from a managed unit to execute on the central manager. For example, api_target_host=10.0.1.123.

IP addresses must conform to the IP mode of your network. For dual IP mode, use the same IP protocol with which the managed unit is registered with the central manager. For example, if the registration uses IPv6, specify an IPv6 address. The hostname is independent of IP mode and can be used with any mode.

Examples

grdapi discover_streams cloudTitle=mytest-aws regions=us-east-1

Sample output:

ID=0
Number of Streams discovered for the given cloud Account: 3
ok