Retrieve Service List
get
/services/{version}/installation/services
Retrieve a list of all Oracle GoldenGate services 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
-
service(optional): string
The name of a service for filtering results
Response
Supported Media Types
- application/json
200 Response
The service list was retrieved successfully.
Root Schema : Oracle GoldenGate Services for the Installation
Type:
object
Title:
Oracle GoldenGate Services for the Installation
List of all Oracle GoldenGate services for the installation
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:installationServices" ]
-
services:
array services
Minimum Number of Items:
1
Maximum Number of Items:65535
Array of services for the installation
Nested Schema : services
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
65535
Array of services for the installation
Show Source
-
Array of:
object items
Service characteristics
Nested Schema : items
Type:
object
Service characteristics
Show Source
-
critical:
boolean
Default Value:
true
Indicates the service is critical to the deployment -
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 this service's deployment -
deploymentName:
string
Minimum Length:
1
Maximum Length:32
Pattern:^[A-Za-z][A-Za-z0-9-_.]*$
The name for this service's deployment -
enabled:
boolean
Default Value:
true
Indicates the service is managed by the Service Manager -
isSsl:
boolean
Indicates that the service expects an SSL connection
-
listeners:
array listeners
Minimum Number of Items:
1
Maximum Number of Items:64
Array of listener specifications for the service -
locked(optional):
boolean
Default Value:
false
Indicates the service is locked by a security administrator and cannot be started -
serviceId:
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 this service -
serviceName:
string
Minimum Length:
1
Maximum Length:64
The name of this service -
status:
Default Value:
stopped
Allowed Values:[ "starting", "running", "stopped", "restart", "killed", "abended" ]
Indicates the status of the service
Nested Schema : listeners
Type:
array
Minimum Number of Items:
1
Maximum Number of Items:
64
Array of listener specifications for the service
Show Source
-
Array of:
object items
Description of service listener
Nested Schema : items
Type:
object
Description of service listener
Show Source
-
address:
address
Service listening IP address
-
port:
integer
Minimum Value:
1
Maximum Value:65535
Service listening port number
Nested Schema : address
Service listening IP address
Match One
Show Source
-
string
Minimum Length:
7
Maximum Length:15
Pattern:^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)[.]){3}(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$
Network IPv4 address -
string
Minimum Length:
1
Maximum Length:256
Pattern:^((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])([.](25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9]?[0-9])){3}))|:)))(%.+)?$
Network IPv6 address
Example Response (application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"href":"http://localhost:11000/services/v2/installation/services",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:11000/services/v2/installation/services",
"mediaType":"application/json",
"rel":"self"
},
{
"href":"http://localhost:11000/services/v2/metadata-catalog/services",
"mediaType":"application/schema+json",
"rel":"describedby"
}
],
"messages":[
],
"response":{
"$schema":"ogg:installationServices",
"services":[
{
"isSsl":false,
"deploymentName":"Local",
"enabled":true,
"deploymentId":"df366222-2166-4714-90d8-9ebeefa5b00e",
"status":"running",
"serviceName":"adminsrvr",
"locked":false,
"serviceId":"a8efffba-4697-4e21-8c38-b8170e86c796",
"listeners":[
{
"address":"127.0.0.1",
"port":11001
},
{
"address":"172.17.0.3",
"port":11001
}
]
},
{
"isSsl":false,
"deploymentName":"Local",
"enabled":true,
"deploymentId":"df366222-2166-4714-90d8-9ebeefa5b00e",
"status":"running",
"serviceName":"distsrvr",
"locked":false,
"serviceId":"1f19e408-7ae8-4fe7-9b1e-d433aaf9f4bc",
"listeners":[
{
"address":"127.0.0.1",
"port":11002
},
{
"address":"172.17.0.3",
"port":11002
}
]
},
{
"isSsl":false,
"deploymentName":"Local",
"enabled":true,
"deploymentId":"df366222-2166-4714-90d8-9ebeefa5b00e",
"status":"running",
"serviceName":"pmsrvr",
"locked":false,
"serviceId":"eef56c08-ff49-4cc6-aa12-7fc462ec9027",
"listeners":[
{
"address":"127.0.0.1",
"port":11004
},
{
"address":"172.17.0.3",
"port":11004
}
]
},
{
"isSsl":false,
"deploymentName":"Local",
"enabled":true,
"deploymentId":"df366222-2166-4714-90d8-9ebeefa5b00e",
"status":"running",
"serviceName":"recvsrvr",
"locked":false,
"serviceId":"0f5d8b3f-d04a-40a3-8732-a38572bb8a9a",
"listeners":[
{
"address":"127.0.0.1",
"port":11003
},
{
"address":"172.17.0.3",
"port":11003
}
]
},
{
"isSsl":false,
"deploymentName":"ServiceManager",
"enabled":true,
"deploymentId":"74d78f7b-0944-4440-b2dc-9cbdd97dbe23",
"status":"running",
"serviceName":"ServiceManager",
"locked":false,
"serviceId":"3f0a0781-aac6-42e4-96d8-a732456a24fc",
"listeners":[
{
"address":"127.0.0.1",
"port":11000
},
{
"address":"172.17.0.3",
"port":11000
}
]
}
]
}
}