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

暗号化プロファイルの作成

post

/services/{version}/encryption/profiles/{profile}

必要なロール: 管理者

暗号化プロファイルを作成します。

リクエスト

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

application/json

パス・パラメータ

profile(必須): string

最小長: 1

最大長: 64

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

暗号化プロファイルの名前。
version(必須): string

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

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

ルート・スキーマ: Oracle GoldenGate Encryption Profile definition

タイトル: Oracle GoldenGate Encryption Profile definition

このスキーマは、OGGでのデータ暗号化の構成およびプロパティを示します

1つに一致

ソースの表示

object Oracle GoldenGate Encryption Profile definition-x-oneOf[0]
object Oracle GoldenGate Encryption Profile definition-x-oneOf[1]
object Oracle GoldenGate Encryption Profile definition-x-oneOf[2]
object Oracle GoldenGate Encryption Profile definition-x-oneOf[3]

プラグイン・サービスを使用した暗号化プロファイル

{
    "x-oneOf":[
        {
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "ogg:encryptionProfile"
                    ]
                },
                "type":{
                    "description":"OGG local wallet",
                    "enum":[
                        "localWallet"
                    ]
                },
                "isDefault":{
                    "description":"Is default profile.",
                    "type":"boolean",
                    "default":false
                },
                "description":{
                    "description":"Description of the Encryption profile.",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"256"
                }
            },
            "additionalProperties":false
        },
        {
            "type":"object",
            "properties":{
                "okvPath":{
                    "description":"Path where the Oracle Key Vault client software is installed.",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"4096"
                },
                "keyNameAttribute":{
                    "description":"Custom attribute used in Oracle Key Vault server to specify the masterkey name.",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"255",
                    "pattern":"^x[-][a-zA-Z0-9-]*$",
                    "default":"x-OGG-KeyName"
                },
                "okvVersion":{
                    "description":"Version of Oracle Key Vault",
                    "enum":[
                        "18.1",
                        "21.4"
                    ],
                    "default":"18.1"
                },
                "$schema":{
                    "enum":[
                        "ogg:encryptionProfile"
                    ]
                },
                "masterkey":{
                    "description":"Masterkey options.",
                    "type":"object",
                    "properties":{
                        "name":{
                            "type":"string",
                            "minLength":"1",
                            "maxLength":"255"
                        },
                        "version":{
                            "type":"string",
                            "minLength":"1",
                            "maxLength":"255",
                            "default":"LATEST"
                        },
                        "ttl":{
                            "type":"integer",
                            "minimum":"0",
                            "maximum":"4294967295",
                            "default":"86400"
                        }
                    },
                    "required":[
                        "name"
                    ],
                    "additionalProperties":false
                },
                "type":{
                    "description":"Oracle Key Vault",
                    "enum":[
                        "okv"
                    ]
                },
                "keyVersionAttribute":{
                    "description":"Custom attribute used in Oracle Key Vault server to specify the masterkey version.",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"255",
                    "pattern":"^x[-][a-zA-Z0-9-]*$",
                    "default":"x-OGG-KeyVersion"
                },
                "isDefault":{
                    "description":"Is default profile.",
                    "type":"boolean",
                    "default":false
                },
                "description":{
                    "description":"Description of the Encryption profile.",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"256"
                }
            },
            "additionalProperties":false
        },
        {
            "type":"object",
            "properties":{
                "apiSigningKey":{
                    "description":"OCI API Signing Key",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"10240"
                },
                "tenancyID":{
                    "description":"Tenancy OCID",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"255",
                    "pattern":"ocid1[.].*[.]oc[123]{1}[.].*[.].*"
                },
                "userID":{
                    "description":"User OCID",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"255",
                    "pattern":"ocid1[.].*[.]oc[123]{1}[.].*[.].*"
                },
                "$schema":{
                    "enum":[
                        "ogg:encryptionProfile"
                    ]
                },
                "cryptoEndpoint":{
                    "description":"Crypto endpoint of the OCI Key Management Service API.",
                    "type":"string",
                    "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
                    "minLength":"2",
                    "maxLength":"4095"
                },
                "keyFingerprint":{
                    "description":"Hash (MD5) of the signing key.",
                    "type":"string",
                    "minLength":"47",
                    "maxLength":"47"
                },
                "keyID":{
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"255",
                    "pattern":"ocid1[.].*[.]oc[123]{1}[.].*[.].*"
                },
                "type":{
                    "description":"OCI Key Management Service",
                    "enum":[
                        "ocikms"
                    ]
                },
                "isDefault":{
                    "description":"Is default profile.",
                    "type":"boolean",
                    "default":false
                },
                "apiVersion":{
                    "description":"Version of OCI KMS",
                    "enum":[
                        "20180608"
                    ],
                    "default":"20180608"
                },
                "description":{
                    "description":"Description of the Encryption profile.",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"256"
                }
            },
            "additionalProperties":false
        },
        {
            "description":"Encryption profile using the Plugin Service",
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "ogg:encryptionProfile"
                    ]
                },
                "type":{
                    "description":"OGG Plugin",
                    "enum":[
                        "plugin"
                    ]
                },
                "isDefault":{
                    "description":"Is default profile.",
                    "type":"boolean",
                    "default":false
                },
                "description":{
                    "description":"Description of the Encryption profile.",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"256"
                },
                "plugin":{
                    "description":"Oracle GoldenGate Plugin Name",
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"255",
                    "example":"libMinimal.so"
                },
                "metadata":{
                    "description":"Metadata for the plugin API",
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "name":{
                                "description":"Metadata name",
                                "type":"string",
                                "minLength":"1",
                                "maxLength":"64"
                            },
                            "value":{
                                "description":"Metadata value",
                                "type":"string",
                                "minLength":"1",
                                "maxLength":"4096"
                            }
                        },
                        "additionalProperties":false,
                        "required":[
                            "name",
                            "value"
                        ]
                    },
                    "minItems":"0",
                    "maxItems":"255"
                }
            },
            "additionalProperties":false
        }
    ],
    "title":"Oracle GoldenGate Encryption Profile definition",
    "description":"This schema describes the configuration and properties of data encryption in OGG"
}

ネストされたスキーマ: Oracle GoldenGate Encryption Profile definition-x-oneOf[0]

型: object

ソースの表示

$schema:

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

最小長: 1

最大長: 256

暗号化プロファイルの説明。
isDefault: boolean

デフォルト値: false

デフォルトのプロファイルです。
type:

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

OGGローカル・ウォレット

{
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:encryptionProfile"
            ]
        },
        "type":{
            "description":"OGG local wallet",
            "enum":[
                "localWallet"
            ]
        },
        "isDefault":{
            "description":"Is default profile.",
            "type":"boolean",
            "default":false
        },
        "description":{
            "description":"Description of the Encryption profile.",
            "type":"string",
            "minLength":"1",
            "maxLength":"256"
        }
    },
    "additionalProperties":false
}

ネストされたスキーマ: Oracle GoldenGate Encryption Profile definition-x-oneOf[1]

型: object

ソースの表示

$schema:

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

最小長: 1

最大長: 256

暗号化プロファイルの説明。
isDefault: boolean

デフォルト値: false

デフォルトのプロファイルです。
keyNameAttribute: string

最小長: 1

最大長: 255

デフォルト値: x-OGG-KeyName

パターン: ^x[-][a-zA-Z0-9-]*$

Oracle Key Vaultサーバーでマスター・キー名を指定するために使用するカスタム属性
keyVersionAttribute: string

最小長: 1

最大長: 255

デフォルト値: x-OGG-KeyVersion

パターン: ^x[-][a-zA-Z0-9-]*$

Oracle Key Vaultサーバーでマスター・キーのバージョンを指定するために使用するカスタム属性。
masterkey: object masterkey

マスターキーのオプション。
okvPath: string

最小長: 1

最大長: 4096

Oracle Key Vaultクライアント・ソフトウェアがインストールされるパス。
okvVersion:

デフォルト値: 18.1

指定できる値: [ "18.1", "21.4" ]

Oracle Key Vaultのバージョン
type:

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

Oracle Key Vault

{
    "type":"object",
    "properties":{
        "okvPath":{
            "description":"Path where the Oracle Key Vault client software is installed.",
            "type":"string",
            "minLength":"1",
            "maxLength":"4096"
        },
        "keyNameAttribute":{
            "description":"Custom attribute used in Oracle Key Vault server to specify the masterkey name.",
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "pattern":"^x[-][a-zA-Z0-9-]*$",
            "default":"x-OGG-KeyName"
        },
        "okvVersion":{
            "description":"Version of Oracle Key Vault",
            "enum":[
                "18.1",
                "21.4"
            ],
            "default":"18.1"
        },
        "$schema":{
            "enum":[
                "ogg:encryptionProfile"
            ]
        },
        "masterkey":{
            "description":"Masterkey options.",
            "type":"object",
            "properties":{
                "name":{
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"255"
                },
                "version":{
                    "type":"string",
                    "minLength":"1",
                    "maxLength":"255",
                    "default":"LATEST"
                },
                "ttl":{
                    "type":"integer",
                    "minimum":"0",
                    "maximum":"4294967295",
                    "default":"86400"
                }
            },
            "required":[
                "name"
            ],
            "additionalProperties":false
        },
        "type":{
            "description":"Oracle Key Vault",
            "enum":[
                "okv"
            ]
        },
        "keyVersionAttribute":{
            "description":"Custom attribute used in Oracle Key Vault server to specify the masterkey version.",
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "pattern":"^x[-][a-zA-Z0-9-]*$",
            "default":"x-OGG-KeyVersion"
        },
        "isDefault":{
            "description":"Is default profile.",
            "type":"boolean",
            "default":false
        },
        "description":{
            "description":"Description of the Encryption profile.",
            "type":"string",
            "minLength":"1",
            "maxLength":"256"
        }
    },
    "additionalProperties":false
}

ネストされたスキーマ: Oracle GoldenGate Encryption Profile definition-x-oneOf[2]

型: object

ソースの表示

$schema:

指定できる値: [ "ogg:encryptionProfile" ]
apiSigningKey: string

最小長: 1

最大長: 10240

OCI API署名キー
apiVersion:

デフォルト値: 20180608

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

OCI KMSのバージョン
cryptoEndpoint: string

最小長: 2

最大長: 4095

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

OCIキー管理サービスAPIの暗号化エンドポイント。
description: string

最小長: 1

最大長: 256

暗号化プロファイルの説明。
isDefault: boolean

デフォルト値: false

デフォルトのプロファイルです。
keyFingerprint: string

最小長: 47

最大長: 47

署名キーのハッシュ(MD5)。
keyID: string

最小長: 1

最大長: 255

パターン: ocid1[.].*[.]oc[123]{1}[.].*[.].*
tenancyID: string

最小長: 1

最大長: 255

パターン: ocid1[.].*[.]oc[123]{1}[.].*[.].*

テナンシOCID
type:

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

OCIキー管理サービス
userID: string

最小長: 1

最大長: 255

パターン: ocid1[.].*[.]oc[123]{1}[.].*[.].*

ユーザーOCID

{
    "type":"object",
    "properties":{
        "apiSigningKey":{
            "description":"OCI API Signing Key",
            "type":"string",
            "minLength":"1",
            "maxLength":"10240"
        },
        "tenancyID":{
            "description":"Tenancy OCID",
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "pattern":"ocid1[.].*[.]oc[123]{1}[.].*[.].*"
        },
        "userID":{
            "description":"User OCID",
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "pattern":"ocid1[.].*[.]oc[123]{1}[.].*[.].*"
        },
        "$schema":{
            "enum":[
                "ogg:encryptionProfile"
            ]
        },
        "cryptoEndpoint":{
            "description":"Crypto endpoint of the OCI Key Management Service API.",
            "type":"string",
            "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
            "minLength":"2",
            "maxLength":"4095"
        },
        "keyFingerprint":{
            "description":"Hash (MD5) of the signing key.",
            "type":"string",
            "minLength":"47",
            "maxLength":"47"
        },
        "keyID":{
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "pattern":"ocid1[.].*[.]oc[123]{1}[.].*[.].*"
        },
        "type":{
            "description":"OCI Key Management Service",
            "enum":[
                "ocikms"
            ]
        },
        "isDefault":{
            "description":"Is default profile.",
            "type":"boolean",
            "default":false
        },
        "apiVersion":{
            "description":"Version of OCI KMS",
            "enum":[
                "20180608"
            ],
            "default":"20180608"
        },
        "description":{
            "description":"Description of the Encryption profile.",
            "type":"string",
            "minLength":"1",
            "maxLength":"256"
        }
    },
    "additionalProperties":false
}

ネストされたスキーマ: Oracle GoldenGate Encryption Profile definition-x-oneOf[3]

型: object

プラグイン・サービスを使用した暗号化プロファイル

ソースの表示

$schema:

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

最小長: 1

最大長: 256

暗号化プロファイルの説明。
isDefault: boolean

デフォルト値: false

デフォルトのプロファイルです。
metadata: array metadata

最小アイテム数: 0

最大アイテム数: 255

プラグインAPIのメタデータ
plugin: string

最小長: 1

最大長: 255

Oracle GoldenGateプラグイン名

例: libMinimal.so
type:

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

OGGプラグイン

{
    "description":"Encryption profile using the Plugin Service",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:encryptionProfile"
            ]
        },
        "type":{
            "description":"OGG Plugin",
            "enum":[
                "plugin"
            ]
        },
        "isDefault":{
            "description":"Is default profile.",
            "type":"boolean",
            "default":false
        },
        "description":{
            "description":"Description of the Encryption profile.",
            "type":"string",
            "minLength":"1",
            "maxLength":"256"
        },
        "plugin":{
            "description":"Oracle GoldenGate Plugin Name",
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "example":"libMinimal.so"
        },
        "metadata":{
            "description":"Metadata for the plugin API",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "name":{
                        "description":"Metadata name",
                        "type":"string",
                        "minLength":"1",
                        "maxLength":"64"
                    },
                    "value":{
                        "description":"Metadata value",
                        "type":"string",
                        "minLength":"1",
                        "maxLength":"4096"
                    }
                },
                "additionalProperties":false,
                "required":[
                    "name",
                    "value"
                ]
            },
            "minItems":"0",
            "maxItems":"255"
        }
    },
    "additionalProperties":false
}

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

型: object

マスターキーのオプション。

ソースの表示

name(必須): string

最小長: 1

最大長: 255
ttl: integer

最小値: 0

最大値: 4294967295

デフォルト値: 86400
version: string

最小長: 1

最大長: 255

デフォルト値: LATEST

{
    "description":"Masterkey options.",
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "minLength":"1",
            "maxLength":"255"
        },
        "version":{
            "type":"string",
            "minLength":"1",
            "maxLength":"255",
            "default":"LATEST"
        },
        "ttl":{
            "type":"integer",
            "minimum":"0",
            "maximum":"4294967295",
            "default":"86400"
        }
    },
    "required":[
        "name"
    ],
    "additionalProperties":false
}

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

型: array

最小アイテム数: 0

最大アイテム数: 255

プラグインAPIのメタデータ

ソースの表示

配列: object items

{
    "description":"Metadata for the plugin API",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "name":{
                "description":"Metadata name",
                "type":"string",
                "minLength":"1",
                "maxLength":"64"
            },
            "value":{
                "description":"Metadata value",
                "type":"string",
                "minLength":"1",
                "maxLength":"4096"
            }
        },
        "additionalProperties":false,
        "required":[
            "name",
            "value"
        ]
    },
    "minItems":"0",
    "maxItems":"255"
}

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

型: object

ソースの表示

name(必須): string

最小長: 1

最大長: 64

メタデータ名
value(必須): string

最小長: 1

最大長: 4096

メタデータ値

{
    "type":"object",
    "properties":{
        "name":{
            "description":"Metadata name",
            "type":"string",
            "minLength":"1",
            "maxLength":"64"
        },
        "value":{
            "description":"Metadata value",
            "type":"string",
            "minLength":"1",
            "maxLength":"4096"
        }
    },
    "additionalProperties":false,
    "required":[
        "name",
        "value"
    ]
}

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

{
    "$schema":"ogg:encryptionProfile",
    "type":"okv",
    "okvVersion":"18.1",
    "okvPath":"/tmp/okvSample",
    "keyNameAttribute":"x-OGG-KeyName",
    "keyVersionAttribute":"x-OGG-KeyVersion",
    "masterkey":{
        "name":"OGGMK_A1",
        "version":"LATEST",
        "ttl":"86400"
    }
}

先頭に戻る

レスポンス

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

application/json

201レスポンス

暗号化プロファイルが正常に作成されました。

ルート・スキーマ: RESTful API Standard Response

型: object

タイトル: RESTful API Standard Response

すべてのOracle GoldenGate RESTful APIコールの標準レスポンス

ソースの表示

$schema:

指定できる値: [ "api:standardResponse" ]
links(必須): array links

最小アイテム数: 0

最大アイテム数: 16

リクエストのOracle GoldenGateリンク
messages(必須): array messages

最小アイテム数: 0

最大アイテム数: 65535

リクエストの間に発行されるGoldenGateメッセージ
response: object response

リクエストのOracle GoldenGateドキュメント

{
    "title":"RESTful API Standard Response",
    "description":"Standard Response for all Oracle GoldenGate RESTful API calls",
    "required":[
        "messages",
        "links"
    ],
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "api:standardResponse"
            ]
        },
        "response":{
            "description":"Oracle GoldenGate document from the request",
            "type":"object"
        },
        "messages":{
            "description":"Oracle GoldenGate messages issued during the request",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "$schema":{
                        "enum":[
                            "ogg:message"
                        ]
                    },
                    "type":{
                        "description":"An absolute URI [RFC3986] to a page that describes the info, warning or error type.",
                        "type":"string",
                        "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
                        "minLength":"2",
                        "maxLength":"4095"
                    },
                    "title":{
                        "description":"A human-readable description that provides information and detail specific to this occurence of the information, warning or error.",
                        "type":"string",
                        "minLength":"1",
                        "maxLength":"4095"
                    },
                    "code":{
                        "description":"The Oracle GoldenGate message code",
                        "type":"string",
                        "pattern":"^OGG[-][0-9]{5}$",
                        "minLength":"9",
                        "maxLength":"9"
                    },
                    "severity":{
                        "description":"The severity of the message",
                        "enum":[
                            "INFO",
                            "WARNING",
                            "ERROR"
                        ]
                    },
                    "issued":{
                        "description":"The date and time that the message was issued",
                        "type":"string",
                        "pattern":"^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$",
                        "minLength":"20",
                        "maxLength":"32"
                    }
                },
                "required":[
                    "type",
                    "title",
                    "code",
                    "severity",
                    "issued"
                ],
                "additionalProperties":false
            },
            "minItems":"0",
            "maxItems":"65535"
        },
        "links":{
            "description":"Oracle GoldenGate links for the request",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "$schema":{
                        "enum":[
                            "ogg:link"
                        ]
                    },
                    "rel":{
                        "description":"Relationship of href to the requested link",
                        "enum":[
                            "alternate",
                            "canonical",
                            "current",
                            "describedby",
                            "describes",
                            "enclosure",
                            "parent",
                            "related",
                            "self",
                            "first",
                            "last",
                            "next",
                            "previous",
                            "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
            },
            "minItems":"0",
            "maxItems":"16"
        }
    },
    "additionalProperties":false
}

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

型: array

最小アイテム数: 0

最大アイテム数: 16

リクエストのOracle GoldenGateリンク

ソースの表示

配列: object items

{
    "description":"Oracle GoldenGate links for the request",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "$schema":{
                "enum":[
                    "ogg:link"
                ]
            },
            "rel":{
                "description":"Relationship of href to the requested link",
                "enum":[
                    "alternate",
                    "canonical",
                    "current",
                    "describedby",
                    "describes",
                    "enclosure",
                    "parent",
                    "related",
                    "self",
                    "first",
                    "last",
                    "next",
                    "previous",
                    "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
    },
    "minItems":"0",
    "maxItems":"16"
}

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

型: array

最小アイテム数: 0

最大アイテム数: 65535

リクエストの間に発行されるGoldenGateメッセージ

ソースの表示

配列: object items

{
    "description":"Oracle GoldenGate messages issued during the request",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "$schema":{
                "enum":[
                    "ogg:message"
                ]
            },
            "type":{
                "description":"An absolute URI [RFC3986] to a page that describes the info, warning or error type.",
                "type":"string",
                "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
                "minLength":"2",
                "maxLength":"4095"
            },
            "title":{
                "description":"A human-readable description that provides information and detail specific to this occurence of the information, warning or error.",
                "type":"string",
                "minLength":"1",
                "maxLength":"4095"
            },
            "code":{
                "description":"The Oracle GoldenGate message code",
                "type":"string",
                "pattern":"^OGG[-][0-9]{5}$",
                "minLength":"9",
                "maxLength":"9"
            },
            "severity":{
                "description":"The severity of the message",
                "enum":[
                    "INFO",
                    "WARNING",
                    "ERROR"
                ]
            },
            "issued":{
                "description":"The date and time that the message was issued",
                "type":"string",
                "pattern":"^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$",
                "minLength":"20",
                "maxLength":"32"
            }
        },
        "required":[
            "type",
            "title",
            "code",
            "severity",
            "issued"
        ],
        "additionalProperties":false
    },
    "minItems":"0",
    "maxItems":"65535"
}

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

型: object

リクエストのOracle GoldenGateドキュメント

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

型: object

ソースの表示

$schema:

指定できる値: [ "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
}

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

型: object

ソースの表示

$schema:

指定できる値: [ "ogg:message" ]
code(必須): string

最小長: 9

最大長: 9

パターン: ^OGG[-][0-9]{5}$

Oracle GoldenGateメッセージ・コード
issued(必須): string

最小長: 20

最大長: 32

パターン: ^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$

メッセージが発行された日時
severity(必須):

指定できる値: [ "INFO", "WARNING", "ERROR" ]

メッセージの重大度
title(必須): string

最小長: 1

最大長: 4095

この情報、警告またはエラーに固有の情報と詳細を提供する、人が読むための説明。
type(必須): string

最小長: 2

最大長: 4095

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

情報、警告またはエラーのタイプを説明するページの絶対URI [RFC3986]。

{
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:message"
            ]
        },
        "type":{
            "description":"An absolute URI [RFC3986] to a page that describes the info, warning or error type.",
            "type":"string",
            "pattern":"^[a-zA-Z][a-zA-Z0-9+-.]*:[^ \\t]*$",
            "minLength":"2",
            "maxLength":"4095"
        },
        "title":{
            "description":"A human-readable description that provides information and detail specific to this occurence of the information, warning or error.",
            "type":"string",
            "minLength":"1",
            "maxLength":"4095"
        },
        "code":{
            "description":"The Oracle GoldenGate message code",
            "type":"string",
            "pattern":"^OGG[-][0-9]{5}$",
            "minLength":"9",
            "maxLength":"9"
        },
        "severity":{
            "description":"The severity of the message",
            "enum":[
                "INFO",
                "WARNING",
                "ERROR"
            ]
        },
        "issued":{
            "description":"The date and time that the message was issued",
            "type":"string",
            "pattern":"^[0-9]{4}[-](0[1-9]|1[0-2])[-](0[1-9]|[12][0-9]|3[01])[tT ]([01][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]{1,6})?([zZ]|[+-][0-9][0-9]:[0-5][0-9])$",
            "minLength":"20",
            "maxLength":"32"
        }
    },
    "required":[
        "type",
        "title",
        "code",
        "severity",
        "issued"
    ],
    "additionalProperties":false
}

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

{
    "$schema":"api:standardResponse",
    "links":[
        {
            "href":"http://localhost:9012/services/v2/encryption/profiles/Default",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9012/services/v2/encryption/profiles/Default",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "messages":[
    ]
}

先頭に戻る