Get Parameter Group

GET

/dbaas/parameter-group/{pg_id}/

curl --request GET \
  --url 'https://api.e2enetworks.com/myaccount/api/v1/gpu/dbaas/parameter-group/{pg_id}/?project_id=<PROJECT_ID>&location=<LOCATION>&apikey=<API_KEY>' \
  --header 'Authorization: Bearer <API_TOKEN>'

Returns one parameter group: the values it changes, and the full parameter list of its template with the group’s values in place. Works only on a group you created in the project; any other ID returns 404. Needs the Read permission for DBaaS.

Parameters

Path Parameters

pg_id

required

integer

Parameter group ID

Query Parameters

project_id

required

integer

Project ID

active_iam

integer

Active IAM ID (To access contact person account) Find your Active IAM ID here

location

required

string

Allowed values: Delhi Chennai

Location

Responses

200

The parameter group

Media typeapplication/json

object

code

integer

message

string

data

object

id

integer

name

string

description

string

family

Engine and version the group is for.

string

template_id

integer

parameters

The values this group changes, as parameter name to value. Parameters not listed keep the engine default.

object

key

additional properties

string

template_parameters

Every parameter of the template; parameterValue is the group’s value where the group changes it, otherwise the default.

Array<object>

object

parameterName

string

parameterValue

The engine default. In a parameter group’s template_parameters, the group’s own value where it changes this parameter.

string

nullable

dataType

For example integer, real, bool, enum or string.

string

allowedValues

A range such as 1-262143 for numbers, or comma-separated choices for enum.

string

nullable

description

string

nullable

isModifiable

false for a parameter that cannot be changed.

boolean

applyType

The category the parameter belongs to.

string

nullable

is_attached

boolean

attached_databases

The databases that use this group.

Array<object>

object

id

integer

name

string

errors

object

Example

{
  "code": 200,
  "message": "Success",
  "data": {
    "id": 17,
    "name": "high-connections",
    "description": "More connections for the API workers",
    "family": "postgresql-16",
    "template_id": 3,
    "parameters": {
      "max_connections": "200",
      "work_mem": "8MB"
    },
    "template_parameters": [
      {
        "parameterName": "max_connections",
        "parameterValue": "100",
        "dataType": "integer",
        "allowedValues": "1-262143",
        "description": "Sets the maximum number of concurrent connections.",
        "isModifiable": true,
        "applyType": "Connections / Authentication"
      }
    ],
    "is_attached": true,
    "attached_databases": [
      {
        "id": 128,
        "name": "orders-db"
      }
    ]
  },
  "errors": {}
}

400

project_id is missing or not a number.

Media typeapplication/json

object

code

integer

message

string

data

object

errors

string

Example

{
  "code": 400,
  "message": "Bad Request",
  "data": {},
  "errors": "Project ID is missing or invalid"
}

403

The caller lacks the permission the call needs on the project, or the region is not allowed.

Media typeapplication/json

object

code

integer

message

string

data

object

errors

string

Example

{
  "code": 403,
  "message": "Forbidden",
  "data": {},
  "errors": "You don't have permission to access this service. Please verify your policy or project."
}

404

No parameter group with that ID among yours in the project.

Media typeapplication/json

object

code

integer

message

string

data

object

errors

string

Example

{
  "code": 404,
  "message": "Bad Request",
  "data": {},
  "errors": "Parameter group not found."
}