Retrieve Deployment List
get
/services/{version}/installation/deployments
Retrieve a list of all Oracle GoldenGate deployments for the installation.
Request
Path Parameters
-
version: string
Oracle GoldenGate Service API version.
Allowed Values:[ "v2" ]
Query Parameters
-
deployment(optional): string
The name of a deployment for filtering results
Response
Supported Media Types
- application/json
200 Response
The deployment list was retrieved successfully.
Root Schema : Oracle GoldenGate Deployments for the Installation
Type:
object
Title:
Oracle GoldenGate Deployments for the Installation
List of all Oracle GoldenGate deployments for the installation
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:installationDeployments" ]
-
deployments:
array deployments
Minimum Number of Items:
1
Maximum Number of Items:65535
Array of deployments for the installation -
xagEnabled:
boolean
Indicates that the installation is managed by XAG
Nested Schema : deployments
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
65535
Array of deployments for the installation
Show Source
-
Array of:
object items
Deployment characteristics
Nested Schema : items
Type:
object
Deployment characteristics
Show Source
-
deploymentId:
string
Minimum Length:
36
Maximum Length:36
Pattern:^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89ABab][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
The unique identifier for the deployment -
deploymentName:
string
Minimum Length:
1
Maximum Length:32
Pattern:^[A-Za-z][A-Za-z0-9-_.]*$
The name for the deployment -
enabled:
boolean
Indicates the deployment is managed by the Service Manager
-
status:
Default Value:
stopped
Allowed Values:[ "running", "stopped", "restart", "killed", "abended" ]
Indicates the status of the deployment
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"href":"http://localhost:11000/services/v2/installation/deployments",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:11000/services/v2/installation/deployments",
"mediaType":"application/json",
"rel":"self"
},
{
"href":"http://localhost:11000/services/v2/metadata-catalog/deployments",
"mediaType":"application/schema+json",
"rel":"describedby"
}
],
"messages":[
],
"response":{
"$schema":"ogg:installationDeployments",
"deployments":[
{
"deploymentId":"df366222-2166-4714-90d8-9ebeefa5b00e",
"deploymentName":"Local",
"enabled":true,
"status":"running"
},
{
"deploymentId":"74d78f7b-0944-4440-b2dc-9cbdd97dbe23",
"deploymentName":"ServiceManager",
"enabled":true,
"status":"running"
}
],
"xagEnabled":false
}
}