Oracle Unified Directoryの管理REST API: DNによるファイル・システム・エントリ・キャッシュの変更

DNによるファイル・システム・エントリ・キャッシュの変更

PATCH

/rest/v1/admin/{dn}

DNによるファイル・システム・エントリ・キャッシュの変更

リクエスト

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

application/json

パス・パラメータ

dn: string

変更するエントリのLDAP DN。

変更する必要があるファイル・システム・エントリ・キャッシュ

ルート・スキーマ: PatchRequest

型: object

ソースを表示

controls(optional): array controls

LDAP変更操作のためにサーバーに送信するLDAP制御。
msgType: string

デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest

RESTメッセージ・タイプ
operations: array operations

エントリに対して実行する変更(パッチ操作)。

{
    "type":"object",
    "required":[
        "msgType",
        "operations"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest",
            "type":"string"
        },
        "operations":{
            "type":"array",
            "description":"Modifications (Patch operations) to be performed on the entry.",
            "items":{
                "$ref":"#/definitions/PatchOperation"
            }
        },
        "controls":{
            "description":"LDAP controls to be sent to server for LDAP modify operation.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

LDAP変更操作のためにサーバーに送信するLDAP制御。

ソースを表示

[0]: string

{
    "description":"LDAP controls to be sent to server for LDAP modify operation.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

エントリに対して実行する変更(パッチ操作)。

ソースを表示

[0]: object PatchOperation

{
    "type":"array",
    "description":"Modifications (Patch operations) to be performed on the entry.",
    "items":{
        "$ref":"#/definitions/PatchOperation"
    }
}

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

型: object

ソースを表示

attribute: string

変更するエントリ属性。
opType: string

指定可能な値: [ "add", "delete", "replace", "increment" ]

パッチ操作のタイプ。
values(optional): array values

更新する属性値。

{
    "type":"object",
    "required":[
        "opType",
        "attribute"
    ],
    "properties":{
        "opType":{
            "description":"The type of the Patch Operation.",
            "type":"string",
            "enum":[
                "add",
                "delete",
                "replace",
                "increment"
            ]
        },
        "attribute":{
            "type":"string",
            "description":"The entry attribute to be modified."
        },
        "values":{
            "type":"array",
            "description":"The attribute values to be updated.",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

更新する属性値。

ソースを表示

[0]: string

{
    "type":"array",
    "description":"The attribute values to be updated.",
    "items":{
        "type":"string"
    }
}

先頭に戻る

レスポンス

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

application/json

200レスポンス

ルート・スキーマ: ファイル・システム・エントリ・キャッシュのPatchSuccessResponse

型: object

ソースを表示

msgType: string

デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyResponse

RESTメッセージ・タイプ
searchResultEntries: array searchResultEntries

LDAP操作後に返される検索結果エントリの数。
totalResults: integer(int32)

作成され、返されるエントリの数を指定します。

{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyResponse",
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "description":"Number of search result entries returned after the LDAP operation.",
            "items":{
                "$ref":"#/definitions/File System Entry Cache SearchResultEntry"
            }
        }
    }
}

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

型: array

LDAP操作後に返される検索結果エントリの数。

ソースを表示

[0]: object ファイル・システム・エントリ・キャッシュのSearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/File System Entry Cache SearchResultEntry"
    }
}

ネストされたスキーマ: ファイル・システム・エントリ・キャッシュのSearchResultEntry

型: object

ソースを表示

attributes: object ファイル・システム・エントリ・キャッシュのプロパティ
dn: string

作成するエントリのLDAP DN。

{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/File System Entry Cache Properties"
        }
    }
}

ネストされたスキーマ: ファイル・システム・エントリ・キャッシュのプロパティ

型: object

ソースを表示

cn(optional): string

エントリのCN (共通名)
ds-cfg-cache-directory(optional): string

デフォルト値: /tmp/OpenDS.FSCache

JE環境でキャッシュを格納するディレクトリを指定します。
ds-cfg-cache-level: integer(int32)

キャッシュのインスタンスが複数構成されている場合に、キャッシュ順序内のキャッシュ・レベルを指定します。
ds-cfg-cache-type(optional): string

デフォルト値: fifo

指定可能な値: [ "fifo", "lru" ]

キャッシュからエントリをパージする場合に使用するポリシーを指定します。
ds-cfg-compact-encoding(optional): boolean

デフォルト値: true

キャッシュ・エントリをエンコードするときに属性の説明とオブジェクト・クラス・セットを圧縮することで、圧縮形式を使用するかどうかを示します。
ds-cfg-db-cache-percent(optional): integer(int32)

デフォルト値: 1

内部JEキャッシュ用の最大メモリー使用量を合計JVMメモリーに対するパーセンテージとして指定します。
ds-cfg-db-cache-size(optional): string

デフォルト値: 0b

内部JEキャッシュの最大JVMメモリー使用量をバイト単位で指定します。
ds-cfg-enabled: boolean

エントリ・キャッシュが有効かどうかを示します。
ds-cfg-exclude-filter(optional): array ds-cfg-exclude-filter

キャッシュから除外する必要があるエントリを定義する一連のフィルタ。
ds-cfg-include-filter(optional): array ds-cfg-include-filter

キャッシュに格納する必要があるエントリを定義する一連のフィルタ。
ds-cfg-java-class: string

デフォルト値: org.opends.server.extensions.FileSystemEntryCache

ファイル・システム・エントリ・キャッシュの実装を提供するJavaクラスの完全修飾名を指定します。
ds-cfg-je-property(optional): array ds-cfg-je-property

該当するエントリ・キャッシュ用のバックエンドを提供するBerkeley DB Java Editionデータベースの環境プロパティを指定します。
ds-cfg-lock-timeout(optional): string

デフォルト値: 2000.0ms

読取りロックまたは書込みロック取得時の待機時間。
ds-cfg-max-entries(optional): integer(int32)

デフォルト値: 2147483647

キャッシュに格納できる最大エントリ数。
ds-cfg-max-memory-size(optional): string

デフォルト値: 0b

エントリ・キャッシュの最大サイズ(バイト単位)。
ds-cfg-persistent-cache(optional): boolean

デフォルト値: false

再起動されてもキャッシュを維持するかどうかを指定します。
objectclass: array objectclass

このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-cache-level",
        "ds-cfg-enabled"
    ],
    "properties":{
        "objectclass":{
            "type":"array",
            "description":"Objectclass(es) which this entry belongs to.",
            "items":{
                "type":"string"
            }
        },
        "cn":{
            "type":"string",
            "description":"CN (common name) of the entry"
        },
        "ds-cfg-java-class":{
            "description":"Specifies the fully-qualified name of the Java class that provides the File System Entry Cache implementation. ",
            "readOnly":false,
            "default":"org.opends.server.extensions.FileSystemEntryCache",
            "type":"string"
        },
        "ds-cfg-compact-encoding":{
            "description":"Indicates whether the cache should use a compact form when encoding cache entries by compressing the attribute descriptions and object class sets. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-db-cache-size":{
            "description":"Specifies the maximum JVM memory usage in bytes for the internal JE cache. ",
            "readOnly":false,
            "default":"0b",
            "type":"string"
        },
        "ds-cfg-je-property":{
            "description":"Specifies the environment properties for the Berkeley DB Java Edition database providing the backend for this entry cache. ",
            "readOnly":false,
            "default":[
                "je.env.isLocking=false"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-include-filter":{
            "description":"The set of filters that define the entries that should be included in the cache. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-persistent-cache":{
            "description":"Specifies whether the cache should persist across restarts. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-cache-level":{
            "description":"Specifies the cache level in the cache order if more than one instance of the cache is configured. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Entry Cache is enabled. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-max-memory-size":{
            "description":"The maximum size of the entry cache in bytes. ",
            "readOnly":false,
            "default":"0b",
            "type":"string"
        },
        "ds-cfg-exclude-filter":{
            "description":"The set of filters that define the entries that should be excluded from the cache. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-max-entries":{
            "description":"The maximum number of entries allowed in the cache. ",
            "readOnly":false,
            "default":2147483647,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-cache-type":{
            "description":"Specifies the policy which should be used for purging entries from the cache. ",
            "readOnly":false,
            "default":"fifo",
            "type":"string",
            "enum":[
                "fifo",
                "lru"
            ]
        },
        "ds-cfg-db-cache-percent":{
            "description":"Specifies the maximum memory usage for the internal JE cache as a percentage of the total JVM memory. ",
            "readOnly":false,
            "default":1,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-cache-directory":{
            "description":"Specifies the directory in which the JE environment should store the cache. ",
            "readOnly":false,
            "default":"/tmp/OpenDS.FSCache",
            "type":"string"
        },
        "ds-cfg-lock-timeout":{
            "description":"The length of time to wait while attempting to acquire a read or write lock. ",
            "readOnly":false,
            "default":"2000.0ms",
            "type":"string"
        }
    }
}

ネストされたスキーマ: ds-cfg-exclude-filter

型: array

キャッシュから除外する必要があるエントリを定義する一連のフィルタ。

ソースを表示

[0]: string

{
    "description":"The set of filters that define the entries that should be excluded from the cache. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-include-filter

型: array

キャッシュに格納する必要があるエントリを定義する一連のフィルタ。

ソースを表示

[0]: string

{
    "description":"The set of filters that define the entries that should be included in the cache. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-je-property

型: array

該当するエントリ・キャッシュ用のバックエンドを提供するBerkeley DB Java Editionデータベースの環境プロパティを指定します。

デフォルト値: [ "je.env.isLocking=false" ]

ソースを表示

[0]: string

{
    "description":"Specifies the environment properties for the Berkeley DB Java Edition database providing the backend for this entry cache. ",
    "readOnly":false,
    "default":[
        "je.env.isLocking=false"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

このエントリが属するオブジェクト・クラス。

ソースを表示

[0]: string

{
    "type":"array",
    "description":"Objectclass(es) which this entry belongs to.",
    "items":{
        "type":"string"
    }
}

400レスポンス

ERROR

406レスポンス

受入れできません

ルート・スキーマ: ErrorResponse

型: object

ソースを表示

ldapErrorCode(optional): integer(int32)

操作に対して返されるLDAPエラー・コードを指定します。
message: string

操作に対して返されるエラー・メッセージ。
msgType: string

デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse

RESTメッセージ・タイプ

{
    "type":"object",
    "required":[
        "msgType",
        "message"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ErrorResponse",
            "type":"string"
        },
        "message":{
            "description":"Error message returned returned for the operation.",
            "type":"string"
        },
        "ldapErrorCode":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the LDAP error code returned for the operation."
        }
    }
}

先頭に戻る