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

暗号化キーの作成

post

/services/{version}/enckeys/{keyName}

必要なロール: 管理者

暗号化キーを作成します。

リクエスト

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

application/json

パス・パラメータ

keyName(必須): string

最小長: 1

最大長: 24

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

暗号化キーの名前。
version(必須): string

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

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

ルート・スキーマ: Oracle GoldenGate Encryption Key

タイトル: Oracle GoldenGate Encryption Key

このスキーマはデータの暗号化に使用される暗号化鍵を説明します

1つに一致

ソースの表示

object Oracle GoldenGate Encryption Key-x-oneOf[0]

128ビットの暗号化キー
object Oracle GoldenGate Encryption Key-x-oneOf[1]

192ビットの暗号化キー
object Oracle GoldenGate Encryption Key-x-oneOf[2]

256ビットの暗号化キー

{
    "x-oneOf":[
        {
            "description":"128-bit encryption key",
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "ogg:encryptKey"
                    ]
                },
                "bitLength":{
                    "description":"Length of the encryption key, in bits",
                    "enum":[
                        "128"
                    ]
                },
                "keyValue":{
                    "description":"An optional encryption key value. If not provided, one will be generated.",
                    "type":"string",
                    "pattern":"0x[A-Fa-f0-9]{32}",
                    "minLength":"34",
                    "maxLength":"34"
                }
            },
            "required":[
                "bitLength"
            ],
            "additionalProperties":false
        },
        {
            "description":"192-bit encryption key",
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "ogg:encryptKey"
                    ]
                },
                "bitLength":{
                    "description":"Length of the encryption key, in bits",
                    "enum":[
                        "192"
                    ]
                },
                "keyValue":{
                    "description":"An optional encryption key value. If not provided, one will be generated.",
                    "type":"string",
                    "pattern":"0x[A-Fa-f0-9]{48}",
                    "minLength":"50",
                    "maxLength":"50"
                }
            },
            "required":[
                "bitLength"
            ],
            "additionalProperties":false
        },
        {
            "description":"256-bit encryption key",
            "type":"object",
            "properties":{
                "$schema":{
                    "enum":[
                        "ogg:encryptKey"
                    ]
                },
                "bitLength":{
                    "description":"Length of the encryption key, in bits",
                    "enum":[
                        "256"
                    ]
                },
                "keyValue":{
                    "description":"An optional encryption key value. If not provided, one will be generated.",
                    "type":"string",
                    "pattern":"0x[A-Fa-f0-9]{64}",
                    "minLength":"66",
                    "maxLength":"66"
                }
            },
            "required":[
                "bitLength"
            ],
            "additionalProperties":false
        }
    ],
    "title":"Oracle GoldenGate Encryption Key",
    "description":"This schema describes an encryption key, used to encrypt data"
}

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

型: object

128ビットの暗号化キー

ソースの表示

$schema:

指定できる値: [ "ogg:encryptKey" ]
bitLength(必須):

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

暗号化キーのビット単位での長さ
keyValue: string

最小長: 34

最大長: 34

パターン: 0x[A-Fa-f0-9]{32}

オプションの暗号化キー値。指定されていない場合は、値が生成されます。

{
    "description":"128-bit encryption key",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:encryptKey"
            ]
        },
        "bitLength":{
            "description":"Length of the encryption key, in bits",
            "enum":[
                "128"
            ]
        },
        "keyValue":{
            "description":"An optional encryption key value. If not provided, one will be generated.",
            "type":"string",
            "pattern":"0x[A-Fa-f0-9]{32}",
            "minLength":"34",
            "maxLength":"34"
        }
    },
    "required":[
        "bitLength"
    ],
    "additionalProperties":false
}

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

型: object

192ビットの暗号化キー

ソースの表示

$schema:

指定できる値: [ "ogg:encryptKey" ]
bitLength(必須):

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

暗号化キーのビット単位での長さ
keyValue: string

最小長: 50

最大長: 50

パターン: 0x[A-Fa-f0-9]{48}

オプションの暗号化キー値。指定されていない場合は、値が生成されます。

{
    "description":"192-bit encryption key",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:encryptKey"
            ]
        },
        "bitLength":{
            "description":"Length of the encryption key, in bits",
            "enum":[
                "192"
            ]
        },
        "keyValue":{
            "description":"An optional encryption key value. If not provided, one will be generated.",
            "type":"string",
            "pattern":"0x[A-Fa-f0-9]{48}",
            "minLength":"50",
            "maxLength":"50"
        }
    },
    "required":[
        "bitLength"
    ],
    "additionalProperties":false
}

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

型: object

256ビットの暗号化キー

ソースの表示

$schema:

指定できる値: [ "ogg:encryptKey" ]
bitLength(必須):

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

暗号化キーのビット単位での長さ
keyValue: string

最小長: 66

最大長: 66

パターン: 0x[A-Fa-f0-9]{64}

オプションの暗号化キー値。指定されていない場合は、値が生成されます。

{
    "description":"256-bit encryption key",
    "type":"object",
    "properties":{
        "$schema":{
            "enum":[
                "ogg:encryptKey"
            ]
        },
        "bitLength":{
            "description":"Length of the encryption key, in bits",
            "enum":[
                "256"
            ]
        },
        "keyValue":{
            "description":"An optional encryption key value. If not provided, one will be generated.",
            "type":"string",
            "pattern":"0x[A-Fa-f0-9]{64}",
            "minLength":"66",
            "maxLength":"66"
        }
    },
    "required":[
        "bitLength"
    ],
    "additionalProperties":false
}

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

{
    "bitLength":"128"
}

先頭に戻る

レスポンス

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

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/enckeys/superkey",
            "mediaType":"application/json",
            "rel":"canonical"
        },
        {
            "href":"http://localhost:9012/services/v2/enckeys/superkey",
            "mediaType":"application/json",
            "rel":"self"
        }
    ],
    "messages":[
    ]
}

先頭に戻る