Get Parameter Group Template

GET

/dbaas/parameter-group/templates/{template_id}/

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

Returns one template with its parameters: for each, the default value, the type, the allowed values, and whether it can be changed. Needs the Read permission for DBaaS.

Parameters

Path Parameters

template_id

required

integer

Template 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 template

Media typeapplication/json

object

code

integer

message

string

data

object

id

integer

family

string

engine

string

engine_version

string

parameters

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

errors

object

Example

{
  "code": 200,
  "message": "Success",
  "data": {
    "id": 3,
    "family": "postgresql-16",
    "engine": "postgresql",
    "engine_version": "16",
    "parameters": [
      {
        "parameterName": "max_connections",
        "parameterValue": "100",
        "dataType": "integer",
        "allowedValues": "1-262143",
        "description": "Sets the maximum number of concurrent connections.",
        "isModifiable": true,
        "applyType": "Connections / Authentication"
      }
    ]
  },
  "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 template with that ID is offered.

Media typeapplication/json

object

code

integer

message

string

data

object

errors

string

Example

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