/show/resourcegroups

URL: http://GPUDB_IP_ADDRESS:GPUDB_PORT/show/resourcegroups

Requests resource group properties. Returns detailed information about the requested resource groups.

Input Parameter Description

NameTypeDescription
namesarray of stringsList of names of groups to be shown. A single entry with an empty string returns all groups.
optionsmap of string to strings

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

Supported Parameters (keys)Parameter Description
show_default_values

If true include values of fields that are based on the default resource group. The default value is true. The supported values are:

  • true
  • false
show_default_group

If true include the default resource group in the response. 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:

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

This embedded JSON represents the result of the /show/resourcegroups endpoint:

NameTypeDescription
groupsarray of maps of string to stringsMap of resource group information.
infomap of string to stringsAdditional information.

Empty string in case of an error.