Retrieve Deployment
get
/services/{version}/deployments/{deployment}
Retrieve the details of a deployment.
Request
Path Parameters
-
deployment: string
Minimum Length:
1
Maximum Length:32
Pattern:^[A-Za-z][A-Za-z0-9-_.]*$
Name for the Oracle GoldenGate deployment.
-
version: string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Response
Supported Media Types
- application/json
200 Response
The deployment details were retrieved successfully.
Root Schema : Oracle GoldenGate Deployment
Type:
object
Title:
Oracle GoldenGate Deployment
Properties for an Oracle GoldenGate deployment
Show Source
-
$schema:
Allowed Values:
[ "ogg:deployment" ]
-
enabled:
boolean
Default Value:
true
Indicates the deployment is managed by the Service Manager -
environment:
array environment
Minimum Number of Items:
1
Maximum Number of Items:1024
Additional environment variables for the deployment -
oggConfHome:
string
Minimum Length:
1
Maximum Length:255
Default Value:conf
The deployment's configuration directory -
oggDataHome:
string
Minimum Length:
1
Maximum Length:255
Default Value:data
The deployment's var/data user data directory -
oggEtcHome:
string
Minimum Length:
1
Maximum Length:255
Default Value:etc
The deployment's etc configuration directory -
oggHome:
string
Minimum Length:
1
Maximum Length:255
The deployment's home directory -
oggSslHome:
string
Minimum Length:
1
Maximum Length:255
Default Value:ssl
The deployment's SSL configuration directory -
oggVarHome:
string
Minimum Length:
1
Maximum Length:255
Default Value:var
The deployment's var user data directory -
status:
Default Value:
stopped
Allowed Values:[ "running", "stopped", "restart" ]
Indicates the status of the deployment
Nested Schema : environment
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
1024
Additional environment variables for the deployment
Show Source
Nested Schema : items
Type:
Show Source
object
-
name:
string
Minimum Length:
1
Maximum Length:64
Pattern:[a-zA-Z0-9_]{1,64}
Environment variable name -
value:
string
Minimum Length:
1
Maximum Length:4095
Environment variable value
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"href":"http://localhost:11000/services/v2/deployments/Local",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:11000/services/v2/deployments/Local",
"mediaType":"application/json",
"rel":"self"
},
{
"href":"http://localhost:11000/services/v2/metadata-catalog/deployment",
"mediaType":"application/schema+json",
"rel":"describedby"
}
],
"messages":[
],
"response":{
"oggHome":"/u01/app/ogg",
"oggDataHome":"/u02/ogg/Local/var/lib/data",
"oggConfHome":"/u02/ogg/Local/etc/conf",
"enabled":true,
"oggSslHome":"/u02/ogg/Local/etc/ssl",
"$schema":"ogg:deployment",
"status":"running",
"oggEtcHome":"/u02/ogg/Local/etc",
"oggVarHome":"/u02/ogg/Local/var",
"environment":[
{
"name":"LD_LIBRARY_PATH",
"value":"/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.151-1.b12.el7_4.x86_64/jre/lib/amd64/server:/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.151-1.b12.el7_4.x86_64/jre/lib/amd64:/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.151-1.b12.el7_4.x86_64/jre/../lib/amd64:/usr/lib/jvm/jre/lib/amd64/server:/u01/app/oracle/product/12cR2/dbhome/lib"
},
{
"name":"JAVA_HOME",
"value":"/usr/lib/jvm/jre"
},
{
"name":"ORACLE_HOME",
"value":"/u01/app/oracle/product/12cR2/dbhome"
}
]
}
}