暗号化プロファイルの置換
patch
/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
型:
objectタイトル:
Oracle GoldenGate Encryption Profile definitionこのスキーマは、OGGでのデータ暗号化の構成およびプロパティを示します
1つに一致
ソースの表示
ネストされたスキーマ: Oracle GoldenGate Encryption Profile definition-x-oneOf[0]
型:
ソースの表示
object- $schema:
指定できる値:
[ "ogg:encryptionProfile" ] - description: string
最小長:
1最大長:256暗号化プロファイルの説明。 - isDefault: boolean
デフォルト値:
falseデフォルトのプロファイルです。 - type:
指定できる値:
[ "localWallet" ]OGGローカル・ウォレット
ネストされたスキーマ: 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最大長:4096Oracle Key Vaultクライアント・ソフトウェアがインストールされるパス。 - okvVersion:
デフォルト値:
18.1指定できる値:[ "18.1", "21.4" ]Oracle Key Vaultのバージョン - type:
指定できる値:
[ "okv" ]Oracle Key Vault
ネストされたスキーマ: Oracle GoldenGate Encryption Profile definition-x-oneOf[2]
型:
ソースの表示
object- $schema:
指定できる値:
[ "ogg:encryptionProfile" ] - apiSigningKey: string
最小長:
1最大長:10240OCI 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}[.].*[.].*Oracle Cloud ID - tenancyID: string
最小長:
1最大長:255パターン:ocid1[.].*[.]oc[123]{1}[.].*[.].*Oracle Cloud ID - type:
指定できる値:
[ "ocikms" ]OCIキー管理サービス - userID: string
最小長:
1最大長:255パターン:ocid1[.].*[.]oc[123]{1}[.].*[.].*Oracle Cloud ID
ネストされたスキーマ: masterkey
型:
objectマスター・キーのオプションを指定します。
ソースの表示
- name(必須): string
最小長:
1最大長:255 - ttl: integer
最小値:
0最大値:4294967295デフォルト値:86400 - version: string
最小長:
1最大長:255デフォルト値:LATEST
リクエストの例(application/json)
{
"type":"okv",
"isDefault":true
}レスポンス
サポートされるメディア・タイプ
- application/json
200レスポンス
暗号化プロファイルが正常に更新されました。
ルート・スキーマ: 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ドキュメント
ネストされたスキーマ: 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の関係
ネストされたスキーマ: 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]。
レスポンスの例(application/json)
{
"$schema":"api:standardResponse",
"links":[
{
"href":"http://localhost:11001/services/v2/encryption/profiles/Default",
"mediaType":"application/json",
"rel":"canonical"
},
{
"href":"http://localhost:11001/services/v2/encryption/profiles/Default",
"mediaType":"application/json",
"rel":"self"
}
],
"messages":[
]
}