ジャンプ先

• リクエスト
• レスポンス

ステータスの取得

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:
  指定できる値: [ "ogg:extractStatus" ]
• lag: integer
  最小値: 0

  最大値: 4294967295

  プロセス・ラグ(秒)
• lastStarted(必須): lastStarted
• position: position
• processId: integer
  最小値: 1

  最大値: 4294967295
• sinceLagReported: integer
  最小値: 0

  最大値: 4294967295

  プロセス・ラグがレポートされてからの秒数
• 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":"System Change Number(Normal Format) for Oracle Database.",
                            "type":"integer",
                            "minimum":"0",
                            "maximum":"9223372036854776000",
                            "example":"6488359"
                        },
                        {
                            "description":"System Change Number(Alternate Format) for Oracle Database.",
                            "type":"string",
                            "pattern":"[0-9]+[.][0-9]+",
                            "minLength":"3",
                            "maxLength":"64",
                            "example":"6488359.3456712"
                        }
                    ]
                },
                {
                    "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":"9223372036854776000"
                },
                {
                    "description":"Position at a specific SCN (integrated mode)",
                    "type":"object",
                    "properties":{
                        "csn":{
                            "x-oneOf":[
                                {
                                    "description":"System Change Number(Normal Format) for Oracle Database.",
                                    "type":"integer",
                                    "minimum":"0",
                                    "maximum":"9223372036854776000",
                                    "example":"6488359"
                                },
                                {
                                    "description":"System Change Number(Alternate Format) for Oracle Database.",
                                    "type":"string",
                                    "pattern":"[0-9]+[.][0-9]+",
                                    "minLength":"3",
                                    "maxLength":"64",
                                    "example":"6488359.3456712"
                                }
                            ]
                        }
                    },
                    "required":[
                        "csn"
                    ],
                    "additionalProperties":false
                }
            ]
        },
        "lag":{
            "description":"Process lag in seconds",
            "type":"integer",
            "minimum":"0",
            "maximum":"4294967295"
        },
        "sinceLagReported":{
            "description":"Time in seconds since process lag was reported",
            "type":"integer",
            "minimum":"0",
            "maximum":"4294967295"
        },
        "processId":{
            "type":"integer",
            "minimum":"1",
            "maximum":"4294967295"
        }
    },
    "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

  最大値: 9223372036854776000

  表ソースのレコード番号
• object position-x-anyOf[3]
  特定のSCNの位置(統合モード)

{
    "x-anyOf":[
        {
            "x-oneOf":[
                {
                    "description":"System Change Number(Normal Format) for Oracle Database.",
                    "type":"integer",
                    "minimum":"0",
                    "maximum":"9223372036854776000",
                    "example":"6488359"
                },
                {
                    "description":"System Change Number(Alternate Format) for Oracle Database.",
                    "type":"string",
                    "pattern":"[0-9]+[.][0-9]+",
                    "minLength":"3",
                    "maxLength":"64",
                    "example":"6488359.3456712"
                }
            ]
        },
        {
            "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":"9223372036854776000"
        },
        {
            "description":"Position at a specific SCN (integrated mode)",
            "type":"object",
            "properties":{
                "csn":{
                    "x-oneOf":[
                        {
                            "description":"System Change Number(Normal Format) for Oracle Database.",
                            "type":"integer",
                            "minimum":"0",
                            "maximum":"9223372036854776000",
                            "example":"6488359"
                        },
                        {
                            "description":"System Change Number(Alternate Format) for Oracle Database.",
                            "type":"string",
                            "pattern":"[0-9]+[.][0-9]+",
                            "minLength":"3",
                            "maxLength":"64",
                            "example":"6488359.3456712"
                        }
                    ]
                }
            },
            "required":[
                "csn"
            ],
            "additionalProperties":false
        }
    ]
}

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

1つに一致

ソースの表示

• integer
  最小値: 0

  最大値: 9223372036854776000

  Oracle Databaseの場合のシステム変更番号(標準形式)。

  例: 6488359
• string
  最小長: 3

  最大長: 64

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

  Oracle Databaseの場合のシステム変更番号(代替形式)。

  例: 6488359.3456712

{
    "x-oneOf":[
        {
            "description":"System Change Number(Normal Format) for Oracle Database.",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000",
            "example":"6488359"
        },
        {
            "description":"System Change Number(Alternate Format) for Oracle Database.",
            "type":"string",
            "pattern":"[0-9]+[.][0-9]+",
            "minLength":"3",
            "maxLength":"64",
            "example":"6488359.3456712"
        }
    ]
}

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

型: object

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

ソースの表示

• csn(必須): csn

{
    "description":"Position at a specific SCN (integrated mode)",
    "type":"object",
    "properties":{
        "csn":{
            "x-oneOf":[
                {
                    "description":"System Change Number(Normal Format) for Oracle Database.",
                    "type":"integer",
                    "minimum":"0",
                    "maximum":"9223372036854776000",
                    "example":"6488359"
                },
                {
                    "description":"System Change Number(Alternate Format) for Oracle Database.",
                    "type":"string",
                    "pattern":"[0-9]+[.][0-9]+",
                    "minLength":"3",
                    "maxLength":"64",
                    "example":"6488359.3456712"
                }
            ]
        }
    },
    "required":[
        "csn"
    ],
    "additionalProperties":false
}

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

1つに一致

ソースの表示

• integer
  最小値: 0

  最大値: 9223372036854776000

  Oracle Databaseの場合のシステム変更番号(標準形式)。

  例: 6488359
• string
  最小長: 3

  最大長: 64

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

  Oracle Databaseの場合のシステム変更番号(代替形式)。

  例: 6488359.3456712

{
    "x-oneOf":[
        {
            "description":"System Change Number(Normal Format) for Oracle Database.",
            "type":"integer",
            "minimum":"0",
            "maximum":"9223372036854776000",
            "example":"6488359"
        },
        {
            "description":"System Change Number(Alternate Format) for Oracle Database.",
            "type":"string",
            "pattern":"[0-9]+[.][0-9]+",
            "minLength":"3",
            "maxLength":"64",
            "example":"6488359.3456712"
        }
    ]
}

レスポンスの例(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-07-13T16:37:29.021Z",
        "position":"0.1542600",
        "processId":"1837",
        "sinceLagReported":"0",
        "status":"running"
    }
}

先頭に戻る