ジャンプ先

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

Replicatの取得

get

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

Replicatプロセスの詳細を取得します。

リクエスト

パス・パラメータ

• replicat: string
  最小長: 1

  最大長: 8

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

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

• version: string

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

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

先頭に戻る

レスポンス

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

• application/json

200レスポンス

Extractの詳細が正常に取得されました。

本文()

ルート・スキーマ: 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
  ターゲット・データベースの資格証明
• critical(optional): boolean
  デフォルト値: false

  Replicatがデプロイメントにとってクリティカルであることを示します
• description(optional): string
  最小長: 1

  最大長: 4095

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

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

  データ取得ワークフローの目的
• managedProcessSettings(optional): managedProcessSettings
  Administration ServerでERプロセスが管理される方法を制御します
• 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
                }
            ]
        },
        "encryptionProfile":{
            "x-oneOf":[
                {
                    "description":"Name of 'ogg:encryptionProfile' configuration value",
                    "type":"string",
                    "pattern":"^[A-Za-z0-9][A-Za-z0-9_:-]*$",
                    "minLength":1,
                    "maxLength":64
                },
                {
                    "type":"null"
                }
            ]
        },
        "$schema":{
            "enum":[
                "ogg:replicat"
            ]
        },
        "status":{
            "description":"Oracle GoldenGate Process Status",
            "default":"stopped",
            "enum":[
                "starting",
                "running",
                "stopped",
                "killed",
                "abended"
            ]
        },
        "critical":{
            "description":"Indicates the replicat is critical to the deployment",
            "type":"boolean",
            "default":false
        },
        "managedProcessSettings":{
            "description":"Control how the ER process is managed by the Administration Server",
            "x-oneOf":[
                {
                    "description":"Custom settings",
                    "type":"object",
                    "properties":{
                        "$schema":{
                            "enum":[
                                "ogg:managedProcessSettings"
                            ]
                        },
                        "autoStart":{
                            "description":"Description of how the ER process starts with Administration Server",
                            "type":"object",
                            "properties":{
                                "enabled":{
                                    "description":"If set, the process is started when Administration Server starts",
                                    "type":"boolean",
                                    "default":false
                                },
                                "delay":{
                                    "description":"Time to wait in seconds before starting process",
                                    "type":"integer",
                                    "minimum":0,
                                    "default":0,
                                    "maximum":3600
                                }
                            },
                            "required":[
                                "enabled"
                            ],
                            "additionalProperties":false
                        },
                        "autoRestart":{
                            "description":"Control how the ER process is restarted by the Administration Server if it terminates",
                            "default":{
                                "enabled":false,
                                "onSuccess":false,
                                "delay":0,
                                "retries":9,
                                "window":60,
                                "disableOnFailure":true
                            },
                            "type":"object",
                            "properties":{
                                "$schema":{
                                    "enum":[
                                        "ogg:taskRestart"
                                    ]
                                },
                                "enabled":{
                                    "description":"If set, the task can be restarted if it terminates.",
                                    "type":"boolean",
                                    "default":false
                                },
                                "onSuccess":{
                                    "description":"If false, the task is only restarted if it fails.",
                                    "type":"boolean",
                                    "default":false
                                },
                                "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":0,
                                    "maximum":3600
                                },
                                "retries":{
                                    "description":"The maximum number of times the task should be restarted before aborting retry efforts.",
                                    "type":"integer",
                                    "minimum":0,
                                    "default":9,
                                    "maximum":3600
                                },
                                "window":{
                                    "description":"The window of time, in seconds, during which retries are counted.",
                                    "type":"integer",
                                    "minimum":0,
                                    "default":60,
                                    "maximum":604800
                                },
                                "disableOnFailure":{
                                    "description":"If true, the task is disabled when it fails all execution attempts in an execution window.",
                                    "type":"boolean",
                                    "default":true
                                },
                                "failures":{
                                    "description":"The number of times the task failed in the current window.",
                                    "type":"integer",
                                    "minimum":0,
                                    "maximum":3600
                                }
                            },
                            "required":[
                                "enabled"
                            ],
                            "additionalProperties":false
                        }
                    },
                    "additionalProperties":false
                },
                {
                    "description":"Name of 'ogg:managedProcessSettings' configuration value",
                    "type":"string",
                    "pattern":"^[A-Za-z0-9][A-Za-z0-9_:-]*$",
                    "minLength":1,
                    "maxLength":64
                }
            ]
        },
        "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":2,
                            "maxLength":2
                        },
                        "path":{
                            "description":"The path where the trail data is stored",
                            "type":"string",
                            "minLength":1,
                            "maxLength":4096
                        }
                    },
                    "required":[
                        "name"
                    ],
                    "additionalProperties":false
                },
                {
                    "type":"object",
                    "properties":{
                        "$schema":{
                            "enum":[
                                "ogg:file"
                            ]
                        },
                        "filename":{
                            "description":"The name of the file",
                            "type":"string",
                            "minLength":1,
                            "maxLength":4096
                        },
                        "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@7139ff5a

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"
        }
    ]
}

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

1つに一致

ソースの表示

• string
  最小長: 1

  最大長: 64

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

  'ogg:encryptionProfile'構成値の名前
• null

{
    "x-oneOf":[
        {
            "description":"Name of 'ogg:encryptionProfile' configuration value",
            "type":"string",
            "pattern":"^[A-Za-z0-9][A-Za-z0-9_:-]*$",
            "minLength":1,
            "maxLength":64
        },
        {
            "type":"null"
        }
    ]
}

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

Administration ServerでERプロセスが管理される方法を制御します

1つに一致

ソースの表示

• object managedProcessSettings-x-oneOf[0]
  カスタム設定
• string
  最小長: 1

  最大長: 64

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

  'ogg:managedProcessSettings'構成値の名前

{
    "description":"Control how the ER process is managed by the Administration Server",
    "x-oneOf":[
        {
            "description":"Custom settings",
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "ogg:managedProcessSettings"
                    ]
                },
                "autoStart":{
                    "description":"Description of how the ER process starts with Administration Server",
                    "type":"object",
                    "properties":{
                        "enabled":{
                            "description":"If set, the process is started when Administration Server starts",
                            "type":"boolean",
                            "default":false
                        },
                        "delay":{
                            "description":"Time to wait in seconds before starting process",
                            "type":"integer",
                            "minimum":0,
                            "default":0,
                            "maximum":3600
                        }
                    },
                    "required":[
                        "enabled"
                    ],
                    "additionalProperties":false
                },
                "autoRestart":{
                    "description":"Control how the ER process is restarted by the Administration Server if it terminates",
                    "default":{
                        "enabled":false,
                        "onSuccess":false,
                        "delay":0,
                        "retries":9,
                        "window":60,
                        "disableOnFailure":true
                    },
                    "type":"object",
                    "properties":{
                        "$schema":{
                            "enum":[
                                "ogg:taskRestart"
                            ]
                        },
                        "enabled":{
                            "description":"If set, the task can be restarted if it terminates.",
                            "type":"boolean",
                            "default":false
                        },
                        "onSuccess":{
                            "description":"If false, the task is only restarted if it fails.",
                            "type":"boolean",
                            "default":false
                        },
                        "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":0,
                            "maximum":3600
                        },
                        "retries":{
                            "description":"The maximum number of times the task should be restarted before aborting retry efforts.",
                            "type":"integer",
                            "minimum":0,
                            "default":9,
                            "maximum":3600
                        },
                        "window":{
                            "description":"The window of time, in seconds, during which retries are counted.",
                            "type":"integer",
                            "minimum":0,
                            "default":60,
                            "maximum":604800
                        },
                        "disableOnFailure":{
                            "description":"If true, the task is disabled when it fails all execution attempts in an execution window.",
                            "type":"boolean",
                            "default":true
                        },
                        "failures":{
                            "description":"The number of times the task failed in the current window.",
                            "type":"integer",
                            "minimum":0,
                            "maximum":3600
                        }
                    },
                    "required":[
                        "enabled"
                    ],
                    "additionalProperties":false
                }
            },
            "additionalProperties":false
        },
        {
            "description":"Name of 'ogg:managedProcessSettings' configuration value",
            "type":"string",
            "pattern":"^[A-Za-z0-9][A-Za-z0-9_:-]*$",
            "minLength":1,
            "maxLength":64
        }
    ]
}

ネストされたスキーマ: 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":2,
                    "maxLength":2
                },
                "path":{
                    "description":"The path where the trail data is stored",
                    "type":"string",
                    "minLength":1,
                    "maxLength":4096
                }
            },
            "required":[
                "name"
            ],
            "additionalProperties":false
        },
        {
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "ogg:file"
                    ]
                },
                "filename":{
                    "description":"The name of the file",
                    "type":"string",
                    "minLength":1,
                    "maxLength":4096
                },
                "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
}

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

型: object

カスタム設定

ソースの表示

• $schema(optional):
  指定できる値: [ "ogg:managedProcessSettings" ]
• autoRestart(optional): object autoRestart
  ERプロセスが終了した場合に、Administration Serverによって再起動される方法を制御します
• autoStart(optional): object autoStart
  ERプロセスがAdministration Serverで起動される方法の説明

{
    "description":"Custom settings",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:managedProcessSettings"
            ]
        },
        "autoStart":{
            "description":"Description of how the ER process starts with Administration Server",
            "type":"object",
            "properties":{
                "enabled":{
                    "description":"If set, the process is started when Administration Server starts",
                    "type":"boolean",
                    "default":false
                },
                "delay":{
                    "description":"Time to wait in seconds before starting process",
                    "type":"integer",
                    "minimum":0,
                    "default":0,
                    "maximum":3600
                }
            },
            "required":[
                "enabled"
            ],
            "additionalProperties":false
        },
        "autoRestart":{
            "description":"Control how the ER process is restarted by the Administration Server if it terminates",
            "default":{
                "enabled":false,
                "onSuccess":false,
                "delay":0,
                "retries":9,
                "window":60,
                "disableOnFailure":true
            },
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "ogg:taskRestart"
                    ]
                },
                "enabled":{
                    "description":"If set, the task can be restarted if it terminates.",
                    "type":"boolean",
                    "default":false
                },
                "onSuccess":{
                    "description":"If false, the task is only restarted if it fails.",
                    "type":"boolean",
                    "default":false
                },
                "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":0,
                    "maximum":3600
                },
                "retries":{
                    "description":"The maximum number of times the task should be restarted before aborting retry efforts.",
                    "type":"integer",
                    "minimum":0,
                    "default":9,
                    "maximum":3600
                },
                "window":{
                    "description":"The window of time, in seconds, during which retries are counted.",
                    "type":"integer",
                    "minimum":0,
                    "default":60,
                    "maximum":604800
                },
                "disableOnFailure":{
                    "description":"If true, the task is disabled when it fails all execution attempts in an execution window.",
                    "type":"boolean",
                    "default":true
                },
                "failures":{
                    "description":"The number of times the task failed in the current window.",
                    "type":"integer",
                    "minimum":0,
                    "maximum":3600
                }
            },
            "required":[
                "enabled"
            ],
            "additionalProperties":false
        }
    },
    "additionalProperties":false
}

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

型: object

ERプロセスが終了した場合に、Administration Serverによって再起動される方法を制御します

デフォルト値: { "enabled":false, "onSuccess":false, "delay":0, "retries":9, "window":60, "disableOnFailure":true }

ソースの表示

• $schema(optional):
  指定できる値: [ "ogg:taskRestart" ]
• delay(optional): integer
  最小値: 0

  最大値: 3600

  デフォルト値: 0

  異常終了したプロセスの検出からプロセスの再起動までの待機時間(秒)。
• disableOnFailure(optional): boolean
  デフォルト値: true

  trueの場合、実行ウィンドウで実行試行がすべて失敗するとタスクが無効になります。
• enabled: boolean
  デフォルト値: false

  設定されると、タスクが終了した場合に再起動できます。
• failures(optional): integer
  最小値: 0

  最大値: 3600

  現在のウィンドウでタスクが失敗した回数。
• onSuccess(optional): boolean
  デフォルト値: false

  falseの場合、タスクが失敗した場合のみ再起動されます。
• retries(optional): integer
  最小値: 0

  最大値: 3600

  デフォルト値: 9

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

  最大値: 604800

  デフォルト値: 60

  再試行回数をカウントする時間枠(秒)。

{
    "description":"Control how the ER process is restarted by the Administration Server if it terminates",
    "default":{
        "enabled":false,
        "onSuccess":false,
        "delay":0,
        "retries":9,
        "window":60,
        "disableOnFailure":true
    },
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:taskRestart"
            ]
        },
        "enabled":{
            "description":"If set, the task can be restarted if it terminates.",
            "type":"boolean",
            "default":false
        },
        "onSuccess":{
            "description":"If false, the task is only restarted if it fails.",
            "type":"boolean",
            "default":false
        },
        "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":0,
            "maximum":3600
        },
        "retries":{
            "description":"The maximum number of times the task should be restarted before aborting retry efforts.",
            "type":"integer",
            "minimum":0,
            "default":9,
            "maximum":3600
        },
        "window":{
            "description":"The window of time, in seconds, during which retries are counted.",
            "type":"integer",
            "minimum":0,
            "default":60,
            "maximum":604800
        },
        "disableOnFailure":{
            "description":"If true, the task is disabled when it fails all execution attempts in an execution window.",
            "type":"boolean",
            "default":true
        },
        "failures":{
            "description":"The number of times the task failed in the current window.",
            "type":"integer",
            "minimum":0,
            "maximum":3600
        }
    },
    "required":[
        "enabled"
    ],
    "additionalProperties":false
}

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

型: object

ERプロセスがAdministration Serverで起動される方法の説明

ソースの表示

• delay(optional): integer
  最小値: 0

  最大値: 3600

  デフォルト値: 0

  プロセスを起動するまでに待機する時間(秒)
• enabled: boolean
  デフォルト値: false

  設定した場合、プロセスはAdministration Serverが起動されると起動されます

{
    "description":"Description of how the ER process starts with Administration Server",
    "type":"object",
    "properties":{
        "enabled":{
            "description":"If set, the process is started when Administration Server starts",
            "type":"boolean",
            "default":false
        },
        "delay":{
            "description":"Time to wait in seconds before starting process",
            "type":"integer",
            "minimum":0,
            "default":0,
            "maximum":3600
        }
    },
    "required":[
        "enabled"
    ],
    "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
  最小長: 2

  最大長: 2

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

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

  最大長: 4096

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

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

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

型: object

ソースの表示

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

  最大長: 4096

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

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

{
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:file"
            ]
        },
        "filename":{
            "description":"The name of the file",
            "type":"string",
            "minLength":1,
            "maxLength":4096
        },
        "remote":{
            "description":"Indicates if file is local or remote",
            "type":"boolean",
            "default":false
        }
    },
    "required":[
        "filename"
    ],
    "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"
        },
        {
            "href":"http://localhost:11001/services/v2/metadata-catalog/replicat",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "config":[
            "Replicat    REP2",
            "UseridAlias oggadmin",
            "Map         oggadmin.*,",
            "  Target    oggadmin.*;"
        ],
        "mode":{
            "parallel":false,
            "type":"nonintegrated"
        },
        "encryptionProfile":"LocalWallet",
        "$schema":"ogg:replicat",
        "status":"running",
        "checkpoint":{
            "table":"oggadmin.checkpoints"
        },
        "registration":"none",
        "source":{
            "name":"X2"
        },
        "credentials":{
            "alias":"oggadmin"
        }
    }
}

先頭に戻る