Oracle GoldenGate Microservices REST API

Retrieve Deployment List

get

/services/{version}/installation/deployments

Required Role: Any

Retrieve a list of all Oracle GoldenGate deployments for the installation.

Request

Path Parameters

version(required): string

Oracle GoldenGate Service API version.

Allowed Values: [ "v2" ]

Query Parameters

deployment: string

The name of a deployment for filtering results

Response

Supported Media Types

application/json

200 Response

The deployment list was retrieved successfully.

Root Schema : Oracle GoldenGate Deployments for the Installation

Type: object

Title: Oracle GoldenGate Deployments for the Installation

List of all Oracle GoldenGate deployments for the installation

Show Source

$schema:

Allowed Values: [ "ogg:installationDeployments" ]
deployments(required): array deployments

Minimum Number of Items: 1

Maximum Number of Items: 65535

Array of deployments for the installation
xagEnabled(required): boolean

Indicates that the installation is managed by XAG

{
    "title":"Oracle GoldenGate Deployments for the Installation",
    "description":"List of all Oracle GoldenGate deployments for the installation",
    "required":[
        "xagEnabled",
        "deployments"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:installationDeployments"
            ]
        },
        "xagEnabled":{
            "description":"Indicates that the installation is managed by XAG",
            "type":"boolean"
        },
        "deployments":{
            "type":"array",
            "description":"Array of deployments for the installation",
            "items":{
                "description":"Deployment characteristics",
                "type":"object",
                "properties":{
                    "deploymentId":{
                        "description":"The unique identifier for the deployment",
                        "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"
                    },
                    "deploymentName":{
                        "description":"The name for the deployment",
                        "type":"string",
                        "pattern":"^[A-Za-z][A-Za-z0-9-_.]*$",
                        "minLength":"1",
                        "maxLength":"32"
                    },
                    "enabled":{
                        "description":"Indicates the deployment is managed by the Service Manager",
                        "type":"boolean"
                    },
                    "status":{
                        "description":"Indicates the status of the deployment",
                        "enum":[
                            "running",
                            "stopped",
                            "restart",
                            "killed",
                            "abended"
                        ],
                        "default":"stopped"
                    }
                },
                "required":[
                    "deploymentId",
                    "deploymentName",
                    "enabled",
                    "status"
                ]
            },
            "minItems":"1",
            "maxItems":"65535"
        }
    }
}

Nested Schema : deployments

Type: array

Minimum Number of Items: 1

Maximum Number of Items: 65535

Array of deployments for the installation

Show Source

Array of: object items

Deployment characteristics

{
    "type":"array",
    "description":"Array of deployments for the installation",
    "items":{
        "description":"Deployment characteristics",
        "type":"object",
        "properties":{
            "deploymentId":{
                "description":"The unique identifier for the deployment",
                "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"
            },
            "deploymentName":{
                "description":"The name for the deployment",
                "type":"string",
                "pattern":"^[A-Za-z][A-Za-z0-9-_.]*$",
                "minLength":"1",
                "maxLength":"32"
            },
            "enabled":{
                "description":"Indicates the deployment is managed by the Service Manager",
                "type":"boolean"
            },
            "status":{
                "description":"Indicates the status of the deployment",
                "enum":[
                    "running",
                    "stopped",
                    "restart",
                    "killed",
                    "abended"
                ],
                "default":"stopped"
            }
        },
        "required":[
            "deploymentId",
            "deploymentName",
            "enabled",
            "status"
        ]
    },
    "minItems":"1",
    "maxItems":"65535"
}

Nested Schema : items

Type: object

Deployment characteristics

Show Source

deploymentId(required): 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 the deployment
deploymentName(required): string

Minimum Length: 1

Maximum Length: 32

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

The name for the deployment
enabled(required): boolean

Indicates the deployment is managed by the Service Manager
status(required):

Default Value: stopped

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

Indicates the status of the deployment

{
    "description":"Deployment characteristics",
    "type":"object",
    "properties":{
        "deploymentId":{
            "description":"The unique identifier for the deployment",
            "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"
        },
        "deploymentName":{
            "description":"The name for the deployment",
            "type":"string",
            "pattern":"^[A-Za-z][A-Za-z0-9-_.]*$",
            "minLength":"1",
            "maxLength":"32"
        },
        "enabled":{
            "description":"Indicates the deployment is managed by the Service Manager",
            "type":"boolean"
        },
        "status":{
            "description":"Indicates the status of the deployment",
            "enum":[
                "running",
                "stopped",
                "restart",
                "killed",
                "abended"
            ],
            "default":"stopped"
        }
    },
    "required":[
        "deploymentId",
        "deploymentName",
        "enabled",
        "status"
    ]
}

Example Response (application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:11001/services/v2/installation/deployments",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/installation/deployments",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:11001/services/v2/metadata-catalog/deployments",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:installationDeployments",
        "deployments":[
            {
                "deploymentId":"0e9b899b-6f49-4165-ad3b-403a0dc1677e",
                "deploymentName":"Certificates",
                "enabled":true,
                "status":"stopped"
            },
            {
                "deploymentId":"808bf044-02df-4234-aaf3-3c1b649b8bc6",
                "deploymentName":"Local",
                "enabled":true,
                "status":"running"
            },
            {
                "deploymentId":"a21f8f5a-3ca5-4e04-9772-a98e675e84b3",
                "deploymentName":"ServiceManager",
                "enabled":true,
                "status":"running"
            }
        ],
        "xagEnabled":false
    }
}