ジャンプ先

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

暗号化キーの取得

get

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

必要なロール: ユーザー

暗号化キーの詳細を取得します。

リクエスト

パス・パラメータ

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

  最大長: 24

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

  暗号化キーの名前。

• version(必須): string

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

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

先頭に戻る

レスポンス

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

• application/json

200レスポンス

取得された暗号化キーの詳細。

本文()

ルート・スキーマ: 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)

{
    "$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"
        },
        {
            "href":"http://localhost:9012/services/v2/metadata-catalog/keyName",
            "mediaType":"application/schema+json",
            "rel":"describedby"
        }
    ],
    "messages":[
    ],
    "response":{
        "$schema":"ogg:encryptKey",
        "bitLength":"128"
    }
}

先頭に戻る