Show DB engine details (GET /v1.0/{tenantId}/engineversion)

Shows the version details for the database.

Request URI

{tenantID}

Project ID of the owner of the instance

Data Type Cardinality
String 1..1

Request parameters

defaultOnly

Flag specifying whether to display only the default version

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

engine

Name of the DB engine

enterprisepostgres or symfoware

If omitted, the version details of all usable DB engines are displayed.

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

engineVersion

Version of the DB engine

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

listSupportedCharacterSets

Flag indicating whether to display supported encoding

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

marker

A pagination token used to establish the starting point for retrieving the list.

Note: Specify the marker returned in the previous list.

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

limit

Number of elements to display

20 to 100

Default:20

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

Response Headers

Status

Returns the status of the request.

One of the following values will be returned.
401:
unauthorized
403:
forbidden
500:
instanceFault
501:
notImplemented
503:
serviceUnavailable
504:
gatewayTimeout
Data Type Cardinality
Int 1.1

Response Elements

dBEngineVersions

List of DBEngineVersion structures

Data Type Cardinality Parent Element Child Element(s)
DBEngineVersion list   None None

marker

Marker indicating the end position of the request

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

dBEngineDescription

Description of the DB engine

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

dBEngineVersionDescription

Description of the DB engine version

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

dBParameterGroupFamily

Series of DB parameter groups

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

defaultCharacterSet

Default character set

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

engine

Name of the DB engine

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

engineVersion

Version of the DB engine

Data Type Cardinality Parent Element Child Element(s)
String   Event None

engineMinorVersion

Minor version of the DB engine

Data Type Cardinality Parent Element Child Element(s)
String   Event None

supportedCharacterSets

List of the supported character sets

Data Type Cardinality Parent Element Child Element(s)
CharacterSet list   None None

characterSetDescription

Description of the character set

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

characterSetName

Name of the character set

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

CAUTION:

Events are displayed in descending order of datetime

Example of Response


       {
        "dbEngineVersions": [
         {
          "dBEngineDescription": "Symfoware DBaaS",
          "dBEngineVersionDescription": "Version 12.1",
          "dBParameterGroupFamily": "symfoware_v12.1",
          "engine": "symfoware",
          "engineVersion": "12.1",
          "engineMinorVersion": "1",
          "defaultCharacterSet": {
           "characterSetDescription": "UTF8 Unicode 8-bit",
           "characterSetName": "UTF8"
          },
          "supportedCharacterSets": null,
          "collates": [
           "C"
          ]
         },
         {
          "dBEngineDescription": "Enterprise Postgres DBaaS",
          "dBEngineVersionDescription": "Version 9.6",
          "dBParameterGroupFamily": "enterprisepostgres_v9.6",
          "engine": "enterprisepostgres",
          "engineVersion": "9.6",
          "engineMinorVersion": "0",
          "defaultCharacterSet": {
           "characterSetDescription": "UTF8 Unicode 8-bit",
           "characterSetName": "UTF8"
          },
          "supportedCharacterSets": null,
          "collates": [
           "C"
          ]
         }
        ]
       }