show_maximum_query_duration

This API displays the current value of the timeout for reports.

You can change the timeout value with store_maximum_query_duration.

This API is available in Guardium V11.0 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/show_maximum_query_duration

GuardAPI syntax

show_maximum_query_duration parameter=value

Parameters

Parameter Value type Description
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

The following GuardAPI example shows the current timeout value: 

grdapi show_maximum_query_duration --source-host=localhost --username=admin

This command provides the following output:

timeout = "200"
END

The following REST API displays the timeout value, which is set to 200 seconds:

curl -k --header "Authorization:Bearer deaf8d32-f334-4a9b-976f-163a98afa32a" \
-i -H "Content-Type:application/json" \
-X GET https://localhost:8443/restAPI/show_maximum_query_duration

This command provides the following JSON output:

HTTP/1.1 200 OK
Cache-Control: private
Expires: Wed, 31 Dec 1969 19:00:00 EST
X-FRAME-OPTIONS: SAMEORIGIN
X-Permitted-Cross-Domain-Policies: none
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
. . .
Date: Mon, 04 Feb 2019 16:53:20 GMT
Server: SQL Guard
{ "timeout": "200" }