Oracle GoldenGate REST API 21c (21.1.0)

ステータスの取得

get

/services/{version}/extracts/{extract}/info/status

Extractプロセスの現在のステータスを取得します。

リクエスト

パス・パラメータ

extract: string

最小長: 1

最大長: 8

パターン: ^[A-Z_$][A-Z0-9_$]*$

Extractの名前。Extract名は大文字で、先頭が英字、その後に英数字が最大で7文字続きます。
version: string

Oracle GoldenGateサービスのAPIバージョン。

指定できる値: [ "v2" ]

先頭に戻る

レスポンス

サポートされるメディア・タイプ

application/json

200レスポンス

プロセスのステータスが正常に取得されました。

ルート・スキーマ: Extract process status

型: object

タイトル: Extract process status

ソースの表示

$schema(optional):

指定できる値: [ "ogg:extractStatus" ]
lag(optional): integer

最小値: 0

最大値: 4.294967295E9

プロセス・ラグ(秒)
lastStarted: lastStarted
position(optional): position
processId(optional): integer

最小値: 1

最大値: 4.294967295E9
sinceLagReported(optional): integer

最小値: 0

最大値: 4.294967295E9

プロセス・ラグがレポートされてからの秒数
status:

指定できる値: [ "starting", "running", "stopped", "killed", "abended" ]

{
    "title":"Extract process status",
    "required":[
        "status",
        "lastStarted"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:extractStatus"
            ]
        },
        "status":{
            "enum":[
                "starting",
                "running",
                "stopped",
                "killed",
                "abended"
            ]
        },
        "lastStarted":{
            "x-oneOf":[
                {
                    "type":"string",
                    "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])$",
                    "minLength":20,
                    "maxLength":32
                },
                {
                    "type":"null"
                }
            ]
        },
        "position":{
            "x-anyOf":[
                {
                    "x-oneOf":[
                        {
                            "description":"Normal format",
                            "type":"integer",
                            "minimum":0,
                            "maximum":9.223372036854776E18
                        },
                        {
                            "description":"Alternate format",
                            "type":"string",
                            "pattern":"[0-9]+[.][0-9]+",
                            "minLength":3,
                            "maxLength":64
                        }
                    ]
                },
                {
                    "type":"string",
                    "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])$",
                    "minLength":20,
                    "maxLength":32
                },
                {
                    "description":"Record number for table source",
                    "type":"integer",
                    "minimum":0,
                    "maximum":9.223372036854776E18
                },
                {
                    "description":"Position at a specific SCN (integrated mode)",
                    "type":"object",
                    "properties":{
                        "csn":{
                            "x-oneOf":[
                                {
                                    "description":"Normal format",
                                    "type":"integer",
                                    "minimum":0,
                                    "maximum":9.223372036854776E18
                                },
                                {
                                    "description":"Alternate format",
                                    "type":"string",
                                    "pattern":"[0-9]+[.][0-9]+",
                                    "minLength":3,
                                    "maxLength":64
                                }
                            ]
                        }
                    },
                    "required":[
                        "csn"
                    ],
                    "additionalProperties":false
                }
            ]
        },
        "lag":{
            "description":"Process lag in seconds",
            "type":"integer",
            "minimum":0,
            "maximum":4.294967295E9
        },
        "sinceLagReported":{
            "description":"Time in seconds since process lag was reported",
            "type":"integer",
            "minimum":0,
            "maximum":4.294967295E9
        },
        "processId":{
            "type":"integer",
            "minimum":1,
            "maximum":4.294967295E9
        }
    },
    "additionalProperties":false
}

ネストされたスキーマ: lastStarted

1つに一致

ソースの表示

string

最小長: 20

最大長: 32

パターン: ^[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])$
null

{
    "x-oneOf":[
        {
            "type":"string",
            "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])$",
            "minLength":20,
            "maxLength":32
        },
        {
            "type":"null"
        }
    ]
}

ネストされたスキーマ: position

いずれかに一致

ソースの表示

position-x-anyOf[0]
string

最小長: 20

最大長: 32

パターン: ^[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])$
integer

最小値: 0

最大値: 9.223372036854776E18

表ソースのレコード番号
object position-x-anyOf[3]

特定のSCNの位置(統合モード)

{
    "x-anyOf":[
        {
            "x-oneOf":[
                {
                    "description":"Normal format",
                    "type":"integer",
                    "minimum":0,
                    "maximum":9.223372036854776E18
                },
                {
                    "description":"Alternate format",
                    "type":"string",
                    "pattern":"[0-9]+[.][0-9]+",
                    "minLength":3,
                    "maxLength":64
                }
            ]
        },
        {
            "type":"string",
            "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])$",
            "minLength":20,
            "maxLength":32
        },
        {
            "description":"Record number for table source",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        {
            "description":"Position at a specific SCN (integrated mode)",
            "type":"object",
            "properties":{
                "csn":{
                    "x-oneOf":[
                        {
                            "description":"Normal format",
                            "type":"integer",
                            "minimum":0,
                            "maximum":9.223372036854776E18
                        },
                        {
                            "description":"Alternate format",
                            "type":"string",
                            "pattern":"[0-9]+[.][0-9]+",
                            "minLength":3,
                            "maxLength":64
                        }
                    ]
                }
            },
            "required":[
                "csn"
            ],
            "additionalProperties":false
        }
    ]
}

ネストされたスキーマ: position-x-anyOf[0]

1つに一致

ソースの表示

integer

最小値: 0

最大値: 9.223372036854776E18

標準の形式
string

最小長: 3

最大長: 64

パターン: [0-9]+[.][0-9]+

代替の形式

{
    "x-oneOf":[
        {
            "description":"Normal format",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        {
            "description":"Alternate format",
            "type":"string",
            "pattern":"[0-9]+[.][0-9]+",
            "minLength":3,
            "maxLength":64
        }
    ]
}

ネストされたスキーマ: position-x-anyOf[3]

型: object

特定のSCNの位置(統合モード)

ソースの表示

csn: csn

{
    "description":"Position at a specific SCN (integrated mode)",
    "type":"object",
    "properties":{
        "csn":{
            "x-oneOf":[
                {
                    "description":"Normal format",
                    "type":"integer",
                    "minimum":0,
                    "maximum":9.223372036854776E18
                },
                {
                    "description":"Alternate format",
                    "type":"string",
                    "pattern":"[0-9]+[.][0-9]+",
                    "minLength":3,
                    "maxLength":64
                }
            ]
        }
    },
    "required":[
        "csn"
    ],
    "additionalProperties":false
}

ネストされたスキーマ: csn

1つに一致

ソースの表示

integer

最小値: 0

最大値: 9.223372036854776E18

標準の形式
string

最小長: 3

最大長: 64

パターン: [0-9]+[.][0-9]+

代替の形式

{
    "x-oneOf":[
        {
            "description":"Normal format",
            "type":"integer",
            "minimum":0,
            "maximum":9.223372036854776E18
        },
        {
            "description":"Alternate format",
            "type":"string",
            "pattern":"[0-9]+[.][0-9]+",
            "minLength":3,
            "maxLength":64
        }
    ]
}

レスポンスの例(application/json)

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:11001/services/v2/extracts/EXT2/info/status",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/extracts/EXT2/info/status",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:11001/services/v2/metadata-catalog/extractStatus",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:extractStatus",
        "lag":0,
        "lastStarted":"2021-03-15T17:22:30.194Z",
        "position":"0.1542475",
        "processId":1384,
        "sinceLagReported":9,
        "status":"running"
    }
}

先頭に戻る