ジャンプ先

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

暗号化プロファイルの取得

get

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

必要なロール: 任意

暗号化プロファイルの詳細を取得します。

リクエスト

パス・パラメータ

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

  最大長: 64

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

  暗号化プロファイルの名前。

• version(必須): string

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

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

先頭に戻る

レスポンス

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

• application/json

200レスポンス

プロファイルの説明が取得されます。

本文()

ルート・スキーマ: 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":"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"
        },
        {
            "href":"http://localhost:9012/services/v2/metadata-catalog/profile",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:encryptionProfile",
        "isDefault":true,
        "keyNameAttribute":"x-OGG-KeyName",
        "keyVersionAttribute":"x-OGG-KeyVersion",
        "masterkey":{
            "name":"OGGMK_A1",
            "ttl":"86400",
            "version":"LATEST"
        },
        "okvPath":"/tmp/okvSample",
        "okvVersion":"18.1",
        "type":"okv"
    }
}

先頭に戻る