ジャンプ先

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

DBローカル・バックエンド・ワークフロー要素の追加、検索、比較または削除

POST

/rest/v1/admin

DBローカル・バックエンド・ワークフロー要素の追加、検索、比較または削除

リクエスト

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

• application/json

本文 ()

作成する必要があるDBローカル・バックエンド・ワークフロー要素

ルート・スキーマ: DBローカル・バックエンド・ワークフロー要素のPOSTRequest

型: object

ソースを表示

• assertion(optional): string
  LDAP比較操作用のアサーション文字列。注意: POSTを使用したLDAP比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。
• attributes(optional): object DBローカル・バックエンド・ワークフロー要素のプロパティ
• base(optional): string
  LDAP検索操作に使用する検索ベースDN。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。このような操作の場合も必須です
• controls(optional): array controls
  LDAP操作のためにサーバーに送信するLDAP制御。
• dn(optional): string
  作成、削除または比較するエントリのLDAP DN。注意: LDAPの追加、削除または比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest、urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequestまたはurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。このような操作の場合に必須です。
• filter(optional): string
  LDAP検索操作用の検索フィルタ。LDAP検索フィルタの構文に従う必要があります。注意: POSTリクエストを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
• msgType: string
  指定可能な値: [ "urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest" ]

  RESTメッセージ・タイプ
• requiredAttributes(optional): array requiredAttributes
  エントリに対してフェッチする属性のリスト。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
• scope(optional): string
  指定可能な値: [ "base", "sub", "one" ]

  LDAP検索操作の範囲。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。

{
    "type":"object",
    "required":[
        "msgType"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "type":"string",
            "enum":[
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest"
            ]
        },
        "dn":{
            "description":"LDAP DN of the entry to be created or deleted or compared. Note: To be used only while performing LDAP add, delete or compare operations, i.e, if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:AddRequest, urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteRequest or urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.It is mandatory for such operations.",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/DB Local Backend Workflow Element Properties"
        },
        "base":{
            "description":"Search Base DN to be used for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest. It is also mandatory for such operation",
            "type":"string"
        },
        "scope":{
            "description":"Scope for the LDAP search operation. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"string",
            "enum":[
                "base",
                "sub",
                "one"
            ]
        },
        "filter":{
            "description":"Search filter for the LDAP search operation. Should follow LDAP search filter syntax. Note: To be used only while performing LDAP search operation using POST request, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"string"
        },
        "requiredAttributes":{
            "description":"List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "controls":{
            "description":"LDAP controls to be sent to server for the LDAP operation.",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "assertion":{
            "description":"Assertion string for the LDAP compare operation. Note: To be used only while performing LDAP compare operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequest.",
            "type":"string"
        }
    }
}

ネストされたスキーマ: DBローカル・バックエンド・ワークフロー要素のプロパティ

型: object

ソースを表示

• cn(optional): string
  エントリのCN (共通名)
• ds-cfg-base-dn: array ds-cfg-base-dn
  バックエンドが処理するデータのベースDNを指定します。
• ds-cfg-cold-attribute(optional): array ds-cfg-cold-attribute
  バックエンド記憶域、取得およびキャッシュのメカニズムによってキャッシュがコールドとみなされ、コールド記憶域で保持される必要がある1つ以上のLDAP属性を指定することによって、属性レベルのキャッシュを有効化します。
• ds-cfg-compact-attribute-values-using-tokens(optional): array ds-cfg-compact-attribute-values-using-tokens
  値ではなくトークンを使用してサーバーが圧縮する必要がある属性のリストを示します。
• ds-cfg-compact-encoding(optional): boolean
  デフォルト値: true

  バックエンドが属性の説明とオブジェクト・クラス・セットを圧縮することでエントリをエンコードするときに、圧縮形式を使用する必要があるかどうかを示します。
• ds-cfg-db-cache-mode(optional): string
  デフォルト値: default

  指定可能な値: [ "default", "evict-bin", "evict-ln", "keep-hot", "make-cold", "unchanged" ]

  実行される操作に使用するインメモリー・キャッシュ・モードを指定します。
• ds-cfg-db-cache-percent(optional): integer(int32)
  データベース・キャッシュに割り当てるJVMメモリーのパーセンテージを指定します。
• ds-cfg-db-cache-size(optional): string
  デフォルト値: 0 MB

  データベース・キャッシュに割り当てるJVMメモリーの量。
• ds-cfg-db-checkpointer-bytes-interval(optional): string
  デフォルト値: 20mb

  強制的にチェックポイントを実行させられる前にデータベースに書き込むことのできる最大バイト数を指定します。
• ds-cfg-db-checkpointer-wakeup-interval(optional): string
  デフォルト値: 30s

  チェックポイント間の最長時間を指定します。
• ds-cfg-db-cleaner-min-utilization(optional): integer(int32)
  デフォルト値: 50

  データベース消去プログラムがデータベース・ログ・ファイルに保持する実データの最小パーセンテージを指定します。
• ds-cfg-db-directory: string
  デフォルト値: db

  このバックエンドのデータを含むBerkeley DB Java Editionデータベース・ファイルの保持に使用されるファイル・システム・・ディレクトリのパスを指定します。
• ds-cfg-db-directory-permissions(optional): string
  デフォルト値: 700

  サーバー・データベース・ファイルが含まれるディレクトリに適用する必要がある権限を指定します。
• ds-cfg-db-evictor-lru-only(optional): boolean
  デフォルト値: true

  データベースがLRUポリシー(最も長い間使用されていない情報が最初に破棄される)に基づいて既存データをキャッシュから破棄する必要があるかどうかを示します。
• ds-cfg-db-evictor-nodes-per-scan(optional): integer(int32)
  デフォルト値: 10

  新しい情報用の領域を確保するために既存のデータを解放する必要があると判断した場合に、1回にキャッシュから破棄するBtreeノードの数を指定します。
• ds-cfg-db-log-file-max(optional): string
  デフォルト値: 100mb

  データベース・ログ・ファイルの最大サイズを指定します。
• ds-cfg-db-logging-file-handler-on(optional): boolean
  デフォルト値: true

  データベースがデータベース・ログ・ディレクトリと同じディレクトリにje.infoファイルを保持するかどうかを示します。
• ds-cfg-db-logging-level(optional): string
  デフォルト値: CONFIG

  データベースがje.infoファイルに情報を書き込むときに使用するログ・レベルを指定します。
• ds-cfg-db-num-cleaner-threads(optional): integer(int32)
  データベース・ログ・ファイルを望ましい使用率またはそれに近い使用率に維持するために、バックエンドが保持するスレッドの数を指定します。
• ds-cfg-db-num-lock-tables(optional): integer(int32)
  基礎となるデータベースで使用されるロック表の数を指定します。
• ds-cfg-db-run-cleaner(optional): boolean
  デフォルト値: true

  データベース消去スレッドを有効にするかどうかを示します。
• ds-cfg-db-txn-durability(optional): string
  デフォルト値: write-to-filesystem

  指定可能な値: [ "write-to-cache", "write-to-disk", "write-to-filesystem" ]

  データベース・トランザクションの永続性を指定します。
• ds-cfg-disk-full-threshold(optional): string
  デフォルト値: 20 megabytes

  データベース更新を制限するための、フル・ディスクしきい値。
• ds-cfg-disk-low-threshold(optional): string
  デフォルト値: 100 megabytes

  データベース更新を制限するための、下限ディスクしきい値。
• ds-cfg-enabled: boolean
  サーバーでワークフロー要素が使用可能かどうかを示します。
• ds-cfg-entries-compressed(optional): boolean
  デフォルト値: false

  バックエンドがエントリをデータベースに格納する前にエントリの圧縮を試みるかどうかを示します。
• ds-cfg-index-entry-limit(optional): integer(int32)
  デフォルト値: 4000

  特定の索引キーが保持されなくなるまでに、その特定の索引キーに対する照合が許可されるエントリの最大数を指定します。
• ds-cfg-index-filter-analyzer-enabled(optional): boolean
  デフォルト値: false

  索引の使用を評価する際に、ディレクトリ・サーバーで処理される検索フィルタに関する統計情報を収集するかどうかを示します。
• ds-cfg-index-subtrees(optional): boolean
  デフォルト値: true

  各親エントリの直接または間接子エントリについての情報を含むサブツリー固有データを保持するように、バックエンドがサブツリーの索引付けを行うかどうかを示します。
• ds-cfg-is-private-backend(optional): boolean
  デフォルト値: false

  バックエンドをプライベート・バックエンドとみなすかどうかを示します。このことは、バックエンドがユーザー定義情報ではなく操作データの格納に使用されることを示します。
• ds-cfg-java-class: string
  デフォルト値: org.opends.server.workflowelement.localbackend.DBLocalBackendWorkflowElement

  DBローカル・バックエンド・ワークフロー要素の実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-je-property(optional): array ds-cfg-je-property
  このバックエンドにデータを提供するBerkeley DB Java Editionデータベースのデータベース・プロパティおよび環境プロパティを指定します。
• ds-cfg-maintenance(optional): boolean
  デフォルト値: false

  サーバーのDBローカル・バックエンド・ワークフロー要素が保守モードであるかどうかを示します。
• ds-cfg-max-entries(optional): integer(int32)
  デフォルト値: 25

  保持する検索フィルタ統計の最大数。
• ds-cfg-monitor-cold-attributes(optional): boolean
  デフォルト値: false

  コールド属性使用データのコレクションおよびモニタリングを使用可能にする必要があるかどうかを示します。
• ds-cfg-preload-time-limit(optional): string
  デフォルト値: 0s

  データが初期化されるときにバックエンドがそのデータの事前ロードにかけることのできる時間を指定します。
• ds-cfg-referrals-url(optional): array ds-cfg-referrals-url
  サーバーがリクエストを完了できない場合に返されるURL。
• ds-cfg-tombstone-creation-enabled(optional): boolean
  デフォルト値: true

  エントリが削除されたときに、バックエンドがツームストンを作成する必要があるかどうかを示します。
• ds-cfg-tombstone-lifetime(optional): string
  デフォルト値: 1w

  エントリが削除された後のツームストンの保存期間を指定します。
• ds-cfg-tombstone-purge-interval(optional): string
  デフォルト値: 5m

  ツームストンのパージが再度開始される時間の間隔を指定します。
• ds-cfg-writability-mode: string
  デフォルト値: enabled

  指定可能な値: [ "disabled", "enabled", "internal-only" ]

  バックエンドが書込み操作を処理する際に使用する必要がある動作を指定します。
• objectclass: array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-enabled",
        "ds-cfg-db-directory",
        "ds-cfg-writability-mode",
        "ds-cfg-base-dn"
    ],
    "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 DB Local Backend Workflow Element implementation. ",
            "readOnly":false,
            "default":"org.opends.server.workflowelement.localbackend.DBLocalBackendWorkflowElement",
            "type":"string"
        },
        "ds-cfg-db-log-file-max":{
            "description":"Specifies the maximum size for a database log file. ",
            "readOnly":false,
            "default":"100mb",
            "type":"string"
        },
        "ds-cfg-db-directory-permissions":{
            "description":"Specifies the permissions that should be applied to the directory containing the server database files. ",
            "readOnly":false,
            "default":"700",
            "type":"string"
        },
        "ds-cfg-index-filter-analyzer-enabled":{
            "description":"Indicates whether to gather statistical information about the search filters processed by the Directory Server while evaluating the usage of indexes. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-db-checkpointer-bytes-interval":{
            "description":"Specifies the maximum number of bytes that may be written to the database before it is forced to perform a checkpoint. ",
            "readOnly":false,
            "default":"20mb",
            "type":"string"
        },
        "ds-cfg-db-cache-size":{
            "description":"The amount of JVM memory to allocate to the database cache. ",
            "readOnly":false,
            "default":"0 MB",
            "type":"string"
        },
        "ds-cfg-preload-time-limit":{
            "description":"Specifies the length of time that the backend is allowed to spend \"pre-loading\" data when it is initialized. ",
            "readOnly":false,
            "default":"0s",
            "type":"string"
        },
        "ds-cfg-db-logging-file-handler-on":{
            "description":"Indicates whether the database should maintain a je.info file in the same directory as the database log directory. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-disk-low-threshold":{
            "description":"Low disk threshold to limit database updates. ",
            "readOnly":false,
            "default":"100 megabytes",
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow Element is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-db-checkpointer-wakeup-interval":{
            "description":"Specifies the maximum length of time that may pass between checkpoints. ",
            "readOnly":false,
            "default":"30s",
            "type":"string"
        },
        "ds-cfg-db-num-lock-tables":{
            "description":"Specifies the number of lock tables that are used by the underlying database. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-max-entries":{
            "description":"The maximum number of search filter statistics to keep. ",
            "readOnly":false,
            "default":25,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-is-private-backend":{
            "description":"Indicates whether the backend should be considered a private backend, which indicates that it is used for storing operational data rather than user-defined information. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-tombstone-purge-interval":{
            "description":"Specifies the time interval after which tombstone purging is restarted. ",
            "readOnly":false,
            "default":"5m",
            "type":"string"
        },
        "ds-cfg-db-run-cleaner":{
            "description":"Indicates whether the database cleaner threads should be enabled. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-db-txn-durability":{
            "description":"Specifies the durability of database transactions. ",
            "readOnly":false,
            "default":"write-to-filesystem",
            "type":"string",
            "enum":[
                "write-to-cache",
                "write-to-disk",
                "write-to-filesystem"
            ]
        },
        "ds-cfg-entries-compressed":{
            "description":"Indicates whether the backend should attempt to compress entries before storing them in the database. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-index-entry-limit":{
            "description":"Specifies the maximum number of entries that is allowed to match a given index key before that particular index key is no longer maintained. ",
            "readOnly":false,
            "default":4000,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-compact-encoding":{
            "description":"Indicates whether the backend should use a compact form when encoding entries by compressing the attribute descriptions and object class sets. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-referrals-url":{
            "description":"The URLs that should be returned when the server is not able to fulfill the requests. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-db-directory":{
            "description":"Specifies the path to the filesystem directory that is used to hold the Berkeley DB Java Edition database files containing the data for this backend. ",
            "readOnly":false,
            "default":"db",
            "type":"string"
        },
        "ds-cfg-compact-attribute-values-using-tokens":{
            "description":"Indicates the list of attributes that the server should compact using token instead of values. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-db-cache-mode":{
            "description":"Specifies the in-memory cache mode used for operations performed. ",
            "readOnly":false,
            "default":"default",
            "type":"string",
            "enum":[
                "default",
                "evict-bin",
                "evict-ln",
                "keep-hot",
                "make-cold",
                "unchanged"
            ]
        },
        "ds-cfg-je-property":{
            "description":"Specifies the database and environment properties for the Berkeley DB Java Edition database serving the data for this backend. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-writability-mode":{
            "description":"Specifies the behavior that the backend should use when processing write operations. ",
            "readOnly":false,
            "default":"enabled",
            "type":"string",
            "enum":[
                "disabled",
                "enabled",
                "internal-only"
            ]
        },
        "ds-cfg-db-evictor-nodes-per-scan":{
            "description":"Specifies the number of Btree nodes that should be evicted from the cache in a single pass if it is determined that it is necessary to free existing data in order to make room for new information. ",
            "readOnly":false,
            "default":10,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-disk-full-threshold":{
            "description":"Full disk threshold to limit database updates. ",
            "readOnly":false,
            "default":"20 megabytes",
            "type":"string"
        },
        "ds-cfg-tombstone-lifetime":{
            "description":"Specifies the lifetime of a tombstone after the entry has been deleted. ",
            "readOnly":false,
            "default":"1w",
            "type":"string"
        },
        "ds-cfg-base-dn":{
            "description":"Specifies the base DN(s) for the data that the backend handles. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-db-cleaner-min-utilization":{
            "description":"Specifies the minimum percentage of \"live\" data that the database cleaner attempts to keep in database log files. ",
            "readOnly":false,
            "default":50,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-db-num-cleaner-threads":{
            "description":"Specifies the number of threads that the backend should maintain to keep the database log files at or near the desired utilization. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-db-evictor-lru-only":{
            "description":"Indicates whether the database should evict existing data from the cache based on an LRU policy (where the least recently used information will be evicted first). ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-monitor-cold-attributes":{
            "description":"Indicates whether cold attributes usage data collection and monitoring should be enabled. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-db-logging-level":{
            "description":"Specifies the log level that should be used by the database when it is writing information into the je.info file. ",
            "readOnly":false,
            "default":"CONFIG",
            "type":"string"
        },
        "ds-cfg-index-subtrees":{
            "description":"Indicates whether or not the backend should index subtrees to maintain subtree specific data retaining information on direct and indirect children entries of each parent entry. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-maintenance":{
            "description":"Indicates whether the server DB Local Backend Workflow Element is in maintenance mode. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-db-cache-percent":{
            "description":"Specifies the percentage of JVM memory to allocate to the database cache. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-cold-attribute":{
            "description":"Enables attribute level caching by specifying one or more LDAP attributes that should be considered cache cold by backend storage, retrieval and caching mechanisms and maintained in the cold storage. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-tombstone-creation-enabled":{
            "description":"Indicates whether the backend should create a tombstone when an entry is deleted. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        }
    }
}

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

型: array

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

ソースを表示

• [0]: string

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

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

型: array

エントリに対してフェッチする属性のリスト。注意: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。

ソースを表示

• [0]: string

{
    "description":"List of attributes to be fetched for the entry. Note: To be used only while performing LDAP search operation using POST, i.e., if the msgType is urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequest.",
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-base-dn

型: array

バックエンドが処理するデータのベースDNを指定します。

ソースを表示

• [0]: string

{
    "description":"Specifies the base DN(s) for the data that the backend handles. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-cold-attribute

型: array

バックエンド記憶域、取得およびキャッシュのメカニズムによってキャッシュがコールドとみなされ、コールド記憶域で保持される必要がある1つ以上のLDAP属性を指定することによって、属性レベルのキャッシュを有効化します。

ソースを表示

• [0]: string

{
    "description":"Enables attribute level caching by specifying one or more LDAP attributes that should be considered cache cold by backend storage, retrieval and caching mechanisms and maintained in the cold storage. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-compact-attribute-values-using-tokens

型: array

値ではなくトークンを使用してサーバーが圧縮する必要がある属性のリストを示します。

ソースを表示

• [0]: string

{
    "description":"Indicates the list of attributes that the server should compact using token instead of values. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

このバックエンドにデータを提供するBerkeley DB Java Editionデータベースのデータベース・プロパティおよび環境プロパティを指定します。

ソースを表示

• [0]: string

{
    "description":"Specifies the database and environment properties for the Berkeley DB Java Edition database serving the data for this backend. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-referrals-url

型: array

サーバーがリクエストを完了できない場合に返されるURL。

ソースを表示

• [0]: string

{
    "description":"The URLs that should be returned when the server is not able to fulfill the requests. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

• [0]: string

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

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文 ()

ルート・スキーマ: DBローカル・バックエンド・ワークフロー要素のSuccessResponse

型: object

ソースを表示

• compareResult(optional): boolean
  LDAP比較操作の結果を示します。
• msgType: string
  指定可能な値: [ "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteResponse", "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareResponse" ]

  RESTメッセージ・タイプ
• searchResultEntries: array searchResultEntries
  LDAP操作後に返される検索結果エントリの数。
• totalResults: integer(int32)
  作成され、返されるエントリの数を指定します。

{
    "type":"object",
    "required":[
        "msgType",
        "totalResults",
        "searchResultEntries"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "type":"string",
            "enum":[
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:SearchResponse",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:DeleteResponse",
                "urn:ietf:params:rest:schemas:oracle:oud:1.0:CompareResponse"
            ]
        },
        "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/DB Local Backend Workflow Element SearchResultEntry"
            }
        },
        "compareResult":{
            "description":"Indicates the result of LDAP compare operation.",
            "type":"boolean"
        }
    }
}

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

型: array

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

ソースを表示

• [0]: object DBローカル・バックエンド・ワークフロー要素のSearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/DB Local Backend Workflow Element SearchResultEntry"
    }
}

ネストされたスキーマ: DBローカル・バックエンド・ワークフロー要素のSearchResultEntry

型: object

ソースを表示

• attributes: object DBローカル・バックエンド・ワークフロー要素のプロパティ
• 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/DB Local Backend Workflow Element Properties"
        }
    }
}

ネストされたスキーマ: DBローカル・バックエンド・ワークフロー要素のプロパティ

型: object

ソースを表示

• cn(optional): string
  エントリのCN (共通名)
• ds-cfg-base-dn: array ds-cfg-base-dn
  バックエンドが処理するデータのベースDNを指定します。
• ds-cfg-cold-attribute(optional): array ds-cfg-cold-attribute
  バックエンド記憶域、取得およびキャッシュのメカニズムによってキャッシュがコールドとみなされ、コールド記憶域で保持される必要がある1つ以上のLDAP属性を指定することによって、属性レベルのキャッシュを有効化します。
• ds-cfg-compact-attribute-values-using-tokens(optional): array ds-cfg-compact-attribute-values-using-tokens
  値ではなくトークンを使用してサーバーが圧縮する必要がある属性のリストを示します。
• ds-cfg-compact-encoding(optional): boolean
  デフォルト値: true

  バックエンドが属性の説明とオブジェクト・クラス・セットを圧縮することでエントリをエンコードするときに、圧縮形式を使用する必要があるかどうかを示します。
• ds-cfg-db-cache-mode(optional): string
  デフォルト値: default

  指定可能な値: [ "default", "evict-bin", "evict-ln", "keep-hot", "make-cold", "unchanged" ]

  実行される操作に使用するインメモリー・キャッシュ・モードを指定します。
• ds-cfg-db-cache-percent(optional): integer(int32)
  データベース・キャッシュに割り当てるJVMメモリーのパーセンテージを指定します。
• ds-cfg-db-cache-size(optional): string
  デフォルト値: 0 MB

  データベース・キャッシュに割り当てるJVMメモリーの量。
• ds-cfg-db-checkpointer-bytes-interval(optional): string
  デフォルト値: 20mb

  強制的にチェックポイントを実行させられる前にデータベースに書き込むことのできる最大バイト数を指定します。
• ds-cfg-db-checkpointer-wakeup-interval(optional): string
  デフォルト値: 30s

  チェックポイント間の最長時間を指定します。
• ds-cfg-db-cleaner-min-utilization(optional): integer(int32)
  デフォルト値: 50

  データベース消去プログラムがデータベース・ログ・ファイルに保持する実データの最小パーセンテージを指定します。
• ds-cfg-db-directory: string
  デフォルト値: db

  このバックエンドのデータを含むBerkeley DB Java Editionデータベース・ファイルの保持に使用されるファイル・システム・・ディレクトリのパスを指定します。
• ds-cfg-db-directory-permissions(optional): string
  デフォルト値: 700

  サーバー・データベース・ファイルが含まれるディレクトリに適用する必要がある権限を指定します。
• ds-cfg-db-evictor-lru-only(optional): boolean
  デフォルト値: true

  データベースがLRUポリシー(最も長い間使用されていない情報が最初に破棄される)に基づいて既存データをキャッシュから破棄する必要があるかどうかを示します。
• ds-cfg-db-evictor-nodes-per-scan(optional): integer(int32)
  デフォルト値: 10

  新しい情報用の領域を確保するために既存のデータを解放する必要があると判断した場合に、1回にキャッシュから破棄するBtreeノードの数を指定します。
• ds-cfg-db-log-file-max(optional): string
  デフォルト値: 100mb

  データベース・ログ・ファイルの最大サイズを指定します。
• ds-cfg-db-logging-file-handler-on(optional): boolean
  デフォルト値: true

  データベースがデータベース・ログ・ディレクトリと同じディレクトリにje.infoファイルを保持するかどうかを示します。
• ds-cfg-db-logging-level(optional): string
  デフォルト値: CONFIG

  データベースがje.infoファイルに情報を書き込むときに使用するログ・レベルを指定します。
• ds-cfg-db-num-cleaner-threads(optional): integer(int32)
  データベース・ログ・ファイルを望ましい使用率またはそれに近い使用率に維持するために、バックエンドが保持するスレッドの数を指定します。
• ds-cfg-db-num-lock-tables(optional): integer(int32)
  基礎となるデータベースで使用されるロック表の数を指定します。
• ds-cfg-db-run-cleaner(optional): boolean
  デフォルト値: true

  データベース消去スレッドを有効にするかどうかを示します。
• ds-cfg-db-txn-durability(optional): string
  デフォルト値: write-to-filesystem

  指定可能な値: [ "write-to-cache", "write-to-disk", "write-to-filesystem" ]

  データベース・トランザクションの永続性を指定します。
• ds-cfg-disk-full-threshold(optional): string
  デフォルト値: 20 megabytes

  データベース更新を制限するための、フル・ディスクしきい値。
• ds-cfg-disk-low-threshold(optional): string
  デフォルト値: 100 megabytes

  データベース更新を制限するための、下限ディスクしきい値。
• ds-cfg-enabled: boolean
  サーバーでワークフロー要素が使用可能かどうかを示します。
• ds-cfg-entries-compressed(optional): boolean
  デフォルト値: false

  バックエンドがエントリをデータベースに格納する前にエントリの圧縮を試みるかどうかを示します。
• ds-cfg-index-entry-limit(optional): integer(int32)
  デフォルト値: 4000

  特定の索引キーが保持されなくなるまでに、その特定の索引キーに対する照合が許可されるエントリの最大数を指定します。
• ds-cfg-index-filter-analyzer-enabled(optional): boolean
  デフォルト値: false

  索引の使用を評価する際に、ディレクトリ・サーバーで処理される検索フィルタに関する統計情報を収集するかどうかを示します。
• ds-cfg-index-subtrees(optional): boolean
  デフォルト値: true

  各親エントリの直接または間接子エントリについての情報を含むサブツリー固有データを保持するように、バックエンドがサブツリーの索引付けを行うかどうかを示します。
• ds-cfg-is-private-backend(optional): boolean
  デフォルト値: false

  バックエンドをプライベート・バックエンドとみなすかどうかを示します。このことは、バックエンドがユーザー定義情報ではなく操作データの格納に使用されることを示します。
• ds-cfg-java-class: string
  デフォルト値: org.opends.server.workflowelement.localbackend.DBLocalBackendWorkflowElement

  DBローカル・バックエンド・ワークフロー要素の実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-je-property(optional): array ds-cfg-je-property
  このバックエンドにデータを提供するBerkeley DB Java Editionデータベースのデータベース・プロパティおよび環境プロパティを指定します。
• ds-cfg-maintenance(optional): boolean
  デフォルト値: false

  サーバーのDBローカル・バックエンド・ワークフロー要素が保守モードであるかどうかを示します。
• ds-cfg-max-entries(optional): integer(int32)
  デフォルト値: 25

  保持する検索フィルタ統計の最大数。
• ds-cfg-monitor-cold-attributes(optional): boolean
  デフォルト値: false

  コールド属性使用データのコレクションおよびモニタリングを使用可能にする必要があるかどうかを示します。
• ds-cfg-preload-time-limit(optional): string
  デフォルト値: 0s

  データが初期化されるときにバックエンドがそのデータの事前ロードにかけることのできる時間を指定します。
• ds-cfg-referrals-url(optional): array ds-cfg-referrals-url
  サーバーがリクエストを完了できない場合に返されるURL。
• ds-cfg-tombstone-creation-enabled(optional): boolean
  デフォルト値: true

  エントリが削除されたときに、バックエンドがツームストンを作成する必要があるかどうかを示します。
• ds-cfg-tombstone-lifetime(optional): string
  デフォルト値: 1w

  エントリが削除された後のツームストンの保存期間を指定します。
• ds-cfg-tombstone-purge-interval(optional): string
  デフォルト値: 5m

  ツームストンのパージが再度開始される時間の間隔を指定します。
• ds-cfg-writability-mode: string
  デフォルト値: enabled

  指定可能な値: [ "disabled", "enabled", "internal-only" ]

  バックエンドが書込み操作を処理する際に使用する必要がある動作を指定します。
• objectclass: array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-enabled",
        "ds-cfg-db-directory",
        "ds-cfg-writability-mode",
        "ds-cfg-base-dn"
    ],
    "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 DB Local Backend Workflow Element implementation. ",
            "readOnly":false,
            "default":"org.opends.server.workflowelement.localbackend.DBLocalBackendWorkflowElement",
            "type":"string"
        },
        "ds-cfg-db-log-file-max":{
            "description":"Specifies the maximum size for a database log file. ",
            "readOnly":false,
            "default":"100mb",
            "type":"string"
        },
        "ds-cfg-db-directory-permissions":{
            "description":"Specifies the permissions that should be applied to the directory containing the server database files. ",
            "readOnly":false,
            "default":"700",
            "type":"string"
        },
        "ds-cfg-index-filter-analyzer-enabled":{
            "description":"Indicates whether to gather statistical information about the search filters processed by the Directory Server while evaluating the usage of indexes. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-db-checkpointer-bytes-interval":{
            "description":"Specifies the maximum number of bytes that may be written to the database before it is forced to perform a checkpoint. ",
            "readOnly":false,
            "default":"20mb",
            "type":"string"
        },
        "ds-cfg-db-cache-size":{
            "description":"The amount of JVM memory to allocate to the database cache. ",
            "readOnly":false,
            "default":"0 MB",
            "type":"string"
        },
        "ds-cfg-preload-time-limit":{
            "description":"Specifies the length of time that the backend is allowed to spend \"pre-loading\" data when it is initialized. ",
            "readOnly":false,
            "default":"0s",
            "type":"string"
        },
        "ds-cfg-db-logging-file-handler-on":{
            "description":"Indicates whether the database should maintain a je.info file in the same directory as the database log directory. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-disk-low-threshold":{
            "description":"Low disk threshold to limit database updates. ",
            "readOnly":false,
            "default":"100 megabytes",
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow Element is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-db-checkpointer-wakeup-interval":{
            "description":"Specifies the maximum length of time that may pass between checkpoints. ",
            "readOnly":false,
            "default":"30s",
            "type":"string"
        },
        "ds-cfg-db-num-lock-tables":{
            "description":"Specifies the number of lock tables that are used by the underlying database. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-max-entries":{
            "description":"The maximum number of search filter statistics to keep. ",
            "readOnly":false,
            "default":25,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-is-private-backend":{
            "description":"Indicates whether the backend should be considered a private backend, which indicates that it is used for storing operational data rather than user-defined information. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-tombstone-purge-interval":{
            "description":"Specifies the time interval after which tombstone purging is restarted. ",
            "readOnly":false,
            "default":"5m",
            "type":"string"
        },
        "ds-cfg-db-run-cleaner":{
            "description":"Indicates whether the database cleaner threads should be enabled. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-db-txn-durability":{
            "description":"Specifies the durability of database transactions. ",
            "readOnly":false,
            "default":"write-to-filesystem",
            "type":"string",
            "enum":[
                "write-to-cache",
                "write-to-disk",
                "write-to-filesystem"
            ]
        },
        "ds-cfg-entries-compressed":{
            "description":"Indicates whether the backend should attempt to compress entries before storing them in the database. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-index-entry-limit":{
            "description":"Specifies the maximum number of entries that is allowed to match a given index key before that particular index key is no longer maintained. ",
            "readOnly":false,
            "default":4000,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-compact-encoding":{
            "description":"Indicates whether the backend should use a compact form when encoding entries by compressing the attribute descriptions and object class sets. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-referrals-url":{
            "description":"The URLs that should be returned when the server is not able to fulfill the requests. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-db-directory":{
            "description":"Specifies the path to the filesystem directory that is used to hold the Berkeley DB Java Edition database files containing the data for this backend. ",
            "readOnly":false,
            "default":"db",
            "type":"string"
        },
        "ds-cfg-compact-attribute-values-using-tokens":{
            "description":"Indicates the list of attributes that the server should compact using token instead of values. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-db-cache-mode":{
            "description":"Specifies the in-memory cache mode used for operations performed. ",
            "readOnly":false,
            "default":"default",
            "type":"string",
            "enum":[
                "default",
                "evict-bin",
                "evict-ln",
                "keep-hot",
                "make-cold",
                "unchanged"
            ]
        },
        "ds-cfg-je-property":{
            "description":"Specifies the database and environment properties for the Berkeley DB Java Edition database serving the data for this backend. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-writability-mode":{
            "description":"Specifies the behavior that the backend should use when processing write operations. ",
            "readOnly":false,
            "default":"enabled",
            "type":"string",
            "enum":[
                "disabled",
                "enabled",
                "internal-only"
            ]
        },
        "ds-cfg-db-evictor-nodes-per-scan":{
            "description":"Specifies the number of Btree nodes that should be evicted from the cache in a single pass if it is determined that it is necessary to free existing data in order to make room for new information. ",
            "readOnly":false,
            "default":10,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-disk-full-threshold":{
            "description":"Full disk threshold to limit database updates. ",
            "readOnly":false,
            "default":"20 megabytes",
            "type":"string"
        },
        "ds-cfg-tombstone-lifetime":{
            "description":"Specifies the lifetime of a tombstone after the entry has been deleted. ",
            "readOnly":false,
            "default":"1w",
            "type":"string"
        },
        "ds-cfg-base-dn":{
            "description":"Specifies the base DN(s) for the data that the backend handles. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-db-cleaner-min-utilization":{
            "description":"Specifies the minimum percentage of \"live\" data that the database cleaner attempts to keep in database log files. ",
            "readOnly":false,
            "default":50,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-db-num-cleaner-threads":{
            "description":"Specifies the number of threads that the backend should maintain to keep the database log files at or near the desired utilization. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-db-evictor-lru-only":{
            "description":"Indicates whether the database should evict existing data from the cache based on an LRU policy (where the least recently used information will be evicted first). ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-monitor-cold-attributes":{
            "description":"Indicates whether cold attributes usage data collection and monitoring should be enabled. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-db-logging-level":{
            "description":"Specifies the log level that should be used by the database when it is writing information into the je.info file. ",
            "readOnly":false,
            "default":"CONFIG",
            "type":"string"
        },
        "ds-cfg-index-subtrees":{
            "description":"Indicates whether or not the backend should index subtrees to maintain subtree specific data retaining information on direct and indirect children entries of each parent entry. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-maintenance":{
            "description":"Indicates whether the server DB Local Backend Workflow Element is in maintenance mode. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-db-cache-percent":{
            "description":"Specifies the percentage of JVM memory to allocate to the database cache. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-cold-attribute":{
            "description":"Enables attribute level caching by specifying one or more LDAP attributes that should be considered cache cold by backend storage, retrieval and caching mechanisms and maintained in the cold storage. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-tombstone-creation-enabled":{
            "description":"Indicates whether the backend should create a tombstone when an entry is deleted. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        }
    }
}

ネストされたスキーマ: ds-cfg-base-dn

型: array

バックエンドが処理するデータのベースDNを指定します。

ソースを表示

• [0]: string

{
    "description":"Specifies the base DN(s) for the data that the backend handles. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-cold-attribute

型: array

バックエンド記憶域、取得およびキャッシュのメカニズムによってキャッシュがコールドとみなされ、コールド記憶域で保持される必要がある1つ以上のLDAP属性を指定することによって、属性レベルのキャッシュを有効化します。

ソースを表示

• [0]: string

{
    "description":"Enables attribute level caching by specifying one or more LDAP attributes that should be considered cache cold by backend storage, retrieval and caching mechanisms and maintained in the cold storage. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-compact-attribute-values-using-tokens

型: array

値ではなくトークンを使用してサーバーが圧縮する必要がある属性のリストを示します。

ソースを表示

• [0]: string

{
    "description":"Indicates the list of attributes that the server should compact using token instead of values. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

このバックエンドにデータを提供するBerkeley DB Java Editionデータベースのデータベース・プロパティおよび環境プロパティを指定します。

ソースを表示

• [0]: string

{
    "description":"Specifies the database and environment properties for the Berkeley DB Java Edition database serving the data for this backend. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-referrals-url

型: array

サーバーがリクエストを完了できない場合に返されるURL。

ソースを表示

• [0]: string

{
    "description":"The URLs that should be returned when the server is not able to fulfill the requests. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

• [0]: string

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

201レスポンス

作成済

本文 ()

ルート・スキーマ: DBローカル・バックエンド・ワークフロー要素のADDResponse

型: object

ソースを表示

• msgType: string
  デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:AddResponse

  RESTメッセージ・タイプ
• searchResultEntries: array searchResultEntries
• 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:AddResponse",
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/DB Local Backend Workflow Element SearchResultEntry"
            }
        }
    }
}

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

型: array

ソースを表示

• [0]: object DBローカル・バックエンド・ワークフロー要素のSearchResultEntry

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/DB Local Backend Workflow Element SearchResultEntry"
    }
}

ネストされたスキーマ: DBローカル・バックエンド・ワークフロー要素のSearchResultEntry

型: object

ソースを表示

• attributes: object DBローカル・バックエンド・ワークフロー要素のプロパティ
• 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/DB Local Backend Workflow Element Properties"
        }
    }
}

ネストされたスキーマ: DBローカル・バックエンド・ワークフロー要素のプロパティ

型: object

ソースを表示

• cn(optional): string
  エントリのCN (共通名)
• ds-cfg-base-dn: array ds-cfg-base-dn
  バックエンドが処理するデータのベースDNを指定します。
• ds-cfg-cold-attribute(optional): array ds-cfg-cold-attribute
  バックエンド記憶域、取得およびキャッシュのメカニズムによってキャッシュがコールドとみなされ、コールド記憶域で保持される必要がある1つ以上のLDAP属性を指定することによって、属性レベルのキャッシュを有効化します。
• ds-cfg-compact-attribute-values-using-tokens(optional): array ds-cfg-compact-attribute-values-using-tokens
  値ではなくトークンを使用してサーバーが圧縮する必要がある属性のリストを示します。
• ds-cfg-compact-encoding(optional): boolean
  デフォルト値: true

  バックエンドが属性の説明とオブジェクト・クラス・セットを圧縮することでエントリをエンコードするときに、圧縮形式を使用する必要があるかどうかを示します。
• ds-cfg-db-cache-mode(optional): string
  デフォルト値: default

  指定可能な値: [ "default", "evict-bin", "evict-ln", "keep-hot", "make-cold", "unchanged" ]

  実行される操作に使用するインメモリー・キャッシュ・モードを指定します。
• ds-cfg-db-cache-percent(optional): integer(int32)
  データベース・キャッシュに割り当てるJVMメモリーのパーセンテージを指定します。
• ds-cfg-db-cache-size(optional): string
  デフォルト値: 0 MB

  データベース・キャッシュに割り当てるJVMメモリーの量。
• ds-cfg-db-checkpointer-bytes-interval(optional): string
  デフォルト値: 20mb

  強制的にチェックポイントを実行させられる前にデータベースに書き込むことのできる最大バイト数を指定します。
• ds-cfg-db-checkpointer-wakeup-interval(optional): string
  デフォルト値: 30s

  チェックポイント間の最長時間を指定します。
• ds-cfg-db-cleaner-min-utilization(optional): integer(int32)
  デフォルト値: 50

  データベース消去プログラムがデータベース・ログ・ファイルに保持する実データの最小パーセンテージを指定します。
• ds-cfg-db-directory: string
  デフォルト値: db

  このバックエンドのデータを含むBerkeley DB Java Editionデータベース・ファイルの保持に使用されるファイル・システム・・ディレクトリのパスを指定します。
• ds-cfg-db-directory-permissions(optional): string
  デフォルト値: 700

  サーバー・データベース・ファイルが含まれるディレクトリに適用する必要がある権限を指定します。
• ds-cfg-db-evictor-lru-only(optional): boolean
  デフォルト値: true

  データベースがLRUポリシー(最も長い間使用されていない情報が最初に破棄される)に基づいて既存データをキャッシュから破棄する必要があるかどうかを示します。
• ds-cfg-db-evictor-nodes-per-scan(optional): integer(int32)
  デフォルト値: 10

  新しい情報用の領域を確保するために既存のデータを解放する必要があると判断した場合に、1回にキャッシュから破棄するBtreeノードの数を指定します。
• ds-cfg-db-log-file-max(optional): string
  デフォルト値: 100mb

  データベース・ログ・ファイルの最大サイズを指定します。
• ds-cfg-db-logging-file-handler-on(optional): boolean
  デフォルト値: true

  データベースがデータベース・ログ・ディレクトリと同じディレクトリにje.infoファイルを保持するかどうかを示します。
• ds-cfg-db-logging-level(optional): string
  デフォルト値: CONFIG

  データベースがje.infoファイルに情報を書き込むときに使用するログ・レベルを指定します。
• ds-cfg-db-num-cleaner-threads(optional): integer(int32)
  データベース・ログ・ファイルを望ましい使用率またはそれに近い使用率に維持するために、バックエンドが保持するスレッドの数を指定します。
• ds-cfg-db-num-lock-tables(optional): integer(int32)
  基礎となるデータベースで使用されるロック表の数を指定します。
• ds-cfg-db-run-cleaner(optional): boolean
  デフォルト値: true

  データベース消去スレッドを有効にするかどうかを示します。
• ds-cfg-db-txn-durability(optional): string
  デフォルト値: write-to-filesystem

  指定可能な値: [ "write-to-cache", "write-to-disk", "write-to-filesystem" ]

  データベース・トランザクションの永続性を指定します。
• ds-cfg-disk-full-threshold(optional): string
  デフォルト値: 20 megabytes

  データベース更新を制限するための、フル・ディスクしきい値。
• ds-cfg-disk-low-threshold(optional): string
  デフォルト値: 100 megabytes

  データベース更新を制限するための、下限ディスクしきい値。
• ds-cfg-enabled: boolean
  サーバーでワークフロー要素が使用可能かどうかを示します。
• ds-cfg-entries-compressed(optional): boolean
  デフォルト値: false

  バックエンドがエントリをデータベースに格納する前にエントリの圧縮を試みるかどうかを示します。
• ds-cfg-index-entry-limit(optional): integer(int32)
  デフォルト値: 4000

  特定の索引キーが保持されなくなるまでに、その特定の索引キーに対する照合が許可されるエントリの最大数を指定します。
• ds-cfg-index-filter-analyzer-enabled(optional): boolean
  デフォルト値: false

  索引の使用を評価する際に、ディレクトリ・サーバーで処理される検索フィルタに関する統計情報を収集するかどうかを示します。
• ds-cfg-index-subtrees(optional): boolean
  デフォルト値: true

  各親エントリの直接または間接子エントリについての情報を含むサブツリー固有データを保持するように、バックエンドがサブツリーの索引付けを行うかどうかを示します。
• ds-cfg-is-private-backend(optional): boolean
  デフォルト値: false

  バックエンドをプライベート・バックエンドとみなすかどうかを示します。このことは、バックエンドがユーザー定義情報ではなく操作データの格納に使用されることを示します。
• ds-cfg-java-class: string
  デフォルト値: org.opends.server.workflowelement.localbackend.DBLocalBackendWorkflowElement

  DBローカル・バックエンド・ワークフロー要素の実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-je-property(optional): array ds-cfg-je-property
  このバックエンドにデータを提供するBerkeley DB Java Editionデータベースのデータベース・プロパティおよび環境プロパティを指定します。
• ds-cfg-maintenance(optional): boolean
  デフォルト値: false

  サーバーのDBローカル・バックエンド・ワークフロー要素が保守モードであるかどうかを示します。
• ds-cfg-max-entries(optional): integer(int32)
  デフォルト値: 25

  保持する検索フィルタ統計の最大数。
• ds-cfg-monitor-cold-attributes(optional): boolean
  デフォルト値: false

  コールド属性使用データのコレクションおよびモニタリングを使用可能にする必要があるかどうかを示します。
• ds-cfg-preload-time-limit(optional): string
  デフォルト値: 0s

  データが初期化されるときにバックエンドがそのデータの事前ロードにかけることのできる時間を指定します。
• ds-cfg-referrals-url(optional): array ds-cfg-referrals-url
  サーバーがリクエストを完了できない場合に返されるURL。
• ds-cfg-tombstone-creation-enabled(optional): boolean
  デフォルト値: true

  エントリが削除されたときに、バックエンドがツームストンを作成する必要があるかどうかを示します。
• ds-cfg-tombstone-lifetime(optional): string
  デフォルト値: 1w

  エントリが削除された後のツームストンの保存期間を指定します。
• ds-cfg-tombstone-purge-interval(optional): string
  デフォルト値: 5m

  ツームストンのパージが再度開始される時間の間隔を指定します。
• ds-cfg-writability-mode: string
  デフォルト値: enabled

  指定可能な値: [ "disabled", "enabled", "internal-only" ]

  バックエンドが書込み操作を処理する際に使用する必要がある動作を指定します。
• objectclass: array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-enabled",
        "ds-cfg-db-directory",
        "ds-cfg-writability-mode",
        "ds-cfg-base-dn"
    ],
    "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 DB Local Backend Workflow Element implementation. ",
            "readOnly":false,
            "default":"org.opends.server.workflowelement.localbackend.DBLocalBackendWorkflowElement",
            "type":"string"
        },
        "ds-cfg-db-log-file-max":{
            "description":"Specifies the maximum size for a database log file. ",
            "readOnly":false,
            "default":"100mb",
            "type":"string"
        },
        "ds-cfg-db-directory-permissions":{
            "description":"Specifies the permissions that should be applied to the directory containing the server database files. ",
            "readOnly":false,
            "default":"700",
            "type":"string"
        },
        "ds-cfg-index-filter-analyzer-enabled":{
            "description":"Indicates whether to gather statistical information about the search filters processed by the Directory Server while evaluating the usage of indexes. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-db-checkpointer-bytes-interval":{
            "description":"Specifies the maximum number of bytes that may be written to the database before it is forced to perform a checkpoint. ",
            "readOnly":false,
            "default":"20mb",
            "type":"string"
        },
        "ds-cfg-db-cache-size":{
            "description":"The amount of JVM memory to allocate to the database cache. ",
            "readOnly":false,
            "default":"0 MB",
            "type":"string"
        },
        "ds-cfg-preload-time-limit":{
            "description":"Specifies the length of time that the backend is allowed to spend \"pre-loading\" data when it is initialized. ",
            "readOnly":false,
            "default":"0s",
            "type":"string"
        },
        "ds-cfg-db-logging-file-handler-on":{
            "description":"Indicates whether the database should maintain a je.info file in the same directory as the database log directory. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-disk-low-threshold":{
            "description":"Low disk threshold to limit database updates. ",
            "readOnly":false,
            "default":"100 megabytes",
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Workflow Element is enabled for use in the server. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-db-checkpointer-wakeup-interval":{
            "description":"Specifies the maximum length of time that may pass between checkpoints. ",
            "readOnly":false,
            "default":"30s",
            "type":"string"
        },
        "ds-cfg-db-num-lock-tables":{
            "description":"Specifies the number of lock tables that are used by the underlying database. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-max-entries":{
            "description":"The maximum number of search filter statistics to keep. ",
            "readOnly":false,
            "default":25,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-is-private-backend":{
            "description":"Indicates whether the backend should be considered a private backend, which indicates that it is used for storing operational data rather than user-defined information. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-tombstone-purge-interval":{
            "description":"Specifies the time interval after which tombstone purging is restarted. ",
            "readOnly":false,
            "default":"5m",
            "type":"string"
        },
        "ds-cfg-db-run-cleaner":{
            "description":"Indicates whether the database cleaner threads should be enabled. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-db-txn-durability":{
            "description":"Specifies the durability of database transactions. ",
            "readOnly":false,
            "default":"write-to-filesystem",
            "type":"string",
            "enum":[
                "write-to-cache",
                "write-to-disk",
                "write-to-filesystem"
            ]
        },
        "ds-cfg-entries-compressed":{
            "description":"Indicates whether the backend should attempt to compress entries before storing them in the database. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-index-entry-limit":{
            "description":"Specifies the maximum number of entries that is allowed to match a given index key before that particular index key is no longer maintained. ",
            "readOnly":false,
            "default":4000,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-compact-encoding":{
            "description":"Indicates whether the backend should use a compact form when encoding entries by compressing the attribute descriptions and object class sets. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-referrals-url":{
            "description":"The URLs that should be returned when the server is not able to fulfill the requests. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-db-directory":{
            "description":"Specifies the path to the filesystem directory that is used to hold the Berkeley DB Java Edition database files containing the data for this backend. ",
            "readOnly":false,
            "default":"db",
            "type":"string"
        },
        "ds-cfg-compact-attribute-values-using-tokens":{
            "description":"Indicates the list of attributes that the server should compact using token instead of values. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-db-cache-mode":{
            "description":"Specifies the in-memory cache mode used for operations performed. ",
            "readOnly":false,
            "default":"default",
            "type":"string",
            "enum":[
                "default",
                "evict-bin",
                "evict-ln",
                "keep-hot",
                "make-cold",
                "unchanged"
            ]
        },
        "ds-cfg-je-property":{
            "description":"Specifies the database and environment properties for the Berkeley DB Java Edition database serving the data for this backend. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-writability-mode":{
            "description":"Specifies the behavior that the backend should use when processing write operations. ",
            "readOnly":false,
            "default":"enabled",
            "type":"string",
            "enum":[
                "disabled",
                "enabled",
                "internal-only"
            ]
        },
        "ds-cfg-db-evictor-nodes-per-scan":{
            "description":"Specifies the number of Btree nodes that should be evicted from the cache in a single pass if it is determined that it is necessary to free existing data in order to make room for new information. ",
            "readOnly":false,
            "default":10,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-disk-full-threshold":{
            "description":"Full disk threshold to limit database updates. ",
            "readOnly":false,
            "default":"20 megabytes",
            "type":"string"
        },
        "ds-cfg-tombstone-lifetime":{
            "description":"Specifies the lifetime of a tombstone after the entry has been deleted. ",
            "readOnly":false,
            "default":"1w",
            "type":"string"
        },
        "ds-cfg-base-dn":{
            "description":"Specifies the base DN(s) for the data that the backend handles. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-db-cleaner-min-utilization":{
            "description":"Specifies the minimum percentage of \"live\" data that the database cleaner attempts to keep in database log files. ",
            "readOnly":false,
            "default":50,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-db-num-cleaner-threads":{
            "description":"Specifies the number of threads that the backend should maintain to keep the database log files at or near the desired utilization. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-db-evictor-lru-only":{
            "description":"Indicates whether the database should evict existing data from the cache based on an LRU policy (where the least recently used information will be evicted first). ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-monitor-cold-attributes":{
            "description":"Indicates whether cold attributes usage data collection and monitoring should be enabled. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-db-logging-level":{
            "description":"Specifies the log level that should be used by the database when it is writing information into the je.info file. ",
            "readOnly":false,
            "default":"CONFIG",
            "type":"string"
        },
        "ds-cfg-index-subtrees":{
            "description":"Indicates whether or not the backend should index subtrees to maintain subtree specific data retaining information on direct and indirect children entries of each parent entry. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-maintenance":{
            "description":"Indicates whether the server DB Local Backend Workflow Element is in maintenance mode. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-db-cache-percent":{
            "description":"Specifies the percentage of JVM memory to allocate to the database cache. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-cold-attribute":{
            "description":"Enables attribute level caching by specifying one or more LDAP attributes that should be considered cache cold by backend storage, retrieval and caching mechanisms and maintained in the cold storage. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-tombstone-creation-enabled":{
            "description":"Indicates whether the backend should create a tombstone when an entry is deleted. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        }
    }
}

ネストされたスキーマ: ds-cfg-base-dn

型: array

バックエンドが処理するデータのベースDNを指定します。

ソースを表示

• [0]: string

{
    "description":"Specifies the base DN(s) for the data that the backend handles. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-cold-attribute

型: array

バックエンド記憶域、取得およびキャッシュのメカニズムによってキャッシュがコールドとみなされ、コールド記憶域で保持される必要がある1つ以上のLDAP属性を指定することによって、属性レベルのキャッシュを有効化します。

ソースを表示

• [0]: string

{
    "description":"Enables attribute level caching by specifying one or more LDAP attributes that should be considered cache cold by backend storage, retrieval and caching mechanisms and maintained in the cold storage. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-compact-attribute-values-using-tokens

型: array

値ではなくトークンを使用してサーバーが圧縮する必要がある属性のリストを示します。

ソースを表示

• [0]: string

{
    "description":"Indicates the list of attributes that the server should compact using token instead of values. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

このバックエンドにデータを提供するBerkeley DB Java Editionデータベースのデータベース・プロパティおよび環境プロパティを指定します。

ソースを表示

• [0]: string

{
    "description":"Specifies the database and environment properties for the Berkeley DB Java Edition database serving the data for this backend. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-referrals-url

型: array

サーバーがリクエストを完了できない場合に返されるURL。

ソースを表示

• [0]: string

{
    "description":"The URLs that should be returned when the server is not able to fulfill the requests. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

• [0]: string

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

204レスポンス

コンテンツがありません

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."
        }
    }
}

先頭に戻る