> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt
> Use this file to discover all available pages before exploring further.

# /show/resourcegroups

```
URL: http://<db.host>:<db.port>/show/resourcegroups
```

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

## Input Parameter Description

<ParamField body="names" type="array of strings">
  List of names of groups to be shown. A single entry with an empty string returns all groups.
</ParamField>

<ParamField body="options" type="map of string to strings">
  Optional parameters.

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

  <Expandable title="options">
    <ParamField body="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
    </ParamField>

    <ParamField body="show_default_group">
      If *true* include the default and system resource groups in the response. This value defaults to false if an explicit list of group names is provided, and true otherwise.

      The default value is `true`.

      The supported values are:

      * true
      * false
    </ParamField>

    <ParamField body="show_tier_usage">
      If *true* include the resource group usage on the worker ranks in the response.

      The default value is `false`.

      The supported values are:

      * true
      * false
    </ParamField>
  </Expandable>
</ParamField>

## Output Parameter Description

The Kinetica 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:

<ResponseField name="status" type="String">
  'OK' or 'ERROR'
</ResponseField>

<ResponseField name="message" type="String">
  Empty if success or an error message
</ResponseField>

<ResponseField name="data_type" type="String">
  'show\_resource\_groups\_response' or 'none' in case of an error
</ResponseField>

<ResponseField name="data" type="String">
  Empty string
</ResponseField>

<ResponseField name="data_str" type="JSON or String">
  This embedded JSON represents the result of the /show/resourcegroups endpoint:

  <Expandable title="data_str">
    <ResponseField name="groups" type="array of maps of string to strings">
      Map of resource group information.
    </ResponseField>

    <ResponseField name="rank_usage" type="map of string to strings">
      Tier usage across ranks. Layout is: response.rank\_usage\[rank\_number]\[resource\_group\_name] = group\_usage (as stringified JSON).
    </ResponseField>

    <ResponseField name="info" type="map of string to strings">
      Additional information.
    </ResponseField>
  </Expandable>

  Empty string in case of an error.
</ResponseField>