Oracle Unified Directoryの管理REST API: DNによるFIFOエントリ・キャッシュの変更

DNによるFIFOエントリ・キャッシュの変更

PATCH

/rest/v1/admin/{dn}

DNによるFIFOエントリ・キャッシュの変更

リクエスト

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

application/json

パス・パラメータ

dn: string

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

変更する必要があるFIFOエントリ・キャッシュ

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

ルート・スキーマ: FIFOエントリ・キャッシュの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/FIFO Entry Cache SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

[0]: object FIFOエントリ・キャッシュのSearchResultEntry

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

ネストされたスキーマ: FIFOエントリ・キャッシュのSearchResultEntry

型: object

ソースを表示

attributes: object FIFOエントリ・キャッシュのプロパティ
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/FIFO Entry Cache Properties"
        }
    }
}

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

型: object

ソースを表示

cn(optional): string

エントリのCN (共通名)
ds-cfg-cache-level: integer(int32)

キャッシュのインスタンスが複数構成されている場合に、キャッシュ順序内のキャッシュ・レベルを指定します。
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.FIFOEntryCache

FIFOエントリ・キャッシュの実装を提供するJavaクラスの完全修飾名を指定します。
ds-cfg-lock-timeout(optional): string

デフォルト値: 2000.0ms

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

デフォルト値: 2147483647

キャッシュに格納できる最大エントリ数を指定します。
ds-cfg-max-memory-percent(optional): integer(int32)

デフォルト値: 90

エントリ・キャッシュ用の最大メモリー使用量を合計JVMメモリーに対するパーセンテージとして指定します。
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 FIFO Entry Cache implementation. ",
            "readOnly":false,
            "default":"org.opends.server.extensions.FIFOEntryCache",
            "type":"string"
        },
        "ds-cfg-max-memory-percent":{
            "description":"Specifies the maximum memory usage for the entry cache as a percentage of the total JVM memory. ",
            "readOnly":false,
            "default":90,
            "type":"integer",
            "format":"int32"
        },
        "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":"Specifies the maximum number of entries that we will allow in the cache. ",
            "readOnly":false,
            "default":2147483647,
            "type":"integer",
            "format":"int32"
        },
        "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-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-lock-timeout":{
            "description":"Specifies 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"
    }
}

ネストされたスキーマ: 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."
        }
    }
}

先頭に戻る