Note

This documentation is for a prior release of Kinetica. For the latest documentation, click here.

/admin/show/alerts

URL: https://<aws.fqdn>/<aws.cluster.name>/gpudb-host-manager/admin/show/alerts

Requests a list of the most recent alerts. Returns lists of alert data, including timestamp and type.

NOTE: This endpoint is serviced by the host manager, not the database cluster itself, so the port specified needs to be the host manager port instead. The default host manager port can be found under Default Ports. For more information on the host manager, see Host Manager.

Input Parameter Description

Name	Type	Description
num_alerts	int	Number of most recent alerts to request. The response will include up to input parameter num_alerts depending on how many alerts there are in the system. A value of 0 returns all stored alerts.
options	map of string to strings	Optional parameters. The default value is an empty map ( {} ).

Output Parameter Description

The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

Name

Type

Description

status

String

'OK' or 'ERROR'

message

String

Empty if success or an error message

data_type

String

'admin_show_alerts_response' or 'none' in case of an error

data

String

Empty string

data_str

JSON or String

This embedded JSON represents the result of the /admin/show/alerts endpoint:

Name	Type	Description
timestamps	array of strings	Timestamp for when the alert occurred, sorted from most recent to least recent. Each array entry corresponds with the entries at the same index in output parameter types and output parameter params.
types	array of strings	Type of system alert, sorted from most recent to least recent. Each array entry corresponds with the entries at the same index in output parameter timestamps and output parameter params.
params	array of maps of string to strings	Parameters for each alert, sorted from most recent to least recent. Each array entry corresponds with the entries at the same index in output parameter timestamps and output parameter types.
info	map of string to strings	Additional information.

Empty string in case of an error.