/admin/shutdown

URL: https://<aws.fqdn>/<aws.cluster.name>/gpudb-0/admin/shutdown

Exits the database server application.

Input Parameter Description

NameTypeDescription
exit_typestringReserved for future use. User can pass an empty string.
authorizationstringNo longer used. User can pass an empty string.
optionsmap of string to stringsOptional 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:

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

This embedded JSON represents the result of the /admin/shutdown endpoint:

NameTypeDescription
exit_statusstring'OK' upon (right before) successful exit.
infomap of string to stringsAdditional information.

Empty string in case of an error.