1. Oracle GoldenGate Microservices REST APIs
  2. Tasks
  3. Service Manager
  4. Installation

Get Backend

get

/services/{version}/installation/configuration/backends/{backend}

Required Role: Administrator

Retrieve the details for the Backend identified by {backend}

Request

Path Parameters
  • Minimum Length: 36
    Maximum Length: 36
    Pattern: ^[0-9a-fA-F]{8}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{4}[-][0-9a-fA-F]{12}$

    Identifier for a Configuration Service Backend.

  • Oracle GoldenGate Service API version.

    Allowed Values: [ "v2" ]
Back to Top

Response

Supported Media Types

200 Response

Backend retrieved
Body ()
Root Schema : Configuration Service Backend
Type: object
Title: Configuration Service Backend
Each configuration data item is stored in a "Backend" which is a reference to an external location for data persistence, encryption, and other capabilities. A Backend can be as simple as a directory in a local filesystem or more complicated like an encryption storage service.
Show Source
  • Allowed Values: [ "config:backend" ]
    The unique identifier for this JSON schema
  • configuration
    Additional configuration data needed by the Backend
  • Default Value: false
    If true, data is encrypted at rest in the Backend
  • Minimum Length: 1
    Maximum Length: 256
    The key to use for encrypting data in the Backend; if not specified, a random key will be generated
  • Unique identifier for the Backend
  • Default Value: false
    This Backend does not accept any requests
  • messages
    Minimum Number of Items: 0
    Maximum Number of Items: 65535
    Oracle GoldenGate messages issued during the request
  • Minimum Length: 1
    Maximum Length: 512
    Human-friendly name for the Backend
  • options
    Minimum Number of Items: 0
    Maximum Number of Items: 1
    Configuration options for the Backend
  • Default Value: false
    This Backend does not accept any requests that modify data
  • replaced
    Minimum Number of Items: 1
    Maximum Number of Items: 512
    The Backends that this backend replaced
  • The Backend that replaced this backend
  • Allowed Values: [ "Files", "HAMIWS", "Legacy", "Memory", "MongoDB", "Oracle", "Wallet" ]
    The type of the Backend
Example:
{
    "$schema":"config:backend",
    "id":"5086c4c1-4f48-4c13-9fad-095f23072a5b",
    "name":"Default Filesystem",
    "type":"Files",
    "options":[
        "duplicateNames"
    ],
    "configuration":{
        "directory":"${OGG_VAR_HOME}/lib/conf/ConfigurationService/"
    }
}
Nested Schema : configuration
Additional configuration data needed by the Backend
Match Any
Show Source
Nested Schema : messages
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 65535
Oracle GoldenGate messages issued during the request
Show Source
Nested Schema : options
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 1
Configuration options for the Backend
Show Source
Nested Schema : replaced
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 512
The Backends that this backend replaced
Show Source
Nested Schema : configuration-x-anyOf[0]
Type: object
Show Source
  • Minimum Length: 1
    Maximum Length: 1024
    The directory for storing configuration data.
Nested Schema : configuration-x-anyOf[1]
Type: object
Show Source
Nested Schema : configuration-x-anyOf[2]
Type: object
Show Source
Nested Schema : configuration-x-anyOf[3]
Type: object
Show Source
  • Minimum Length: 1
    Maximum Length: 255
    Pattern: ^[^$]{0,255}$
    The name of the MongoDB collection. The default value is `config:backend:id`.
  • Minimum Length: 1
    Maximum Length: 63
    Pattern: ^[^\/\\. "$*<>:|?]{1,63}$
    The name of the MongoDB database. The default value is `config:configurationFile:installationId`.
  • Minimum Length: 1
    Maximum Length: 256
    The password of the user for authenticating with the MongoDB server.
  • Minimum Length: 2
    Maximum Length: 4095
    Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
    The URI for the MongoDB server.
  • Minimum Length: 1
    Maximum Length: 512
    The name of the user for authenticating with the MongoDB server.
Nested Schema : configuration-x-anyOf[4]
Type: object
Show Source
  • Minimum Length: 1
    Maximum Length: 4096
    Information used to identify and connect to an Oracle database.
  • Minimum Length: 1
    Maximum Length: 1024
    The password of the user for authenticating with the Oracle database.
  • Minimum Length: 1
    Maximum Length: 512
    The name of the Oracle table to use. The default value is `config:backend:id`.
  • Minimum Length: 1
    Maximum Length: 1024
    The name of the user defined in the Oracle database.
Nested Schema : configuration-x-anyOf[5]
Type: object
Show Source
  • Minimum Length: 4
    Maximum Length: 139810134
    Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{2}==)?$
    The base64 encoded Oracle Wallet data - up to 100MB
  • Minimum Length: 1
    Maximum Length: 1024
    The directory for the Oracle Wallet
  • Default Value: false
    Indicates the Oracle Wallet should be serialized to the 'data' property
Nested Schema : caCertificates
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 128
A collection of CA certificates to use when connecting to the ensemble.
Show Source
Nested Schema : ensemble
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 64
Addresses of one or more members of the HAMIWS ensemble
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : host
Host name or IP Address
Match One
Show Source
  • Minimum Length: 1
    Maximum Length: 4095
    Pattern: ^(((([a-zA-Z0-9][-a-zA-Z0-9]{0,61})?[a-zA-Z0-9])[.])*([a-zA-Z][-a-zA-Z0-9]{0,61}[a-zA-Z0-9]|[a-zA-Z])[.]?)$
    Network host name
  • host-x-oneOf[1]
    Network IP address
Nested Schema : host-x-oneOf[1]
Network IP address
Match One
Show Source
  • 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
  • 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
Nested Schema : items
Type: object
Show Source
  • Allowed Values: [ "ogg:message" ]
  • Minimum Length: 9
    Maximum Length: 9
    Pattern: ^OGG[-][0-9]{5}$
    The Oracle GoldenGate message code
  • Minimum Length: 20
    Maximum Length: 32
    Pattern: ^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$
    The date and time that the message was issued
  • Allowed Values: [ "INFO", "WARNING", "ERROR" ]
    The severity of the message
  • Minimum Length: 1
    Maximum Length: 4095
    A human-readable description that provides information and detail specific to this occurence of the information, warning or error.
  • Minimum Length: 2
    Maximum Length: 4095
    Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
    An absolute URI [RFC3986] to a page that describes the info, warning or error type.
Nested Schema : items
Match Any
Show Source
  • Allowed Values: [ "duplicateNames" ]
    Data item names may be repeated for children of the same parent
Example Response (application/json)
{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:9011/services/v2/installation/configuration/backends/24d9565c-3f4d-49ea-9b1e-61df05c368c3",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9011/services/v2/installation/configuration/backends/24d9565c-3f4d-49ea-9b1e-61df05c368c3",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"config:backend",
        "id":"24d9565c-3f4d-49ea-9b1e-61df05c368c3",
        "name":"Temporary",
        "type":"Memory"
    }
}
Back to Top