Note

This documentation is for a prior release of Kinetica. For the latest documentation, click here.

/alter/resourcegroup

URL: http://<db.host>:<db.port>/alter/resourcegroup

Alters the properties of an exisiting resource group to facilitate resource management.

Input Parameter Description

Name

Type

Description

name

string

Name of the group to be altered. Must be an existing resource group name or an empty string when used inconjunction with the is_default_group option.

tier_attributes

map of string to maps of string to strings

Optional map containing tier names and their respective attribute group limits. The only valid attribute limit that can be set is max_memory (in bytes) for the VRAM & RAM tiers. For instance, to set max VRAM capacity to 1GB and max RAM capacity to 10GB, use: {'VRAM':{'max_memory':'1000000000'}, 'RAM':{'max_memory':'10000000000'}}. The default value is an empty map ( {} ).

Supported Parameters (keys)	Parameter Description
max_memory	Maximum amount of memory usable in the given tier at one time for this group.

ranking

string

If the resource group ranking is to be updated, this indicates the relative ranking among existing resource groups where this resource group will be moved; leave blank if not changing the ranking. When using before or after, specify which resource group this one will be inserted before or after in input parameter adjoining_resource_group. The supported values are:

first
last
before
after

adjoining_resource_group

string

If input parameter ranking is before or after, this field indicates the resource group before or after which the current group will be placed; otherwise, leave blank. The default value is ''.

options

map of string to strings

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

Supported Parameters (keys)	Parameter Description
max_cpu_concurrency	Maximum number of simultaneous threads that will be used to execute a request for this group. The minimum allowed value is 4.
max_data	Maximum amount of cumulative ram usage regardless of tier status for this group. The minimum allowed value is -1.
max_scheduling_priority	Maximum priority of a scheduled task for this group. The minimum allowed value is 1. The maximum allowed value is 100.
max_tier_priority	Maximum priority of a tiered object for this group. The minimum allowed value is 1. The maximum allowed value is 10.
is_default_group	If true, this request applies to the global default resource group. It is an error for this field to be true when the input parameter name field is also populated. The default value is false. The supported values are: true false
persist	If true and a system-level change was requested, the system configuration will be written to disk upon successful application of this request. This will commit the changes from this request and any additional in-memory modifications. The default value is true. The supported values are: true false

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:

Name

Type

Description

status

String

'OK' or 'ERROR'

message

String

Empty if success or an error message

data_type

String

'alter_resource_group_response' or 'none' in case of an error

data

String

Empty string

data_str

JSON or String

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

Name	Type	Description
name	string	Value of input parameter name.
info	map of string to strings	Additional information.

Empty string in case of an error.