Version:

/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

Name Type Description
names array of strings List of names of groups to be shown. A single entry with an empty string returns all groups.
options map 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 supported values are:

  • true
  • false
show_default_group

If true include the default resource group in the response. 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 'show_resource_groups_request' or 'none' in case of an error
data String Empty string
data_str JSON or String

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

Name Type Description
groups array of maps of string to strings Map of resource group information.
info map of string to strings Additional information.

Empty string in case of an error.