1. Oracle GoldenGate 19c Microservices Architecture REST API
  2. Tasks
  3. Service Manager
  4. Deployments

Retrieve Deployment

get

/services/{version}/deployments/{deployment}

Retrieve the details of a deployment.

Request

Path Parameters
  • Minimum Length: 1
    Maximum Length: 32
    Pattern: ^[A-Za-z][A-Za-z0-9-_.]*$

    Name for the Oracle GoldenGate deployment.

  • Oracle GoldenGate Service API version.

    Allowed Values: [ "v2" ]
Back to Top

Response

Supported Media Types

200 Response

The deployment details were retrieved successfully.

Body ()
Root Schema : Oracle GoldenGate Deployment
Type: object
Title: Oracle GoldenGate Deployment
Properties for an Oracle GoldenGate deployment
Show Source
  • Allowed Values: [ "ogg:deployment" ]
  • Default Value: true
    Indicates the deployment is managed by the Service Manager
  • environment
    Minimum Number of Items: 1
    Maximum Number of Items: 1024
    Additional environment variables for the deployment
  • Minimum Length: 36
    Maximum Length: 36
    Default Value: 30ea2667-2023-4c38-b028-c5073e5f4b81
    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}$
    An identifier that uniquely identifies this deployment
  • Minimum Length: 1
    Maximum Length: 4096
    Default Value: conf
    The deployment's configuration directory
  • Minimum Length: 1
    Maximum Length: 4096
    Default Value: data
    The deployment's var/data user data directory
  • Minimum Length: 1
    Maximum Length: 4096
    Default Value: etc
    The deployment's etc configuration directory
  • Minimum Length: 1
    Maximum Length: 4096
    The deployment's home directory
  • Minimum Length: 1
    Maximum Length: 4096
    Default Value: ssl
    The deployment's SSL configuration directory
  • Minimum Length: 1
    Maximum Length: 4096
    Default Value: var
    The deployment's var user data directory
  • Minimum Length: 1
    Maximum Length: 256
    Default Value: (?=^.{8,30}$)(?=(.*[0-9]))(?=(.*[A-Z]))(?=(.*[a-z]))(?=(.*[-!@%&*.#_]))(?!(.*[$^?]))^.*
    The regular expression that new user passwords must match
  • Default Value: stopped
    Allowed Values: [ "running", "stopped", "restart", "killed", "abended" ]
    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: object
Show Source
  • Minimum Length: 1
    Maximum Length: 64
    Pattern: [a-zA-Z0-9_]{1,64}
    Environment variable name
  • 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,
        "id":"df366222-2166-4714-90d8-9ebeefa5b00e",
        "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":"${ORACLE_HOME}/lib:/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.201.b09-2.el7_6.x86_64/jre/lib/amd64/server:/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.201.b09-2.el7_6.x86_64/jre/lib/amd64:/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.201.b09-2.el7_6.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"
            }
        ],
        "passwordRegex":"(?=^.{8,30}$)(?=(.*[0-9]))(?=(.*[A-Z]))(?=(.*[a-z]))(?=(.*[-!@%&*.#_]))(?!(.*[$^?]))^.*"
    }
}
Back to Top