ジャンプ先

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

Replicatの更新

patch

/services/{version}/replicats/{replicat}

既存のReplicatプロセスを更新します。

リクエスト

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

• application/json

パス・パラメータ

• replicat: string
  最小長: 1

  最大長: 8

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

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

• version: string

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

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

本文()

ルート・スキーマ: Oracle GoldenGate Replicat

型: object

タイトル: Oracle GoldenGate Replicat

ソースの表示

• $schema(optional):
  指定できる値: [ "ogg:replicat" ]
• begin(optional): begin
  データ処理の開始位置
• checkpoint(optional): checkpoint
  チェックポイント・データの場所
• config(optional): array config
  最小アイテム数: 0

  最大アイテム数: 32767
• credentials(optional): credentials
  ターゲット・データベースの資格証明
• description(optional): string
  最小長: 1

  最大長: 4095

  プロセスの説明
• intent(optional):
  デフォルト値: Unidirectional

  指定できる値: [ "High Availability", "Disaster Recovery", "Unidirectional", "N-Way", "Sharding" ]

  データ取得ワークフローの目的
• mode(optional): mode
  レプリケーションのモード
• registration(optional):
  デフォルト値: none

  指定できる値: [ "none", "standard" ]

  ターゲット・データベースへの登録
• source(optional): source
  処理するデータのソース
• status(optional):
  デフォルト値: stopped

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

  Oracle GoldenGateプロセスのステータス
• synchronized(optional): boolean
  Replicatが同期状態で停止されることを示します

{
    "title":"Oracle GoldenGate Replicat",
    "type":"object",
    "properties":{
        "begin":{
            "description":"Starting point for data processing",
            "default":"now",
            "x-oneOf":[
                {
                    "enum":[
                        "now"
                    ]
                },
                {
                    "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":"object",
                    "properties":{
                        "$schema":{
                            "enum":[
                                "type:position/atTrailRBA"
                            ]
                        },
                        "sequence":{
                            "description":"Trail file sequence number",
                            "type":"integer",
                            "minimum":0,
                            "maximum":999999999,
                            "default":0
                        },
                        "offset":{
                            "description":"Offset in trail sequence file",
                            "type":"integer",
                            "minimum":0,
                            "default":0,
                            "maximum":2147483647
                        }
                    },
                    "required":[
                        "sequence"
                    ],
                    "additionalProperties":false
                }
            ]
        },
        "config":{
            "type":"array",
            "items":{
                "type":"string",
                "minLength":0,
                "maxLength":4095
            },
            "minItems":0,
            "maxItems":32767
        },
        "synchronized":{
            "description":"Indicates that the Replicat is stopped in a synchronized state",
            "type":"boolean"
        },
        "mode":{
            "description":"Mode of replication",
            "x-oneOf":[
                {
                    "description":"Creates a standard, non-integrated Replicat",
                    "type":"object",
                    "properties":{
                        "type":{
                            "enum":[
                                "nonintegrated"
                            ]
                        },
                        "parallel":{
                            "description":"Apply multiple operations in parallel",
                            "type":"boolean",
                            "default":false
                        }
                    },
                    "required":[
                        "type"
                    ],
                    "additionalProperties":false
                },
                {
                    "description":"(Oracle Only) Creates a standard, integrated Replicat",
                    "type":"object",
                    "properties":{
                        "type":{
                            "enum":[
                                "integrated"
                            ]
                        },
                        "parallel":{
                            "description":"Apply multiple operations in parallel",
                            "type":"boolean",
                            "default":false
                        }
                    },
                    "required":[
                        "type"
                    ],
                    "additionalProperties":false
                },
                {
                    "description":"(Oracle Only) Coordinated Replicat",
                    "type":"object",
                    "properties":{
                        "type":{
                            "enum":[
                                "coordinated"
                            ]
                        },
                        "maxThreads":{
                            "type":"integer",
                            "minimum":1,
                            "maximum":500,
                            "default":25
                        },
                        "threadNumber":{
                            "type":"integer",
                            "minimum":1,
                            "maximum":500
                        }
                    },
                    "required":[
                        "type"
                    ],
                    "additionalProperties":false
                }
            ]
        },
        "$schema":{
            "enum":[
                "ogg:replicat"
            ]
        },
        "status":{
            "description":"Oracle GoldenGate Process Status",
            "default":"stopped",
            "enum":[
                "starting",
                "running",
                "stopped",
                "killed",
                "abended"
            ]
        },
        "intent":{
            "description":"Intent for data capture workflow",
            "enum":[
                "High Availability",
                "Disaster Recovery",
                "Unidirectional",
                "N-Way",
                "Sharding"
            ],
            "default":"Unidirectional"
        },
        "checkpoint":{
            "description":"Location for checkpoint data",
            "x-oneOf":[
                {
                    "description":"Use the local filesystem to store checkpoint data",
                    "enum":[
                        "files"
                    ]
                },
                {
                    "description":"Use the specified table to store checkpoint information",
                    "type":"object",
                    "properties":{
                        "table":{
                            "x-anyOf":[
                                {
                                    "type":"string",
                                    "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                                    "minLength":3,
                                    "maxLength":261
                                },
                                {
                                    "type":"string",
                                    "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                                    "minLength":5,
                                    "maxLength":392
                                }
                            ]
                        }
                    },
                    "required":[
                        "table"
                    ],
                    "additionalProperties":false
                }
            ]
        },
        "registration":{
            "description":"Registration with the target database",
            "enum":[
                "none",
                "standard"
            ],
            "default":"none"
        },
        "source":{
            "description":"Source of data to process",
            "x-oneOf":[
                {
                    "description":"Use tables (initial load)",
                    "enum":[
                        "tables"
                    ]
                },
                {
                    "type":"object",
                    "properties":{
                        "name":{
                            "description":"The name of the trail",
                            "type":"string",
                            "pattern":"^[A-Za-z][A-Za-z0-9]?$",
                            "minLength":1,
                            "maxLength":2
                        },
                        "path":{
                            "description":"The path where the trail data is stored",
                            "type":"string",
                            "minLength":1,
                            "maxLength":255
                        }
                    },
                    "required":[
                        "name"
                    ],
                    "additionalProperties":false
                },
                {
                    "type":"object",
                    "properties":{
                        "$schema":{
                            "enum":[
                                "ogg:file"
                            ]
                        },
                        "filename":{
                            "description":"The name of the file",
                            "type":"string",
                            "minLength":1,
                            "maxLength":255
                        },
                        "remote":{
                            "description":"Indicates if file is local or remote",
                            "type":"boolean",
                            "default":false
                        }
                    },
                    "required":[
                        "filename"
                    ],
                    "additionalProperties":false
                }
            ]
        },
        "credentials":{
            "description":"Credentials for target database",
            "default":null,
            "x-oneOf":[
                {
                    "type":"object",
                    "properties":{
                        "$schema":{
                            "enum":[
                                "ogg:credentialsRef"
                            ]
                        },
                        "domain":{
                            "type":"string",
                            "pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
                            "minLength":1,
                            "maxLength":30,
                            "default":"OracleGoldenGate"
                        },
                        "alias":{
                            "type":"string",
                            "pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
                            "minLength":1,
                            "maxLength":30
                        }
                    },
                    "required":[
                        "alias"
                    ],
                    "additionalProperties":false
                },
                {
                    "type":"null"
                }
            ]
        },
        "description":{
            "description":"Description for the process",
            "type":"string",
            "minLength":1,
            "maxLength":4095
        }
    },
    "additionalProperties":false
}

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

データ処理の開始位置

デフォルト値: now

1つに一致

ソースの表示

• 指定できる値: [ "now" ]
• 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])$
• object begin-x-oneOf[2]

{
    "description":"Starting point for data processing",
    "default":"now",
    "x-oneOf":[
        {
            "enum":[
                "now"
            ]
        },
        {
            "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":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "type:position/atTrailRBA"
                    ]
                },
                "sequence":{
                    "description":"Trail file sequence number",
                    "type":"integer",
                    "minimum":0,
                    "maximum":999999999,
                    "default":0
                },
                "offset":{
                    "description":"Offset in trail sequence file",
                    "type":"integer",
                    "minimum":0,
                    "default":0,
                    "maximum":2147483647
                }
            },
            "required":[
                "sequence"
            ],
            "additionalProperties":false
        }
    ]
}

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

チェックポイント・データの場所

1つに一致

ソースの表示

• 指定できる値: [ "files" ]

  ローカル・ファイルシステムを使用してチェックポイント・データを格納します
• object checkpoint-x-oneOf[1]
  指定した表を使用してチェックポイント情報を格納します

{
    "description":"Location for checkpoint data",
    "x-oneOf":[
        {
            "description":"Use the local filesystem to store checkpoint data",
            "enum":[
                "files"
            ]
        },
        {
            "description":"Use the specified table to store checkpoint information",
            "type":"object",
            "properties":{
                "table":{
                    "x-anyOf":[
                        {
                            "type":"string",
                            "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                            "minLength":3,
                            "maxLength":261
                        },
                        {
                            "type":"string",
                            "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                            "minLength":5,
                            "maxLength":392
                        }
                    ]
                }
            },
            "required":[
                "table"
            ],
            "additionalProperties":false
        }
    ]
}

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

型: array

最小アイテム数: 0

最大アイテム数: 32767

ソースの表示

• 配列: string
  最小長: 0

  最大長: 4095

{
    "type":"array",
    "items":{
        "type":"string",
        "minLength":0,
        "maxLength":4095
    },
    "minItems":0,
    "maxItems":32767
}

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

ターゲット・データベースの資格証明

デフォルト値: oracle.doceng.json.BetterJsonNull@51869ad6

1つに一致

ソースの表示

• object credentials-x-oneOf[0]
• null

{
    "description":"Credentials for target database",
    "default":null,
    "x-oneOf":[
        {
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "ogg:credentialsRef"
                    ]
                },
                "domain":{
                    "type":"string",
                    "pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
                    "minLength":1,
                    "maxLength":30,
                    "default":"OracleGoldenGate"
                },
                "alias":{
                    "type":"string",
                    "pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
                    "minLength":1,
                    "maxLength":30
                }
            },
            "required":[
                "alias"
            ],
            "additionalProperties":false
        },
        {
            "type":"null"
        }
    ]
}

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

レプリケーションのモード

1つに一致

ソースの表示

• object mode-x-oneOf[0]
  標準の非統合Replicatを作成します
• object mode-x-oneOf[1]
  (Oracleのみ)標準の統合Replicatを作成します
• object mode-x-oneOf[2]
  (Oracleのみ)調整Replicat

{
    "description":"Mode of replication",
    "x-oneOf":[
        {
            "description":"Creates a standard, non-integrated Replicat",
            "type":"object",
            "properties":{
                "type":{
                    "enum":[
                        "nonintegrated"
                    ]
                },
                "parallel":{
                    "description":"Apply multiple operations in parallel",
                    "type":"boolean",
                    "default":false
                }
            },
            "required":[
                "type"
            ],
            "additionalProperties":false
        },
        {
            "description":"(Oracle Only) Creates a standard, integrated Replicat",
            "type":"object",
            "properties":{
                "type":{
                    "enum":[
                        "integrated"
                    ]
                },
                "parallel":{
                    "description":"Apply multiple operations in parallel",
                    "type":"boolean",
                    "default":false
                }
            },
            "required":[
                "type"
            ],
            "additionalProperties":false
        },
        {
            "description":"(Oracle Only) Coordinated Replicat",
            "type":"object",
            "properties":{
                "type":{
                    "enum":[
                        "coordinated"
                    ]
                },
                "maxThreads":{
                    "type":"integer",
                    "minimum":1,
                    "maximum":500,
                    "default":25
                },
                "threadNumber":{
                    "type":"integer",
                    "minimum":1,
                    "maximum":500
                }
            },
            "required":[
                "type"
            ],
            "additionalProperties":false
        }
    ]
}

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

処理するデータのソース

1つに一致

ソースの表示

• 指定できる値: [ "tables" ]

  表を使用(初期ロード)
• object source-x-oneOf[1]
• object source-x-oneOf[2]

{
    "description":"Source of data to process",
    "x-oneOf":[
        {
            "description":"Use tables (initial load)",
            "enum":[
                "tables"
            ]
        },
        {
            "type":"object",
            "properties":{
                "name":{
                    "description":"The name of the trail",
                    "type":"string",
                    "pattern":"^[A-Za-z][A-Za-z0-9]?$",
                    "minLength":1,
                    "maxLength":2
                },
                "path":{
                    "description":"The path where the trail data is stored",
                    "type":"string",
                    "minLength":1,
                    "maxLength":255
                }
            },
            "required":[
                "name"
            ],
            "additionalProperties":false
        },
        {
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "ogg:file"
                    ]
                },
                "filename":{
                    "description":"The name of the file",
                    "type":"string",
                    "minLength":1,
                    "maxLength":255
                },
                "remote":{
                    "description":"Indicates if file is local or remote",
                    "type":"boolean",
                    "default":false
                }
            },
            "required":[
                "filename"
            ],
            "additionalProperties":false
        }
    ]
}

ネストされたスキーマ: begin-x-oneOf[2]

型: object

ソースの表示

• $schema(optional):
  指定できる値: [ "type:position/atTrailRBA" ]
• offset(optional): integer
  最小値: 0

  最大値: 2147483647

  デフォルト値: 0

  トレイル順序ファイルのオフセット
• sequence: integer
  最小値: 0

  最大値: 999999999

  デフォルト値: 0

  トレイル・ファイル順序番号

{
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "type:position/atTrailRBA"
            ]
        },
        "sequence":{
            "description":"Trail file sequence number",
            "type":"integer",
            "minimum":0,
            "maximum":999999999,
            "default":0
        },
        "offset":{
            "description":"Offset in trail sequence file",
            "type":"integer",
            "minimum":0,
            "default":0,
            "maximum":2147483647
        }
    },
    "required":[
        "sequence"
    ],
    "additionalProperties":false
}

ネストされたスキーマ: checkpoint-x-oneOf[1]

型: object

指定した表を使用してチェックポイント情報を格納します

ソースの表示

• table: table

{
    "description":"Use the specified table to store checkpoint information",
    "type":"object",
    "properties":{
        "table":{
            "x-anyOf":[
                {
                    "type":"string",
                    "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                    "minLength":3,
                    "maxLength":261
                },
                {
                    "type":"string",
                    "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
                    "minLength":5,
                    "maxLength":392
                }
            ]
        }
    },
    "required":[
        "table"
    ],
    "additionalProperties":false
}

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

いずれかに一致

ソースの表示

• string
  最小長: 3

  最大長: 261

  パターン: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$
• string
  最小長: 5

  最大長: 392

  パターン: ^([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])[.]([^.*?"]{1,128}|["].{1,128}["])$

{
    "x-anyOf":[
        {
            "type":"string",
            "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
            "minLength":3,
            "maxLength":261
        },
        {
            "type":"string",
            "pattern":"^([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])[.]([^.*?\"]{1,128}|[\"].{1,128}[\"])$",
            "minLength":5,
            "maxLength":392
        }
    ]
}

ネストされたスキーマ: credentials-x-oneOf[0]

型: object

ソースの表示

• $schema(optional):
  指定できる値: [ "ogg:credentialsRef" ]
• alias: string
  最小長: 1

  最大長: 30

  パターン: ^[a-zA-Z][a-zA-Z0-9_#$]*$
• domain(optional): string
  最小長: 1

  最大長: 30

  デフォルト値: OracleGoldenGate

  パターン: ^[a-zA-Z][a-zA-Z0-9_#$]*$

{
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:credentialsRef"
            ]
        },
        "domain":{
            "type":"string",
            "pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
            "minLength":1,
            "maxLength":30,
            "default":"OracleGoldenGate"
        },
        "alias":{
            "type":"string",
            "pattern":"^[a-zA-Z][a-zA-Z0-9_#$]*$",
            "minLength":1,
            "maxLength":30
        }
    },
    "required":[
        "alias"
    ],
    "additionalProperties":false
}

ネストされたスキーマ: mode-x-oneOf[0]

型: object

標準の非統合Replicatを作成します

ソースの表示

• parallel(optional): boolean
  デフォルト値: false

  複数の操作をパラレルで適用します
• type:
  指定できる値: [ "nonintegrated" ]

{
    "description":"Creates a standard, non-integrated Replicat",
    "type":"object",
    "properties":{
        "type":{
            "enum":[
                "nonintegrated"
            ]
        },
        "parallel":{
            "description":"Apply multiple operations in parallel",
            "type":"boolean",
            "default":false
        }
    },
    "required":[
        "type"
    ],
    "additionalProperties":false
}

ネストされたスキーマ: mode-x-oneOf[1]

型: object

(Oracleのみ)標準の統合Replicatを作成します

ソースの表示

• parallel(optional): boolean
  デフォルト値: false

  複数の操作をパラレルで適用します
• type:
  指定できる値: [ "integrated" ]

{
    "description":"(Oracle Only) Creates a standard, integrated Replicat",
    "type":"object",
    "properties":{
        "type":{
            "enum":[
                "integrated"
            ]
        },
        "parallel":{
            "description":"Apply multiple operations in parallel",
            "type":"boolean",
            "default":false
        }
    },
    "required":[
        "type"
    ],
    "additionalProperties":false
}

ネストされたスキーマ: mode-x-oneOf[2]

型: object

(Oracleのみ)調整Replicat

ソースの表示

• maxThreads(optional): integer
  最小値: 1

  最大値: 500

  デフォルト値: 25
• threadNumber(optional): integer
  最小値: 1

  最大値: 500
• type:
  指定できる値: [ "coordinated" ]

{
    "description":"(Oracle Only) Coordinated Replicat",
    "type":"object",
    "properties":{
        "type":{
            "enum":[
                "coordinated"
            ]
        },
        "maxThreads":{
            "type":"integer",
            "minimum":1,
            "maximum":500,
            "default":25
        },
        "threadNumber":{
            "type":"integer",
            "minimum":1,
            "maximum":500
        }
    },
    "required":[
        "type"
    ],
    "additionalProperties":false
}

ネストされたスキーマ: source-x-oneOf[1]

型: object

ソースの表示

• name: string
  最小長: 1

  最大長: 2

  パターン: ^[A-Za-z][A-Za-z0-9]?$

  トレイルの名前
• path(optional): string
  最小長: 1

  最大長: 255

  トレイル・データが格納されるパス

{
    "type":"object",
    "properties":{
        "name":{
            "description":"The name of the trail",
            "type":"string",
            "pattern":"^[A-Za-z][A-Za-z0-9]?$",
            "minLength":1,
            "maxLength":2
        },
        "path":{
            "description":"The path where the trail data is stored",
            "type":"string",
            "minLength":1,
            "maxLength":255
        }
    },
    "required":[
        "name"
    ],
    "additionalProperties":false
}

ネストされたスキーマ: source-x-oneOf[2]

型: object

ソースの表示

• $schema(optional):
  指定できる値: [ "ogg:file" ]
• filename: string
  最小長: 1

  最大長: 255

  ファイルの名前
• remote(optional): boolean
  デフォルト値: false

  ファイルがローカルかリモートかを示します

{
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:file"
            ]
        },
        "filename":{
            "description":"The name of the file",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "remote":{
            "description":"Indicates if file is local or remote",
            "type":"boolean",
            "default":false
        }
    },
    "required":[
        "filename"
    ],
    "additionalProperties":false
}

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

{
    "status":"running"
}

先頭に戻る

レスポンス

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

• application/json

200レスポンス

Replicatプロセスが正常に変更されました。

本文()

ルート・スキーマ: 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/replicats/REP2",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/replicats/REP2",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "messages":[
        {
            "$schema":"ogg:message",
            "code":"OGG-00975",
            "issued":"2017-12-14T12:43:59Z",
            "severity":"INFO",
            "title":"REPLICAT REP2 starting",
            "type":"http://docs.oracle.com/goldengate/c1230/gg-winux/GMESG/oggus.htm#OGG-00975"
        }
    ]
}

先頭に戻る