get_streams

This API returns configuration information for the AWS data streams or Azure event hubs for the specified cloud DB service account (cloudTitle).

For this API, the following rules apply for status information:

REST API: When available, returns the status, along with configuration information, for the stream or event hub.
GuardAPI:
- On a central manager: Returns configuration information. In addition, if the stream is assigned to a collector, then the API also returns the status of the stream for that collector.
- On stand-alone or managed units: Configuration information displays, but status is not available.

Status information is available in the UI at Discover > Database Discovery > Cloud DB Service Protection. Select a Cloud database service account to see status and other information.

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/datastream

GuardAPI syntax

get_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 get_streams from the command line with `--help=true`. For more information, see Define, modify, and delete AWS cloud DB service accounts.
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 get_streams from the command line with --help=true.

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

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.