ジャンプ先

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

コマンドの実行

post

/services/{version}/commands/execute

必要なロール: ユーザー

コマンドを実行します。

リクエスト

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

• application/json

パス・パラメータ

• version(必須): string

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

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

本文()

ルート・スキーマ: Oracle GoldenGate Distribution Path Command

タイトル: Oracle GoldenGate Distribution Path Command

1つに一致

ソースの表示

• object Oracle GoldenGate Distribution Path Command-x-oneOf[0]
  分散パス・ラグのレポート

{
    "x-oneOf":[
        {
            "description":"Report on Distribution Path Lag",
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "ogg:distPathCommand"
                    ]
                },
                "name":{
                    "enum":[
                        "report"
                    ]
                },
                "reportType":{
                    "enum":[
                        "lag"
                    ]
                },
                "thresholds":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "type":{
                                "enum":[
                                    "info",
                                    "critical"
                                ]
                            },
                            "units":{
                                "x-oneOf":[
                                    {
                                        "enum":[
                                            "seconds"
                                        ]
                                    },
                                    {
                                        "enum":[
                                            "minutes"
                                        ]
                                    },
                                    {
                                        "enum":[
                                            "hours"
                                        ]
                                    }
                                ]
                            },
                            "value":{
                                "type":"integer",
                                "minimum":"0",
                                "maximum":"65535"
                            }
                        },
                        "required":[
                            "type",
                            "units",
                            "value"
                        ],
                        "additionalProperties":false
                    },
                    "minItems":"1",
                    "maxItems":"2"
                }
            },
            "required":[
                "name",
                "reportType",
                "thresholds"
            ],
            "additionalProperties":false
        }
    ],
    "title":"Oracle GoldenGate Distribution Path Command"
}

ネストされたスキーマ: Oracle GoldenGate Distribution Path Command-x-oneOf[0]

型: object

分散パス・ラグのレポート

ソースの表示

• $schema:
  指定できる値: [ "ogg:distPathCommand" ]
• name(必須):
  指定できる値: [ "report" ]
• reportType(必須):
  指定できる値: [ "lag" ]
• thresholds(必須): array thresholds
  最小アイテム数: 1

  最大アイテム数: 2

{
    "description":"Report on Distribution Path Lag",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:distPathCommand"
            ]
        },
        "name":{
            "enum":[
                "report"
            ]
        },
        "reportType":{
            "enum":[
                "lag"
            ]
        },
        "thresholds":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "type":{
                        "enum":[
                            "info",
                            "critical"
                        ]
                    },
                    "units":{
                        "x-oneOf":[
                            {
                                "enum":[
                                    "seconds"
                                ]
                            },
                            {
                                "enum":[
                                    "minutes"
                                ]
                            },
                            {
                                "enum":[
                                    "hours"
                                ]
                            }
                        ]
                    },
                    "value":{
                        "type":"integer",
                        "minimum":"0",
                        "maximum":"65535"
                    }
                },
                "required":[
                    "type",
                    "units",
                    "value"
                ],
                "additionalProperties":false
            },
            "minItems":"1",
            "maxItems":"2"
        }
    },
    "required":[
        "name",
        "reportType",
        "thresholds"
    ],
    "additionalProperties":false
}

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

型: array

最小アイテム数: 1

最大アイテム数: 2

ソースの表示

• 配列: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "type":{
                "enum":[
                    "info",
                    "critical"
                ]
            },
            "units":{
                "x-oneOf":[
                    {
                        "enum":[
                            "seconds"
                        ]
                    },
                    {
                        "enum":[
                            "minutes"
                        ]
                    },
                    {
                        "enum":[
                            "hours"
                        ]
                    }
                ]
            },
            "value":{
                "type":"integer",
                "minimum":"0",
                "maximum":"65535"
            }
        },
        "required":[
            "type",
            "units",
            "value"
        ],
        "additionalProperties":false
    },
    "minItems":"1",
    "maxItems":"2"
}

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

型: object

ソースの表示

• type(必須):
  指定できる値: [ "info", "critical" ]
• units(必須): units
• value(必須): integer
  最小値: 0

  最大値: 65535

{
    "type":"object",
    "properties":{
        "type":{
            "enum":[
                "info",
                "critical"
            ]
        },
        "units":{
            "x-oneOf":[
                {
                    "enum":[
                        "seconds"
                    ]
                },
                {
                    "enum":[
                        "minutes"
                    ]
                },
                {
                    "enum":[
                        "hours"
                    ]
                }
            ]
        },
        "value":{
            "type":"integer",
            "minimum":"0",
            "maximum":"65535"
        }
    },
    "required":[
        "type",
        "units",
        "value"
    ],
    "additionalProperties":false
}

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

1つに一致

ソースの表示

• 指定できる値: [ "seconds" ]
• 指定できる値: [ "minutes" ]
• 指定できる値: [ "hours" ]

{
    "x-oneOf":[
        {
            "enum":[
                "seconds"
            ]
        },
        {
            "enum":[
                "minutes"
            ]
        },
        {
            "enum":[
                "hours"
            ]
        }
    ]
}

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

{
    "name":"report",
    "reportType":"lag",
    "thresholds":[
        {
            "type":"info",
            "units":"seconds",
            "value":"0"
        },
        {
            "type":"critical",
            "units":"seconds",
            "value":"5"
        }
    ]
}

先頭に戻る

レスポンス

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

• application/json

200レスポンス

コマンドが正常に実行されました。

本文()

ルート・スキーマ: Oracle GoldenGate Distribution Path Command Result

型: object

タイトル: Oracle GoldenGate Distribution Path Command Result

ソースの表示

• $schema:
  指定できる値: [ "ogg:distPathCommandResult" ]
• items: array items
  最小アイテム数: 0

  最大アイテム数: 1024

{
    "title":"Oracle GoldenGate Distribution Path Command Result",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:distPathCommandResult"
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "x-oneOf":[
                    {
                        "type":"object",
                        "properties":{
                            "name":{
                                "description":"Distribution path name",
                                "type":"string",
                                "pattern":"^[A-Za-z][A-Za-z0-9-_.]*$",
                                "minLength":"1",
                                "maxLength":"32"
                            },
                            "targetInitiated":{
                                "description":"Indicates if the Distribution path is target-initiated",
                                "type":"boolean"
                            },
                            "severity":{
                                "enum":[
                                    "info",
                                    "critical"
                                ]
                            },
                            "result":{
                                "x-oneOf":[
                                    {
                                        "description":"Report on Distribution path Lag",
                                        "type":"object",
                                        "properties":{
                                            "lag":{
                                                "description":"Distribution path lag in H:MM:SS.mmm format",
                                                "type":"string",
                                                "minLength":"11",
                                                "maxLength":"13"
                                            },
                                            "lagSeconds":{
                                                "description":"Distribution path lag in seconds",
                                                "type":"number"
                                            },
                                            "lastCheckpoint":{
                                                "description":"Time since last checkpoint in H:MM:SS.mmm format",
                                                "type":"string",
                                                "minLength":"11",
                                                "maxLength":"13"
                                            },
                                            "lastCheckpointSeconds":{
                                                "description":"Time since last checkpoint in seconds",
                                                "type":"number"
                                            }
                                        },
                                        "required":[
                                            "lag",
                                            "lagSeconds",
                                            "lastCheckpoint",
                                            "lastCheckpointSeconds"
                                        ],
                                        "additionalProperties":false
                                    }
                                ]
                            }
                        },
                        "required":[
                            "name",
                            "targetInitiated",
                            "severity"
                        ],
                        "additionalProperties":false
                    }
                ]
            },
            "minItems":"0",
            "maxItems":"1024"
        }
    },
    "additionalProperties":false
}

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

型: array

最小アイテム数: 0

最大アイテム数: 1024

ソースの表示

• 配列: items

{
    "type":"array",
    "items":{
        "x-oneOf":[
            {
                "type":"object",
                "properties":{
                    "name":{
                        "description":"Distribution path name",
                        "type":"string",
                        "pattern":"^[A-Za-z][A-Za-z0-9-_.]*$",
                        "minLength":"1",
                        "maxLength":"32"
                    },
                    "targetInitiated":{
                        "description":"Indicates if the Distribution path is target-initiated",
                        "type":"boolean"
                    },
                    "severity":{
                        "enum":[
                            "info",
                            "critical"
                        ]
                    },
                    "result":{
                        "x-oneOf":[
                            {
                                "description":"Report on Distribution path Lag",
                                "type":"object",
                                "properties":{
                                    "lag":{
                                        "description":"Distribution path lag in H:MM:SS.mmm format",
                                        "type":"string",
                                        "minLength":"11",
                                        "maxLength":"13"
                                    },
                                    "lagSeconds":{
                                        "description":"Distribution path lag in seconds",
                                        "type":"number"
                                    },
                                    "lastCheckpoint":{
                                        "description":"Time since last checkpoint in H:MM:SS.mmm format",
                                        "type":"string",
                                        "minLength":"11",
                                        "maxLength":"13"
                                    },
                                    "lastCheckpointSeconds":{
                                        "description":"Time since last checkpoint in seconds",
                                        "type":"number"
                                    }
                                },
                                "required":[
                                    "lag",
                                    "lagSeconds",
                                    "lastCheckpoint",
                                    "lastCheckpointSeconds"
                                ],
                                "additionalProperties":false
                            }
                        ]
                    }
                },
                "required":[
                    "name",
                    "targetInitiated",
                    "severity"
                ],
                "additionalProperties":false
            }
        ]
    },
    "minItems":"0",
    "maxItems":"1024"
}

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

1つに一致

ソースの表示

• object items-x-oneOf[0]

{
    "x-oneOf":[
        {
            "type":"object",
            "properties":{
                "name":{
                    "description":"Distribution path name",
                    "type":"string",
                    "pattern":"^[A-Za-z][A-Za-z0-9-_.]*$",
                    "minLength":"1",
                    "maxLength":"32"
                },
                "targetInitiated":{
                    "description":"Indicates if the Distribution path is target-initiated",
                    "type":"boolean"
                },
                "severity":{
                    "enum":[
                        "info",
                        "critical"
                    ]
                },
                "result":{
                    "x-oneOf":[
                        {
                            "description":"Report on Distribution path Lag",
                            "type":"object",
                            "properties":{
                                "lag":{
                                    "description":"Distribution path lag in H:MM:SS.mmm format",
                                    "type":"string",
                                    "minLength":"11",
                                    "maxLength":"13"
                                },
                                "lagSeconds":{
                                    "description":"Distribution path lag in seconds",
                                    "type":"number"
                                },
                                "lastCheckpoint":{
                                    "description":"Time since last checkpoint in H:MM:SS.mmm format",
                                    "type":"string",
                                    "minLength":"11",
                                    "maxLength":"13"
                                },
                                "lastCheckpointSeconds":{
                                    "description":"Time since last checkpoint in seconds",
                                    "type":"number"
                                }
                            },
                            "required":[
                                "lag",
                                "lagSeconds",
                                "lastCheckpoint",
                                "lastCheckpointSeconds"
                            ],
                            "additionalProperties":false
                        }
                    ]
                }
            },
            "required":[
                "name",
                "targetInitiated",
                "severity"
            ],
            "additionalProperties":false
        }
    ]
}

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

型: object

ソースの表示

• name(必須): string
  最小長: 1

  最大長: 32

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

  分散パス名
• result: result
• severity(必須):
  指定できる値: [ "info", "critical" ]
• targetInitiated(必須): boolean
  分散パスがターゲット開始かどうかを示します

{
    "type":"object",
    "properties":{
        "name":{
            "description":"Distribution path name",
            "type":"string",
            "pattern":"^[A-Za-z][A-Za-z0-9-_.]*$",
            "minLength":"1",
            "maxLength":"32"
        },
        "targetInitiated":{
            "description":"Indicates if the Distribution path is target-initiated",
            "type":"boolean"
        },
        "severity":{
            "enum":[
                "info",
                "critical"
            ]
        },
        "result":{
            "x-oneOf":[
                {
                    "description":"Report on Distribution path Lag",
                    "type":"object",
                    "properties":{
                        "lag":{
                            "description":"Distribution path lag in H:MM:SS.mmm format",
                            "type":"string",
                            "minLength":"11",
                            "maxLength":"13"
                        },
                        "lagSeconds":{
                            "description":"Distribution path lag in seconds",
                            "type":"number"
                        },
                        "lastCheckpoint":{
                            "description":"Time since last checkpoint in H:MM:SS.mmm format",
                            "type":"string",
                            "minLength":"11",
                            "maxLength":"13"
                        },
                        "lastCheckpointSeconds":{
                            "description":"Time since last checkpoint in seconds",
                            "type":"number"
                        }
                    },
                    "required":[
                        "lag",
                        "lagSeconds",
                        "lastCheckpoint",
                        "lastCheckpointSeconds"
                    ],
                    "additionalProperties":false
                }
            ]
        }
    },
    "required":[
        "name",
        "targetInitiated",
        "severity"
    ],
    "additionalProperties":false
}

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

1つに一致

ソースの表示

• object result-x-oneOf[0]
  分散パス・ラグのレポート

{
    "x-oneOf":[
        {
            "description":"Report on Distribution path Lag",
            "type":"object",
            "properties":{
                "lag":{
                    "description":"Distribution path lag in H:MM:SS.mmm format",
                    "type":"string",
                    "minLength":"11",
                    "maxLength":"13"
                },
                "lagSeconds":{
                    "description":"Distribution path lag in seconds",
                    "type":"number"
                },
                "lastCheckpoint":{
                    "description":"Time since last checkpoint in H:MM:SS.mmm format",
                    "type":"string",
                    "minLength":"11",
                    "maxLength":"13"
                },
                "lastCheckpointSeconds":{
                    "description":"Time since last checkpoint in seconds",
                    "type":"number"
                }
            },
            "required":[
                "lag",
                "lagSeconds",
                "lastCheckpoint",
                "lastCheckpointSeconds"
            ],
            "additionalProperties":false
        }
    ]
}

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

型: object

分散パス・ラグのレポート

ソースの表示

• lag(必須): string
  最小長: 11

  最大長: 13

  H:MM:SS.mmm形式での分散パス・ラグ
• lagSeconds(必須): number
  分散パス・ラグの秒数
• lastCheckpoint(必須): string
  最小長: 11

  最大長: 13

  最後のチェックポイントからの時間(H:MM:SS.mmm形式)
• lastCheckpointSeconds(必須): number
  最後のチェックポイントからの時間(秒)

{
    "description":"Report on Distribution path Lag",
    "type":"object",
    "properties":{
        "lag":{
            "description":"Distribution path lag in H:MM:SS.mmm format",
            "type":"string",
            "minLength":"11",
            "maxLength":"13"
        },
        "lagSeconds":{
            "description":"Distribution path lag in seconds",
            "type":"number"
        },
        "lastCheckpoint":{
            "description":"Time since last checkpoint in H:MM:SS.mmm format",
            "type":"string",
            "minLength":"11",
            "maxLength":"13"
        },
        "lastCheckpointSeconds":{
            "description":"Time since last checkpoint in seconds",
            "type":"number"
        }
    },
    "required":[
        "lag",
        "lagSeconds",
        "lastCheckpoint",
        "lastCheckpointSeconds"
    ],
    "additionalProperties":false
}

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

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:9013/services/v2/commands/execute",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9013/services/v2/commands/execute",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:distPathCommandResult",
        "items":[
            {
                "name":"PTH1",
                "targetInitiated":false,
                "result":{
                    "lag":"0:00:00.000",
                    "lagSeconds":"0",
                    "lastCheckpoint":"0:00:01.482",
                    "lastCheckpointSeconds":"1.482"
                },
                "severity":"info"
            },
            {
                "name":"path6",
                "targetInitiated":true,
                "result":{
                    "lag":"0:00:00.000",
                    "lagSeconds":"0",
                    "lastCheckpoint":"0:00:05.380",
                    "lastCheckpointSeconds":"5.38"
                },
                "severity":"critical"
            }
        ]
    }
}

先頭に戻る