Oracle GoldenGate 23ai Microservices Architecture REST APIドキュメンテーション

データベース表の詳細の取得

get

/services/{version}/connections/{connection}/databases/{database}/{schema}/{table}

必要なロール: ユーザー

スキーマ内の表の詳細を取得します。

リクエスト

パス・パラメータ

connection(必須): string

最小長: 1

最大長: 61

パターン: ^[a-zA-Z][a-zA-Z0-9_#$]{1,29}([.][a-zA-Z][a-zA-Z0-9_#$]{1,29})?$

接続名。資格証明ストアの別名ごとに、domain.aliasという名前の接続が存在しています。
database(必須): string

最小長: 1

最大長: 130

データベース名。
schema(必須): string

最小長: 1

最大長: 130

データベースのスキーマ名。
table(必須): string

最小長: 1

最大長: 130

データベースの表名。
version(必須): string

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

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

先頭に戻る

レスポンス

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

application/json

200レスポンス

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

ルート・スキーマ: Database Table Details

型: object

タイトル: Database Table Details

ソースの表示

$schema:

指定できる値: [ "ogg:tableDetails" ]
autoCapture: boolean

デフォルト値: false
created(必須): 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])$

日時表が作成されました
name(必須): name

修飾表名
type(必須):

指定できる値: [ "normal", "checkpoint", "heartbeat" ]

表のタイプ

{
    "title":"Database Table Details",
    "required":[
        "name",
        "type",
        "created"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:tableDetails"
            ]
        },
        "name":{
            "description":"Qualified table name",
            "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"
                }
            ]
        },
        "type":{
            "description":"Type of table",
            "enum":[
                "normal",
                "checkpoint",
                "heartbeat"
            ]
        },
        "created":{
            "description":"Date and time table was created",
            "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"
        },
        "autoCapture":{
            "type":"boolean",
            "default":false
        }
    },
    "additionalProperties":false
}

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

修飾表名

いずれかに一致

ソースの表示

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}["])$

{
    "description":"Qualified table name",
    "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"
        }
    ]
}

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

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/HR/EMPLOYEES",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9012/services/v2/connections/OracleGoldenGate.ggsouth/databases/DBNORTH_PDB1/HR/EMPLOYEES",
            "mediaType":"application/json",
            "rel":"self"
        },
        {
            "href":"http://localhost:9012/services/v2/metadata-catalog/table",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:tableDetails",
        "autoCapture":true,
        "created":"2024-04-03T22:32:46.000Z",
        "name":"HR.EMPLOYEES",
        "type":"normal"
    }
}

先頭に戻る