Retrieve an existing Database Information
get
/services/{version}/mpoints/{item}/databaseInOut
Required Role: User
Retrieve an existing Database InformationRequest
Path Parameters
-
item(required): string
Minimum Length:
1
Maximum Length:32
-
version(required): string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Response
Supported Media Types
- application/json
200 Response
Root Schema : Database Description
Type:
object
Title:
Show Source
Database Description
-
$schema:
Allowed Values:
[ "mpoints:databaseInOut" ]
-
dbGlobalName:
string
Minimum Length:
1
Maximum Length:4000
Database global name -
dbName:
string
Minimum Length:
1
Maximum Length:128
The name of the database instance -
dbServerName:
string
Minimum Length:
1
Maximum Length:128
Database side server name -
dbType:
string
Minimum Length:
1
Maximum Length:64
The type of database -
dbVersion:
string
Minimum Length:
1
Maximum Length:512
Database version information
Example Response (application/json)
{
"$schema":"api:standardResponse",
"response":{
"$schema":"mpoints:databaseInOut",
"dbName":"DB1",
"dbType":"ORACLE",
"dbVersion":"Oracle Database 12c Enterprise Edition Release 12.2.0.0.0 - 64bit Beta PL/SQL Release 12.2.0.0.0 - Beta",
"dbServerName":"OGG$EORADB1",
"dbGlobalName":"DBS1.REGRESS.RDBMS.DEV.US.ORACLE.COM"
},
"messages":[
],
"links":[
]
}