/alter/tier

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/alter/tier

Alters properties of an exisiting tier to facilitate resource management.

To disable watermark-based eviction, set both high_watermark and low_watermark to 100.

Input Parameter Description

NameTypeDescription
namestringName of the tier to be altered. Must be an existing tier group name.
optionsmap of string to strings

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

Supported Parameters (keys)Parameter Description
capacityMaximum size in bytes this tier may hold at once.
high_watermarkThreshold of usage of this tier's resource that, once exceeded, will trigger watermark-based eviction from this tier. The minimum allowed value is 0. The maximum allowed value is 100.
low_watermarkThreshold of resource usage that, once fallen below after crossing the high_watermark, will cease watermark-based eviction from this tier. The minimum allowed value is 0. The maximum allowed value is 100.

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

This embedded JSON represents the result of the /alter/tier endpoint:

NameTypeDescription
namestringValue of input parameter name.
infomap of string to stringsAdditional information.

Empty string in case of an error.