Oracle GoldenGate Microservices REST API

Retrieve Deployment

get

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

Required Role: User

Retrieve the details of a deployment.

Request

Path Parameters

deployment(required): string

Minimum Length: 1

Maximum Length: 32

Pattern: ^[A-Za-z][A-Za-z0-9-_.]*$

Name for the Oracle GoldenGate deployment.
version(required): string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Response

Supported Media Types

application/json

200 Response

The deployment details were retrieved successfully.

Root Schema : Oracle GoldenGate Deployment

Type: object

Title: Oracle GoldenGate Deployment

Properties for an Oracle GoldenGate deployment

Show Source

$schema:

Allowed Values: [ "ogg:deployment" ]
enabled: boolean

Default Value: true

Indicates the deployment is managed by the Service Manager
environment: array environment

Minimum Number of Items: 1

Maximum Number of Items: 1024

Additional environment variables for the deployment
id: string

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
oggConfHome: string

Minimum Length: 1

Maximum Length: 4096

Default Value: conf

The deployment's configuration directory
oggDataHome: string

Minimum Length: 1

Maximum Length: 4096

Default Value: data

The deployment's var/data user data directory
oggEtcHome: string

Minimum Length: 1

Maximum Length: 4096

Default Value: etc

The deployment's etc configuration directory
oggHome: string

Minimum Length: 1

Maximum Length: 4096

The deployment's home directory
oggSharedSslHome: string

Minimum Length: 1

Maximum Length: 4096

Default Value: sharedssl

The deployment's shared SSL configuration directory
oggSslHome: string

Minimum Length: 1

Maximum Length: 4096

Default Value: ssl

The deployment's SSL configuration directory
oggVarHome: string

Minimum Length: 1

Maximum Length: 4096

Default Value: var

The deployment's var user data directory
passwordRegex: string

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
status:

Default Value: stopped

Allowed Values: [ "running", "stopped", "restart", "killed", "abended" ]

Indicates the status of the deployment

{
    "title":"Oracle GoldenGate Deployment",
    "description":"Properties for an Oracle GoldenGate deployment",
    "type":"object",
    "properties":{
        "oggHome":{
            "description":"The deployment's home directory",
            "type":"string",
            "minLength":"1",
            "maxLength":"4096"
        },
        "oggDataHome":{
            "description":"The deployment's var/data user data directory",
            "default":"data",
            "type":"string",
            "minLength":"1",
            "maxLength":"4096"
        },
        "oggConfHome":{
            "description":"The deployment's configuration directory",
            "default":"conf",
            "type":"string",
            "minLength":"1",
            "maxLength":"4096"
        },
        "enabled":{
            "description":"Indicates the deployment is managed by the Service Manager",
            "type":"boolean",
            "default":true
        },
        "id":{
            "description":"An identifier that uniquely identifies this deployment",
            "default":"30ea2667-2023-4c38-b028-c5073e5f4b81",
            "type":"string",
            "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}$",
            "minLength":"36",
            "maxLength":"36"
        },
        "oggSslHome":{
            "description":"The deployment's SSL configuration directory",
            "default":"ssl",
            "type":"string",
            "minLength":"1",
            "maxLength":"4096"
        },
        "$schema":{
            "enum":[
                "ogg:deployment"
            ]
        },
        "status":{
            "description":"Indicates the status of the deployment",
            "enum":[
                "running",
                "stopped",
                "restart",
                "killed",
                "abended"
            ],
            "default":"stopped"
        },
        "oggEtcHome":{
            "description":"The deployment's etc configuration directory",
            "default":"etc",
            "type":"string",
            "minLength":"1",
            "maxLength":"4096"
        },
        "oggVarHome":{
            "description":"The deployment's var user data directory",
            "default":"var",
            "type":"string",
            "minLength":"1",
            "maxLength":"4096"
        },
        "environment":{
            "description":"Additional environment variables for the deployment",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "description":"Environment variable name",
                        "type":"string",
                        "pattern":"[a-zA-Z0-9_]{1,64}",
                        "minLength":"1",
                        "maxLength":"64"
                    },
                    "value":{
                        "description":"Environment variable value",
                        "type":"string",
                        "minLength":"1",
                        "maxLength":"4095"
                    }
                },
                "required":[
                    "name",
                    "value"
                ],
                "additionalProperties":false
            },
            "minItems":"1",
            "maxItems":"1024"
        },
        "passwordRegex":{
            "description":"The regular expression that new user passwords must match",
            "type":"string",
            "default":"(?=^.{8,30}$)(?=(.*[0-9]))(?=(.*[A-Z]))(?=(.*[a-z]))(?=(.*[-!@%&*.#_]))(?!(.*[$^?]))^.*",
            "minLength":"1",
            "maxLength":"256"
        },
        "oggSharedSslHome":{
            "description":"The deployment's shared SSL configuration directory",
            "default":"sharedssl",
            "type":"string",
            "minLength":"1",
            "maxLength":"4096"
        }
    },
    "additionalProperties":false
}

Nested Schema : environment

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 1024

Additional environment variables for the deployment

Show Source

Array of: object items

{
    "description":"Additional environment variables for the deployment",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "description":"Environment variable name",
                "type":"string",
                "pattern":"[a-zA-Z0-9_]{1,64}",
                "minLength":"1",
                "maxLength":"64"
            },
            "value":{
                "description":"Environment variable value",
                "type":"string",
                "minLength":"1",
                "maxLength":"4095"
            }
        },
        "required":[
            "name",
            "value"
        ],
        "additionalProperties":false
    },
    "minItems":"1",
    "maxItems":"1024"
}

Nested Schema : items

Type: object

Show Source

name(required): string

Minimum Length: 1

Maximum Length: 64

Pattern: [a-zA-Z0-9_]{1,64}

Environment variable name
value(required): string

Minimum Length: 1

Maximum Length: 4095

Environment variable value

{
    "type":"object",
    "properties":{
        "name":{
            "description":"Environment variable name",
            "type":"string",
            "pattern":"[a-zA-Z0-9_]{1,64}",
            "minLength":"1",
            "maxLength":"64"
        },
        "value":{
            "description":"Environment variable value",
            "type":"string",
            "minLength":"1",
            "maxLength":"4095"
        }
    },
    "required":[
        "name",
        "value"
    ],
    "additionalProperties":false
}

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":"808bf044-02df-4234-aaf3-3c1b649b8bc6",
        "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":"/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.292.b10-1.el7_9.x86_64/jre/lib/amd64/server:/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.292.b10-1.el7_9.x86_64/jre/lib/amd64:/usr/lib/jvm/java-1.8.0-openjdk-1.8.0.292.b10-1.el7_9.x86_64/jre/../lib/amd64:/usr/lib/jvm/jre/lib/amd64/server:/u01/app/oracle/product/12cR2/dbhome/lib"
            },
            {
                "name":"TNS_ADMIN",
                "value":"/u02/ogg/Local/etc"
            },
            {
                "name":"JAVA_HOME",
                "value":"${OGG_HOME}/jdk"
            }
        ],
        "passwordRegex":"(?=^.{8,30}$)(?=(.*[0-9]))(?=(.*[A-Z]))(?=(.*[a-z]))(?=(.*[-!@%&*.#_]))(?!(.*[$^?]))^.*"
    }
}