1. Oracle GoldenGate 23ai Microservices Architecture REST API Documentation
  2. Tasks
  3. Administration Service
  4. Tasks

Retrieve Task Status

get

/services/{version}/tasks/{task}/info/status

Required Role: User

Retrieve the current status of an administrative task.

Request

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

    Task name, an alpha-numeric character followed by up to 63 alpha-numeric characters, '_' or '-'.

  • Oracle GoldenGate Service API version.

    Allowed Values: [ "v2" ]
Back to Top

Response

Supported Media Types

200 Response

Task status retrieved successfully.

Body ()
Root Schema : Administrative Server Task Status
Type: object
Title: Administrative Server Task Status
Show Source
  • Allowed Values: [ "ogg:taskStatus" ]
  • Minimum Value: 0
    Maximum Value: 255
    Exit code for finished task
  • 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])$
    Time that task finished
  • Default Value: false
    Flag indicates if process was killed manually
  • output
  • Minimum Value: 1
    Maximum Value: 4294967295
    Process identifier for task command
  • 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])$
    Time that task started
  • Allowed Values: [ "starting", "running", "stopped", "killed", "abended" ]
    Current task status or status when finished
Nested Schema : output
Match One
Show Source
Nested Schema : output-x-oneOf[1]
Type: object
Show Source
  • Allowed Values: [ "ogg:link" ]
  • Minimum Length: 1
    Maximum Length: 4095
    A human-readable description that provides information and detail specific to this link.
  • Minimum Length: 2
    Maximum Length: 4095
    Pattern: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$
    An absolute URI for the link
  • Minimum Length: 6
    Maximum Length: 255
    Pattern: ^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$
    Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288)
  • Allowed Values: [ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous", "ogg://service" ]
    Relationship of href to the requested link
Nested Schema : output-x-oneOf[2]
Type: object
Show Source
Nested Schema : containers
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 32767
Show Source
Nested Schema : items
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 1024
Show Source
Nested Schema : messages
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 1024
Show Source
Nested Schema : schemas
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 32767
Show Source
Nested Schema : tables
Type: array
Minimum Number of Items: 0
Maximum Number of Items: 32767
Show Source
Nested Schema : versions
Type: object
Show Source
Nested Schema : items
Match One
Show Source
  • Minimum Length: 1
    Maximum Length: 130
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])$
Nested Schema : items
Match One
Show Source
Nested Schema : items-x-oneOf[0]
Type: object
Show Source
Nested Schema : items-x-oneOf[1]
Type: object
Show Source
Nested Schema : result
Match One
Show Source
Nested Schema : result-x-oneOf[1]
Type: object
Report on Process Lag
Show Source
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
  • Minimum Length: 1
    Maximum Length: 130
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])$
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
Nested Schema : items
Match Any
Show Source
  • Minimum Length: 3
    Maximum Length: 261
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
  • Minimum Length: 5
    Maximum Length: 392
    Pattern: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
Nested Schema : build
Type: object
Oracle GoldenGate build information
Show Source
Nested Schema : database
Type: array
Minimum Number of Items: 1
Maximum Number of Items: 100
Database version information
Show Source
Nested Schema : operatingSystem
Operating System version information
Match One
Show Source
Nested Schema : operatingSystem-x-oneOf[0]
Type: object
Show Source
Nested Schema : operatingSystem-x-oneOf[1]
Type: object
Show Source
Example Response (application/json)
{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:9012/services/v2/tasks/ReportLag/info/status",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9012/services/v2/tasks/ReportLag/info/status",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:9012/services/v2/metadata-catalog/taskStatus",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:taskStatus",
        "status":"stopped"
    }
}
Back to Top