/show/system/properties

URL: https://<aws.fqdn>/<aws.cluster.name>/gpudb-0/show/system/properties

Returns server configuration and version related information to the caller. The admin tool uses it to present server related information to the user.

Input Parameter Description

NameTypeDescription
optionsmap of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys)Parameter Description
propertiesA list of comma separated names of properties requested. If not specified, all properties will be returned.

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:

NameTypeDescription
statusString'OK' or 'ERROR'
messageStringEmpty if success or an error message
data_typeString'show_system_properties_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

This embedded JSON represents the result of the /show/system/properties endpoint:

NameTypeDescription
property_mapmap of string to strings

A map of server configuration parameters and version information.

Possible Parameters (keys)Parameter Description
conf.enable_worker_http_servers

Boolean value indicating whether the system is configured for multi-head ingestion.

Possible ValuesDescription
TRUEIndicates that the system is configured for multi-head ingestion.
FALSEIndicates that the system is NOT configured for multi-head ingestion.
conf.worker_http_server_ipsSemicolon (';') separated string of IP addresses of all the ingestion-enabled worker heads of the system.
conf.worker_http_server_portsSemicolon (';') separated string of the port numbers of all the ingestion-enabled worker ranks of the system.
conf.hm_http_portThe host manager port number (an integer value).
conf.enable_haFlag indicating whether high availability (HA) is set up (a boolean value).
conf.ha_ring_head_nodesA comma-separated string of high availability (HA) ring node URLs. If HA is not set up, then an empty string.
infomap of string to stringsAdditional information.

Empty string in case of an error.