/delete/resourcegroup

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

Deletes a resource group.

Input Parameter Description

NameTypeDescription
namestringName of the resource group to be deleted.
optionsmap of string to strings

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

Supported Parameters (keys)Parameter Description
cascade_delete

If true, delete any existing entities owned by this group. Otherwise this request will return an error of any such entities exist. The default value is false. 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'delete_resource_group_response' or 'none' in case of an error
dataStringEmpty string
data_strJSON or String

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

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

Empty string in case of an error.