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:
objectTitle:
Oracle GoldenGate Services for the InstallationList of all Oracle GoldenGate services for the installation
Show Source
-
$schema(optional):
Allowed Values:
[ "ogg:installationServices" ] -
services:
array services
Minimum Number of Items:
1Maximum Number of Items:64Array of services for the installation
Nested Schema : services
Type:
arrayMinimum Number of Items:
1Maximum Number of Items:
64Array of services for the installation
Show Source
-
Array of:
object items
Service characteristics
Nested Schema : items
Type:
objectService characteristics
Show Source
-
critical:
boolean
Default Value:
trueIndicates the service is critical to the deployment -
deploymentId:
string
Minimum Length:
36Maximum Length:36Pattern:^[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:
1Maximum Length:32Pattern:^[A-Za-z][A-Za-z0-9-_.]*$The name for this service's deployment -
enabled:
boolean
Default Value:
trueIndicates the service is managed by the Service Manager -
isSsl:
boolean
Indicates that the service expects an SSL connection
-
links(optional):
array links
Minimum Number of Items:
0Maximum Number of Items:16Additional links for the service -
listeners:
array listeners
Minimum Number of Items:
1Maximum Number of Items:64Array of listener specifications for the service -
locked(optional):
boolean
Default Value:
falseIndicates the service is locked by a security administrator and cannot be started -
serviceId:
string
Minimum Length:
36Maximum Length:36Pattern:^[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:
1Maximum Length:64The name of this service -
status:
Default Value:
stoppedAllowed Values:[ "starting", "running", "stopped", "restart", "killed", "abended" ]Indicates the status of the service
Nested Schema : links
Type:
arrayMinimum Number of Items:
0Maximum Number of Items:
16Additional links for the service
Show Source
Nested Schema : listeners
Type:
arrayMinimum Number of Items:
1Maximum Number of Items:
64Array of listener specifications for the service
Show Source
-
Array of:
object items
Description of service listener
Nested Schema : items
Type:
Show Source
object-
$schema(optional):
Allowed Values:
[ "ogg:link" ] -
description(optional):
string
Minimum Length:
1Maximum Length:4095A human-readable description that provides information and detail specific to this link. -
href:
string
Minimum Length:
2Maximum Length:4095Pattern:^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$An absolute URI for the link -
mediaType(optional):
string
Minimum Length:
6Maximum Length:255Pattern:^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288) -
rel:
Allowed Values:
[ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous" ]Relationship of href to the requested link
Nested Schema : items
Type:
objectDescription of service listener
Show Source
-
address:
address
Service listening IP address
-
port:
integer
Minimum Value:
1Maximum Value:65535Service listening port number
Nested Schema : address
Service listening IP address
Match One
Show Source
-
string
Minimum Length:
7Maximum Length:15Pattern:^((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:
1Maximum Length:256Pattern:^((([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:11001/services/v2/installation/services",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:11001/services/v2/installation/services",
"mediaType":"application/json",
"rel":"self"
},
{
"href":"http://localhost:11001/services/v2/metadata-catalog/services",
"mediaType":"application/schema+json",
"rel":"describedby"
}
],
"messages":[
],
"response":{
"$schema":"ogg:installationServices",
"services":[
{
"isSsl":false,
"deploymentName":"Local",
"enabled":true,
"deploymentId":"808bf044-02df-4234-aaf3-3c1b649b8bc6",
"status":"running",
"critical":true,
"serviceName":"adminsrvr",
"links":[
{
"href":"http://localhost:11001/services/v2/content/",
"mediaType":"text/html",
"rel":"canonical"
}
],
"locked":false,
"serviceId":"716f5944-3680-4313-9a54-ba671503bd69",
"listeners":[
{
"address":"127.0.0.1",
"port":11001
},
{
"address":"172.17.0.3",
"port":11001
}
]
},
{
"isSsl":false,
"deploymentName":"Local",
"enabled":true,
"deploymentId":"808bf044-02df-4234-aaf3-3c1b649b8bc6",
"status":"running",
"critical":true,
"serviceName":"distsrvr",
"links":[
{
"href":"http://localhost:11002/services/v2/content/",
"mediaType":"text/html",
"rel":"canonical"
}
],
"locked":false,
"serviceId":"d0903636-ba4c-43b0-8fcd-607c0482de2c",
"listeners":[
{
"address":"127.0.0.1",
"port":11002
},
{
"address":"172.17.0.3",
"port":11002
}
]
},
{
"isSsl":false,
"deploymentName":"Local",
"enabled":true,
"deploymentId":"808bf044-02df-4234-aaf3-3c1b649b8bc6",
"status":"running",
"critical":false,
"serviceName":"pmsrvr",
"links":[
{
"href":"http://localhost:11004/services/v2/content/",
"mediaType":"text/html",
"rel":"canonical"
}
],
"locked":false,
"serviceId":"43f4df4c-af94-48db-b59a-72f16b99aefe",
"listeners":[
{
"address":"127.0.0.1",
"port":11004
},
{
"address":"172.17.0.3",
"port":11004
}
]
},
{
"isSsl":false,
"deploymentName":"Local",
"enabled":true,
"deploymentId":"808bf044-02df-4234-aaf3-3c1b649b8bc6",
"status":"running",
"critical":true,
"serviceName":"recvsrvr",
"links":[
{
"href":"http://localhost:11003/services/v2/content/",
"mediaType":"text/html",
"rel":"canonical"
}
],
"locked":false,
"serviceId":"535d5eed-4215-4867-9432-7394726e1b02",
"listeners":[
{
"address":"127.0.0.1",
"port":11003
},
{
"address":"172.17.0.3",
"port":11003
}
]
}
]
}
}