POST
/rest/v1/admin
グローバル索引カタログ共有キャッシュ拡張機能の追加、検索、比較または削除
リクエスト
サポートされているメディア・タイプ
- application/json
本文 ()
作成する必要があるグローバル索引カタログ共有キャッシュ拡張機能
ルート・スキーマ: グローバル索引カタログ共有キャッシュ拡張機能のPOSTRequest
型:
ソースを表示
object
- assertion(optional): string
LDAP比較操作用のアサーション文字列。注意: POSTを使用したLDAP比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。
- attributes(optional): object グローバル索引カタログ共有キャッシュ拡張機能のプロパティ
- 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/Global Index Catalogs Shared Cache Extension 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"
}
}
}
ネストされたスキーマ: グローバル索引カタログ共有キャッシュ拡張機能のプロパティ
型:
ソースを表示
object
- cn(optional): string
エントリのCN (共通名)
- ds-cfg-db-cache-percent(optional): integer(int32)
デフォルト値:
40
データベース・キャッシュに割り当てるJVMメモリーのパーセンテージを指定します。 - ds-cfg-db-cache-size(optional): string
デフォルト値:
0 MB
データベース・キャッシュに割り当てるJVMメモリーの量。 - 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-enabled: boolean
拡張機能が使用可能かどうかを示します。
- ds-cfg-java-class: string
デフォルト値:
com.sun.dps.server.globalindex.GlobalIndexCatalogsSharedCacheConfigManager
グローバル索引カタログ共有キャッシュ拡張機能の実装を提供するJavaクラスの完全修飾名を指定します。 - objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
{
"type":"object",
"required":[
"objectclass",
"ds-cfg-java-class",
"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 Global Index Catalogs Shared Cache Extension implementation. ",
"readOnly":false,
"default":"com.sun.dps.server.globalindex.GlobalIndexCatalogsSharedCacheConfigManager",
"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-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-enabled":{
"description":"Indicates whether the Extension is enabled. ",
"readOnly":false,
"type":"boolean"
},
"ds-cfg-db-cache-percent":{
"description":"Specifies the percentage of JVM memory to allocate to the database cache. ",
"readOnly":false,
"default":40,
"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"
}
}
}
ネストされたスキーマ: controls
型:
array
LDAP操作のためにサーバーに送信するLDAP制御。
ソースを表示
{
"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である場合)にのみ使用します。
ソースを表示
{
"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"
}
}
ネストされたスキーマ: objectclass
型:
array
このエントリが属するオブジェクト・クラス。
ソースを表示
{
"type":"array",
"description":"Objectclass(es) which this entry belongs to.",
"items":{
"type":"string"
}
}
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
OK
本文 ()
ルート・スキーマ: グローバル索引カタログ共有キャッシュ拡張機能の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/Global Index Catalogs Shared Cache Extension SearchResultEntry"
}
},
"compareResult":{
"description":"Indicates the result of LDAP compare operation.",
"type":"boolean"
}
}
}
ネストされたスキーマ: searchResultEntries
型:
array
LDAP操作後に返される検索結果エントリの数。
ソースを表示
{
"type":"array",
"description":"Number of search result entries returned after the LDAP operation.",
"items":{
"$ref":"#/definitions/Global Index Catalogs Shared Cache Extension 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/Global Index Catalogs Shared Cache Extension Properties"
}
}
}
ネストされたスキーマ: グローバル索引カタログ共有キャッシュ拡張機能のプロパティ
型:
ソースを表示
object
- cn(optional): string
エントリのCN (共通名)
- ds-cfg-db-cache-percent(optional): integer(int32)
デフォルト値:
40
データベース・キャッシュに割り当てるJVMメモリーのパーセンテージを指定します。 - ds-cfg-db-cache-size(optional): string
デフォルト値:
0 MB
データベース・キャッシュに割り当てるJVMメモリーの量。 - 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-enabled: boolean
拡張機能が使用可能かどうかを示します。
- ds-cfg-java-class: string
デフォルト値:
com.sun.dps.server.globalindex.GlobalIndexCatalogsSharedCacheConfigManager
グローバル索引カタログ共有キャッシュ拡張機能の実装を提供するJavaクラスの完全修飾名を指定します。 - objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
{
"type":"object",
"required":[
"objectclass",
"ds-cfg-java-class",
"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 Global Index Catalogs Shared Cache Extension implementation. ",
"readOnly":false,
"default":"com.sun.dps.server.globalindex.GlobalIndexCatalogsSharedCacheConfigManager",
"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-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-enabled":{
"description":"Indicates whether the Extension is enabled. ",
"readOnly":false,
"type":"boolean"
},
"ds-cfg-db-cache-percent":{
"description":"Specifies the percentage of JVM memory to allocate to the database cache. ",
"readOnly":false,
"default":40,
"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"
}
}
}
ネストされたスキーマ: objectclass
型:
array
このエントリが属するオブジェクト・クラス。
ソースを表示
{
"type":"array",
"description":"Objectclass(es) which this entry belongs to.",
"items":{
"type":"string"
}
}
201レスポンス
作成済
本文 ()
ルート・スキーマ: グローバル索引カタログ共有キャッシュ拡張機能の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/Global Index Catalogs Shared Cache Extension SearchResultEntry"
}
}
}
}
ネストされたスキーマ: searchResultEntries
型:
ソースを表示
array
{
"type":"array",
"items":{
"$ref":"#/definitions/Global Index Catalogs Shared Cache Extension 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/Global Index Catalogs Shared Cache Extension Properties"
}
}
}
ネストされたスキーマ: グローバル索引カタログ共有キャッシュ拡張機能のプロパティ
型:
ソースを表示
object
- cn(optional): string
エントリのCN (共通名)
- ds-cfg-db-cache-percent(optional): integer(int32)
デフォルト値:
40
データベース・キャッシュに割り当てるJVMメモリーのパーセンテージを指定します。 - ds-cfg-db-cache-size(optional): string
デフォルト値:
0 MB
データベース・キャッシュに割り当てるJVMメモリーの量。 - 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-enabled: boolean
拡張機能が使用可能かどうかを示します。
- ds-cfg-java-class: string
デフォルト値:
com.sun.dps.server.globalindex.GlobalIndexCatalogsSharedCacheConfigManager
グローバル索引カタログ共有キャッシュ拡張機能の実装を提供するJavaクラスの完全修飾名を指定します。 - objectclass: array objectclass
このエントリが属するオブジェクト・クラス。
{
"type":"object",
"required":[
"objectclass",
"ds-cfg-java-class",
"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 Global Index Catalogs Shared Cache Extension implementation. ",
"readOnly":false,
"default":"com.sun.dps.server.globalindex.GlobalIndexCatalogsSharedCacheConfigManager",
"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-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-enabled":{
"description":"Indicates whether the Extension is enabled. ",
"readOnly":false,
"type":"boolean"
},
"ds-cfg-db-cache-percent":{
"description":"Specifies the percentage of JVM memory to allocate to the database cache. ",
"readOnly":false,
"default":40,
"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"
}
}
}
ネストされたスキーマ: objectclass
型:
array
このエントリが属するオブジェクト・クラス。
ソースを表示
{
"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."
}
}
}