Create DB parameter group (POST /v1.0/{tenantId}/parametergroups)

Creates a DB parameter group.

Request URI

{tenantID}

Project ID of the owner of the instance

Data Type Cardinality
String 1..1

Request Parameters

parametergroup

Data Type Cardinality Parent Element Child Element(s)
    None parameterGroupFamily

id

name

description

parameterGroupFamily

Type of parameter group, determined by the DB engine and version

enterprisepostgres_v9.6 or symfoware_v12.1

Data Type Cardinality Parent Element Child Element(s)
String 1..1 parametergroup None

id

ID of the DB parameter group
  • Only alphanumeric characters and hyphens can be used
  • The string must start with a letter
  • A hyphen cannot be used at the end of the string
  • Two or more consecutive hyphens cannot be used
  • Up to 63 characters

Default: random value

Data Type Cardinality Parent Element Child Element(s)
String 0..1 parametergroup None

name

Name of the DB parameter group
  • Only alphanumeric characters and hyphens can be used
  • The string must start with a letter
  • A hyphen cannot be used at the end of the string
  • Two or more consecutive hyphens cannot be used
  • Up to 255 characters
Data Type Cardinality Parent Element Child Element(s)
String 1..1 parametergroup None

description

Description of the DB parameter group

Data Type Cardinality Parent Element Child Element(s)
String 0..1 parametergroup None

Response Headers

Status

Returns the status of the request.

One of the following values will be returned.
400:
badRequest
401:
unauthorized
403:
forbidden
404:
itemNotFound
413:
overLimit
422:
unprocessableEntity
500:
instanceFault
501:
notImplemented
503:
serviceUnavailable
504:
gatewayTimeout
Data Type Cardinality
Int 1..1

Response Elements

parameterGroupFamily

Type of DB parameter group

Data Type Cardinality Parent Element Child Element(s)
String      

name

Name of the DB parameter group

Data Type Cardinality Parent Element Child Element(s)
String      

id

ID of the DB parameter group

Data Type Cardinality Parent Element Child Element(s)
String      

description

Description of the DB parameter group

Data Type Cardinality Parent Element Child Element(s)
String      

Example of Request


{
	"parametergroup" : {
	 "parameterGroupFamily": "enterprisepostgres_v9.6",
	 "name": "dbparam1",
	 "description" : "this is test"
	}
}

Example of Response


{
	"dbParameterGroup": {
	"parameterGroupFamily" :"enterprisepostgres_v9.6",
		"name" : "paramgroup1",
		"id" : "paramgroup_w34e5r6t7yu89",
		"description" : "test",
		"appliedInstances" : [
		]
	}
}