Oracle GoldenGate Microservices REST API

情報タイプのリスト表示

get

/services/{version}/extracts/{extract}/info

必要なロール: ユーザー

Extractで使用可能な情報のタイプを取得します。

リクエスト

パス・パラメータ

extract(必須): string

最小長: 1

最大長: 8

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

Extractの名前。Extract名は大文字で、先頭が英字、その後に英数字が最大で7文字続きます。
version(必須): string

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

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

情報タイプのコレクションが正常に取得されました。

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

型: object

タイトル: Oracle GoldenGate Collection

ソースの表示

$schema:

指定できる値: [ "ogg:collection" ]
items(必須): array items

最小アイテム数: 0

最大アイテム数: 32767

{
    "title":"Oracle GoldenGate Collection",
    "required":[
        "items"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:collection"
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "$schema":{
                        "description":"Name of schema for collection item, defaults to this schema",
                        "type":"string",
                        "minLength":"1",
                        "maxLength":"255",
                        "default":"ogg:collectionItem"
                    },
                    "name":{
                        "description":"Item name",
                        "type":"string",
                        "minLength":"1",
                        "maxLength":"255"
                    },
                    "status":{
                        "description":"Item status",
                        "x-anyOf":[
                            {
                                "enum":[
                                    "starting",
                                    "running",
                                    "stopped",
                                    "killed",
                                    "abended"
                                ]
                            },
                            {
                                "enum":[
                                    "paused",
                                    "running",
                                    "stopping",
                                    "stopped",
                                    "killed",
                                    "uninitialized"
                                ],
                                "default":"stopped"
                            }
                        ]
                    },
                    "links":{
                        "description":"Links for item",
                        "minItems":"0",
                        "maxItems":"16",
                        "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",
                                        "ogg://service"
                                    ]
                                },
                                "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
                        }
                    }
                },
                "required":[
                    "name",
                    "links"
                ],
                "additionalProperties":true
            },
            "minItems":"0",
            "maxItems":"32767"
        }
    },
    "additionalProperties":false
}

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

型: array

最小アイテム数: 0

最大アイテム数: 32767

ソースの表示

配列: object items

使用可能な追加プロパティ: true

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "$schema":{
                "description":"Name of schema for collection item, defaults to this schema",
                "type":"string",
                "minLength":"1",
                "maxLength":"255",
                "default":"ogg:collectionItem"
            },
            "name":{
                "description":"Item name",
                "type":"string",
                "minLength":"1",
                "maxLength":"255"
            },
            "status":{
                "description":"Item status",
                "x-anyOf":[
                    {
                        "enum":[
                            "starting",
                            "running",
                            "stopped",
                            "killed",
                            "abended"
                        ]
                    },
                    {
                        "enum":[
                            "paused",
                            "running",
                            "stopping",
                            "stopped",
                            "killed",
                            "uninitialized"
                        ],
                        "default":"stopped"
                    }
                ]
            },
            "links":{
                "description":"Links for item",
                "minItems":"0",
                "maxItems":"16",
                "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",
                                "ogg://service"
                            ]
                        },
                        "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
                }
            }
        },
        "required":[
            "name",
            "links"
        ],
        "additionalProperties":true
    },
    "minItems":"0",
    "maxItems":"32767"
}

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

型: object

使用可能な追加プロパティ: true

ソースの表示

$schema: string

最小長: 1

最大長: 255

デフォルト値: ogg:collectionItem

コレクション・アイテムのスキーマ名。デフォルトはこのスキーマです
links(必須): array links

最小アイテム数: 0

最大アイテム数: 16

アイテムのリンク
name(必須): string

最小長: 1

最大長: 255

アイテム名
status: status

アイテムのステータス

{
    "type":"object",
    "properties":{
        "$schema":{
            "description":"Name of schema for collection item, defaults to this schema",
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "default":"ogg:collectionItem"
        },
        "name":{
            "description":"Item name",
            "type":"string",
            "minLength":"1",
            "maxLength":"255"
        },
        "status":{
            "description":"Item status",
            "x-anyOf":[
                {
                    "enum":[
                        "starting",
                        "running",
                        "stopped",
                        "killed",
                        "abended"
                    ]
                },
                {
                    "enum":[
                        "paused",
                        "running",
                        "stopping",
                        "stopped",
                        "killed",
                        "uninitialized"
                    ],
                    "default":"stopped"
                }
            ]
        },
        "links":{
            "description":"Links for item",
            "minItems":"0",
            "maxItems":"16",
            "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",
                            "ogg://service"
                        ]
                    },
                    "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
            }
        }
    },
    "required":[
        "name",
        "links"
    ],
    "additionalProperties":true
}

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

型: array

最小アイテム数: 0

最大アイテム数: 16

アイテムのリンク

ソースの表示

配列: object items

{
    "description":"Links for item",
    "minItems":"0",
    "maxItems":"16",
    "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",
                    "ogg://service"
                ]
            },
            "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
    }
}

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

アイテムのステータス

いずれかに一致

ソースの表示

指定できる値: [ "starting", "running", "stopped", "killed", "abended" ]
デフォルト値: stopped

指定できる値: [ "paused", "running", "stopping", "stopped", "killed", "uninitialized" ]

{
    "description":"Item status",
    "x-anyOf":[
        {
            "enum":[
                "starting",
                "running",
                "stopped",
                "killed",
                "abended"
            ]
        },
        {
            "enum":[
                "paused",
                "running",
                "stopping",
                "stopped",
                "killed",
                "uninitialized"
            ],
            "default":"stopped"
        }
    ]
}

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

型: object

ソースの表示

$schema:

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

最小長: 1

最大長: 4095

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

最小長: 2

最大長: 4095

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

リンクの絶対URI
mediaType: 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", "ogg://service" ]

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",
                "ogg://service"
            ]
        },
        "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
}

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

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:11001/services/v2/extracts/EXT2/info",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:11001/services/v2/extracts/EXT2/info",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:collection",
        "items":[
            {
                "$schema":"ogg:collectionItem",
                "links":[
                    {
                        "href":"http://localhost:11001/services/v2/extracts/EXT2/info",
                        "mediaType":"application/json",
                        "rel":"parent"
                    },
                    {
                        "href":"http://localhost:11001/services/v2/extracts/EXT2/info/history",
                        "mediaType":"application/json",
                        "rel":"canonical"
                    }
                ],
                "name":"history"
            },
            {
                "$schema":"ogg:collectionItem",
                "links":[
                    {
                        "href":"http://localhost:11001/services/v2/extracts/EXT2/info",
                        "mediaType":"application/json",
                        "rel":"parent"
                    },
                    {
                        "href":"http://localhost:11001/services/v2/extracts/EXT2/info/status",
                        "mediaType":"application/json",
                        "rel":"canonical"
                    }
                ],
                "name":"status"
            },
            {
                "$schema":"ogg:collectionItem",
                "links":[
                    {
                        "href":"http://localhost:11001/services/v2/extracts/EXT2/info",
                        "mediaType":"application/json",
                        "rel":"parent"
                    },
                    {
                        "href":"http://localhost:11001/services/v2/extracts/EXT2/info/reports",
                        "mediaType":"application/json",
                        "rel":"canonical"
                    }
                ],
                "name":"reports"
            },
            {
                "$schema":"ogg:collectionItem",
                "links":[
                    {
                        "href":"http://localhost:11001/services/v2/extracts/EXT2/info",
                        "mediaType":"application/json",
                        "rel":"parent"
                    },
                    {
                        "href":"http://localhost:11001/services/v2/extracts/EXT2/info/checkpoints",
                        "mediaType":"application/json",
                        "rel":"canonical"
                    }
                ],
                "name":"checkpoints"
            }
        ]
    }
}

先頭に戻る