Oracle GoldenGate

再起動ルールの置換

put

/services/{version}/config/restart/{rule}

既存の再起動ルールを置換します。

リクエスト

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

application/json

パス・パラメータ

rule: string

最小長: 1

最大長: 32

パターン: ^[A-Za-z0-9][A-Za-z0-9_-]*$

ルール名。英数字の後に最大31文字の英数字、_または-が続きます。
version: string

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

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

ルート・スキーマ: Oracle GoldenGate ER Process Restart Rule

型: object

タイトル: Oracle GoldenGate ER Process Restart Rule

ソースの表示

$schema(optional):

指定できる値: [ "ogg:processRestart" ]
delay(optional): integer

最小値: 0

最大値: 3600

デフォルト値: 120

異常終了したプロセスの検出からプロセスの再起動までの待機時間(秒)。
processName: string

最小長: 1

最大長: 8

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

プロセスのワイルドカード名
processType(optional):

デフォルト値: ER

指定できる値: [ "extract", "replicat", "ER" ]

プロセスのタイプ
retries(optional): integer

最小値: 0

最大値: 3600

デフォルト値: 2

再試行操作が中止されるまでタスクを再起動する最大回数。
window(optional): integer

最小値: 0

最大値: 604800

デフォルト値: 7200

再試行回数をカウントする時間枠(秒)。デフォルトは7200秒(2時間)です。

{
    "title":"Oracle GoldenGate ER Process Restart Rule",
    "required":[
        "processName"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:processRestart"
            ]
        },
        "processType":{
            "description":"The type of process",
            "enum":[
                "extract",
                "replicat",
                "ER"
            ],
            "default":"ER"
        },
        "processName":{
            "description":"Wildcard name of process",
            "type":"string",
            "pattern":"^[*A-Z_$][*A-Z0-9_$]*$",
            "minLength":1,
            "maxLength":8
        },
        "delay":{
            "description":"The amount of time, in seconds, to pause between discovering that a process has terminated abnormally and restarting the process.",
            "type":"integer",
            "minimum":0,
            "default":120,
            "maximum":3600
        },
        "retries":{
            "description":"The maximum number of times the task should be restarted before aborting retry efforts.",
            "type":"integer",
            "minimum":0,
            "default":2,
            "maximum":3600
        },
        "window":{
            "description":"The window of time, in seconds, during which retries are counted. The default is 7200 seconds (2 hours).",
            "type":"integer",
            "minimum":0,
            "default":7200,
            "maximum":604800
        }
    },
    "additionalProperties":false
}

リクエストの例(application/json)

{
    "processType":"extract",
    "processName":"EXT*",
    "delay":0,
    "retries":9,
    "window":5
}

先頭に戻る

レスポンス

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

application/json

200レスポンス

再起動ルールが正常に更新されました。

ルート・スキーマ: RESTful API Standard Response

型: object

タイトル: RESTful API Standard Response

すべてのOracle GoldenGate RESTful APIコールの標準レスポンス

ソースの表示

$schema(optional):

指定できる値: [ "api:standardResponse" ]
links: array links

最小アイテム数: 0

最大アイテム数: 16

リクエストのOracle GoldenGateリンク
messages: array messages

最小アイテム数: 0

最大アイテム数: 65535

リクエストの間に発行されるGoldenGateメッセージ
response(optional): object response

リクエストのOracle GoldenGateドキュメント

{
    "title":"RESTful API Standard Response",
    "description":"Standard Response for all Oracle GoldenGate RESTful API calls",
    "required":[
        "messages",
        "links"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "api:standardResponse"
            ]
        },
        "response":{
            "description":"Oracle GoldenGate document from the request",
            "type":"object"
        },
        "messages":{
            "description":"Oracle GoldenGate messages issued during the request",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "$schema":{
                        "enum":[
                            "ogg:message"
                        ]
                    },
                    "type":{
                        "description":"An absolute URI [RFC3986] to a page that describes the info, warning or error type.",
                        "type":"string",
                        "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
                        "minLength":2,
                        "maxLength":4095
                    },
                    "title":{
                        "description":"A human-readable description that provides information and detail specific to this occurence of the information, warning or error.",
                        "type":"string",
                        "minLength":1,
                        "maxLength":4095
                    },
                    "code":{
                        "description":"The Oracle GoldenGate message code",
                        "type":"string",
                        "pattern":"^OGG[-][0-9]{5}$",
                        "minLength":9,
                        "maxLength":9
                    },
                    "severity":{
                        "description":"The severity of the message",
                        "enum":[
                            "INFO",
                            "WARNING",
                            "ERROR"
                        ]
                    },
                    "issued":{
                        "description":"The date and time that the message was issued",
                        "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
                    }
                },
                "required":[
                    "type",
                    "title",
                    "code",
                    "severity",
                    "issued"
                ],
                "additionalProperties":false
            },
            "minItems":0,
            "maxItems":65535
        },
        "links":{
            "description":"Oracle GoldenGate links for the request",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "$schema":{
                        "enum":[
                            "ogg:link"
                        ]
                    },
                    "rel":{
                        "description":"Relationship of href to the requested link",
                        "enum":[
                            "alternate",
                            "canonical",
                            "current",
                            "describedby",
                            "describes",
                            "enclosure",
                            "parent",
                            "related",
                            "self",
                            "first",
                            "last",
                            "next",
                            "previous"
                        ]
                    },
                    "href":{
                        "description":"An absolute URI for the link",
                        "type":"string",
                        "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
                        "minLength":2,
                        "maxLength":4095
                    },
                    "mediaType":{
                        "description":"Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288)",
                        "type":"string",
                        "pattern":"^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$",
                        "minLength":6,
                        "maxLength":255
                    },
                    "description":{
                        "description":"A human-readable description that provides information and detail specific to this link.",
                        "type":"string",
                        "minLength":1,
                        "maxLength":4095
                    }
                },
                "required":[
                    "rel",
                    "href"
                ],
                "additionalProperties":false
            },
            "minItems":0,
            "maxItems":16
        }
    },
    "additionalProperties":false
}

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

型: array

最小アイテム数: 0

最大アイテム数: 16

リクエストのOracle GoldenGateリンク

ソースの表示

配列: object items

{
    "description":"Oracle GoldenGate links for the request",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "$schema":{
                "enum":[
                    "ogg:link"
                ]
            },
            "rel":{
                "description":"Relationship of href to the requested link",
                "enum":[
                    "alternate",
                    "canonical",
                    "current",
                    "describedby",
                    "describes",
                    "enclosure",
                    "parent",
                    "related",
                    "self",
                    "first",
                    "last",
                    "next",
                    "previous"
                ]
            },
            "href":{
                "description":"An absolute URI for the link",
                "type":"string",
                "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
                "minLength":2,
                "maxLength":4095
            },
            "mediaType":{
                "description":"Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288)",
                "type":"string",
                "pattern":"^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$",
                "minLength":6,
                "maxLength":255
            },
            "description":{
                "description":"A human-readable description that provides information and detail specific to this link.",
                "type":"string",
                "minLength":1,
                "maxLength":4095
            }
        },
        "required":[
            "rel",
            "href"
        ],
        "additionalProperties":false
    },
    "minItems":0,
    "maxItems":16
}

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

型: array

最小アイテム数: 0

最大アイテム数: 65535

リクエストの間に発行されるGoldenGateメッセージ

ソースの表示

配列: object items

{
    "description":"Oracle GoldenGate messages issued during the request",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "$schema":{
                "enum":[
                    "ogg:message"
                ]
            },
            "type":{
                "description":"An absolute URI [RFC3986] to a page that describes the info, warning or error type.",
                "type":"string",
                "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
                "minLength":2,
                "maxLength":4095
            },
            "title":{
                "description":"A human-readable description that provides information and detail specific to this occurence of the information, warning or error.",
                "type":"string",
                "minLength":1,
                "maxLength":4095
            },
            "code":{
                "description":"The Oracle GoldenGate message code",
                "type":"string",
                "pattern":"^OGG[-][0-9]{5}$",
                "minLength":9,
                "maxLength":9
            },
            "severity":{
                "description":"The severity of the message",
                "enum":[
                    "INFO",
                    "WARNING",
                    "ERROR"
                ]
            },
            "issued":{
                "description":"The date and time that the message was issued",
                "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
            }
        },
        "required":[
            "type",
            "title",
            "code",
            "severity",
            "issued"
        ],
        "additionalProperties":false
    },
    "minItems":0,
    "maxItems":65535
}

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

型: object

リクエストのOracle GoldenGateドキュメント

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

型: object

ソースの表示

$schema(optional):

指定できる値: [ "ogg:link" ]
description(optional): string

最小長: 1

最大長: 4095

このリンク固有の情報と詳細を提供する、人が読むための説明。
href: string

最小長: 2

最大長: 4095

パターン: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$

リンクの絶対URI
mediaType(optional): string

最小長: 6

最大長: 255

パターン: ^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$

メディア・タイプ - RFC 4288 (https://tools.ietf.org/html/rfc4288)を参照
rel:

指定できる値: [ "alternate", "canonical", "current", "describedby", "describes", "enclosure", "parent", "related", "self", "first", "last", "next", "previous" ]

hrefとリクエスト対象のリンクlinkの関係

{
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:link"
            ]
        },
        "rel":{
            "description":"Relationship of href to the requested link",
            "enum":[
                "alternate",
                "canonical",
                "current",
                "describedby",
                "describes",
                "enclosure",
                "parent",
                "related",
                "self",
                "first",
                "last",
                "next",
                "previous"
            ]
        },
        "href":{
            "description":"An absolute URI for the link",
            "type":"string",
            "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
            "minLength":2,
            "maxLength":4095
        },
        "mediaType":{
            "description":"Media type - see RFC 4288 (https://tools.ietf.org/html/rfc4288)",
            "type":"string",
            "pattern":"^(text|application)/[a-zA-Z0-9!#$&.+-^_]+$",
            "minLength":6,
            "maxLength":255
        },
        "description":{
            "description":"A human-readable description that provides information and detail specific to this link.",
            "type":"string",
            "minLength":1,
            "maxLength":4095
        }
    },
    "required":[
        "rel",
        "href"
    ],
    "additionalProperties":false
}

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

型: object

ソースの表示

$schema(optional):

指定できる値: [ "ogg:message" ]
code: string

最小長: 9

最大長: 9

パターン: ^OGG[-][0-9]{5}$

Oracle GoldenGateメッセージ・コード
issued: 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])$

メッセージが発行された日時
severity:

指定できる値: [ "INFO", "WARNING", "ERROR" ]

メッセージの重大度
title: string

最小長: 1

最大長: 4095

この情報、警告またはエラーに固有の情報と詳細を提供する、人が読むための説明。
type: string

最小長: 2

最大長: 4095

パターン: ^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \t]*$

情報、警告またはエラーのタイプを説明するページの絶対URI [RFC3986]。

{
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:message"
            ]
        },
        "type":{
            "description":"An absolute URI [RFC3986] to a page that describes the info, warning or error type.",
            "type":"string",
            "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
            "minLength":2,
            "maxLength":4095
        },
        "title":{
            "description":"A human-readable description that provides information and detail specific to this occurence of the information, warning or error.",
            "type":"string",
            "minLength":1,
            "maxLength":4095
        },
        "code":{
            "description":"The Oracle GoldenGate message code",
            "type":"string",
            "pattern":"^OGG[-][0-9]{5}$",
            "minLength":9,
            "maxLength":9
        },
        "severity":{
            "description":"The severity of the message",
            "enum":[
                "INFO",
                "WARNING",
                "ERROR"
            ]
        },
        "issued":{
            "description":"The date and time that the message was issued",
            "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
        }
    },
    "required":[
        "type",
        "title",
        "code",
        "severity",
        "issued"
    ],
    "additionalProperties":false
}

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

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:11001/services/v2/config/restart/Rule_001",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/config/restart/Rule_001",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "messages":[
        {
            "$schema":"ogg:message",
            "code":"OGG-08277",
            "issued":"2017-12-14T12:44:44Z",
            "severity":"INFO",
            "title":"Auto-restart rule 'Rule_001' has been updated.",
            "type":"http://docs.oracle.com/goldengate/c1230/gg-winux/GMESG/oggus.htm#OGG-08277"
        }
    ]
}

先頭に戻る