/admin/ha/offline

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

Pauses consumption of messages from other HA clusters to support data repair/recovery scenarios. In-flight queries may fail to replicate to other clusters in the ring when going offline.

Input Parameter Description

NameTypeDescription
offlineboolean

Set to true if desired state is offline. The supported values are:

  • true
  • false
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_ha_offline_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

This embedded JSON represents the result of the /admin/ha/offline endpoint:

NameTypeDescription
infomap of string to stringsAdditional information.

Empty string in case of an error.