ジャンプ先

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

ファイル・ベースHTTPアクセス・ログ・パブリッシャの追加、検索、比較または削除

POST

/rest/v1/admin

ファイル・ベースHTTPアクセス・ログ・パブリッシャの追加、検索、比較または削除

リクエスト

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

• application/json

本文 ()

作成する必要があるファイル・ベースHTTPアクセス・ログ・パブリッシャ

ルート・スキーマ: ファイル・ベースHTTPアクセス・ログ・パブリッシャのPOSTRequest

型: object

ソースを表示

• assertion: string
  LDAP比較操作用のアサーション文字列。ノート: POSTを使用したLDAP比較操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:CompareRequestである場合)にのみ使用します。
• attributes: object ファイル・ベースHTTPアクセス・ログ・パブリッシャのプロパティ
• base: string
  LDAP検索操作に使用する検索ベースDN。ノート: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。このような操作の場合も必須です
• controls: array controls
  LDAP操作のためにサーバーに送信するLDAP制御。
• dn: 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: string
  LDAP検索操作用の検索フィルタ。LDAP検索フィルタの構文に従う必要があります。ノート: POSTリクエストを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
• msgType(required): 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: array requiredAttributes
  エントリに対してフェッチする属性のリスト。ノート: POSTを使用したLDAP検索操作の実行時(つまり、msgTypeがurn:ietf:params:rest:schemas:oracle:oud:1.0:SearchRequestである場合)にのみ使用します。
• scope: 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/File Based HTTP Access Log Publisher 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"
        }
    }
}

ネストされたスキーマ: ファイル・ベースHTTPアクセス・ログ・パブリッシャのプロパティ

型: object

ソースを表示

• cn: string
  エントリのCN (共通名)
• ds-cfg-access-log-format-mode: string
  デフォルト値: nsca

  使用可能な: [ "nsca", "w3c" ]

  ファイル・ベースHTTPアクセス・ログ・パブリッシャは、標準のアクセス・ログ形式をサポートしています。次のいずれかになります: 1) nsca 2) extended
• ds-cfg-append: boolean
  デフォルト値: true

  既存のログ・ファイルに追加するかどうかを指定します。
• ds-cfg-asynchronous(required): boolean
  デフォルト値: true

  ファイル・ベースHTTPアクセス・ログ・パブリッシャでレコードを非同期的に公開するかどうかを示します。
• ds-cfg-auto-flush: boolean
  デフォルト値: true

  ログ・レコードを書き込むたびに、ライターをフラッシュするかどうかを指定します。
• ds-cfg-buffer-size: string
  デフォルト値: 64kb

  ログ・ファイル・バッファのサイズを指定します。
• ds-cfg-enabled(required): boolean
  ログ・パブリッシャが使用可能かどうかを示します。
• ds-cfg-http-access-log-formatting-text: string
  デフォルト値: common

  ログ・レコードをフォーマットしてHTTPアクセス・ログに書き込む方法を指定します。
• ds-cfg-java-class(required): string
  デフォルト値: org.opends.server.loggers.http.TextHTTPAccessLogPublisher

  ファイル・ベースHTTPアクセス・ログ・パブリッシャの実装を提供するJavaクラスの完全修飾名。
• ds-cfg-log-controls: boolean
  デフォルト値: false

  クライアント・アプリケーションによってリクエストされた操作とともにリクエスト制御およびレスポンス制御をログに記録する必要があるかどうかを示します。
• ds-cfg-log-date-time-format: string
  デフォルト値: [dd/MMM/yyyy:HH:mm:ss Z]

  ロギングの日時書式を指定します。
• ds-cfg-log-file(required): string
  ファイル・ベースHTTPアクセス・ログ・パブリッシャによって生成されたログ・ファイルに使用されるファイル名。ファイルへのパスは、サーバー・ルートに対して相対的です。
• ds-cfg-log-file-permissions(required): string
  デフォルト値: 640

  このファイル・ベースHTTPアクセス・ログ・パブリッシャで作成されたログ・ファイルのUNIXアクセス権。
• ds-cfg-log-file-use-local-time: boolean
  デフォルト値: false

  ローテーションされるファイルの名前にローカル時間とGMTのどちらを使用するかを指定します。
• ds-cfg-operations-to-log: array ds-cfg-operations-to-log
  ログに記録する操作を示します。
• ds-cfg-queue-size: integer(int32)
  デフォルト値: 5000

  非同期キューに格納できる最大ログ・レコード数。
• ds-cfg-retention-policy: array ds-cfg-retention-policy
  ファイル・ベースHTTPアクセス・ログ・パブリッシャに使用する保持ポリシー。
• ds-cfg-rotation-policy: array ds-cfg-rotation-policy
  ファイル・ベースHTTPアクセス・ログ・パブリッシャに使用するローテーション・ポリシー。
• ds-cfg-time-interval: string
  デフォルト値: 5s

  ログ・ファイルをローテーションする必要があるかどうかを確認する間隔を指定します。
• objectclass(required): array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-enabled",
        "ds-cfg-asynchronous",
        "ds-cfg-log-file",
        "ds-cfg-log-file-permissions"
    ],
    "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":"The fully-qualified name of the Java class that provides the File Based HTTP Access Log Publisher implementation. ",
            "readOnly":false,
            "default":"org.opends.server.loggers.http.TextHTTPAccessLogPublisher",
            "type":"string"
        },
        "ds-cfg-log-file-use-local-time":{
            "description":"Specifies whether to use local time or GMT for the name of the rotated files. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-rotation-policy":{
            "description":"The rotation policy to use for the File Based HTTP Access Log Publisher . ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-buffer-size":{
            "description":"Specifies the log file buffer size. ",
            "readOnly":false,
            "default":"64kb",
            "type":"string"
        },
        "ds-cfg-http-access-log-formatting-text":{
            "description":"Specifies how log records should be formatted and written to the HTTP access log. ",
            "readOnly":false,
            "default":"common",
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Log Publisher is enabled for use. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-operations-to-log":{
            "description":"Indicates which operations has to be logged. ",
            "readOnly":false,
            "default":[
                "administration",
                "user",
                "adminbrowsing"
            ],
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "adminbrowsing",
                "administration",
                "all",
                "user"
            ]
        },
        "ds-cfg-access-log-format-mode":{
            "description":"The File Based HTTP Access Log Publisher supports standard access log formats. It can be one of the following: 1) nsca 2) extended ",
            "readOnly":false,
            "default":"nsca",
            "type":"string",
            "enum":[
                "nsca",
                "w3c"
            ]
        },
        "ds-cfg-log-date-time-format":{
            "description":"Specifies the date time format for logging. ",
            "readOnly":false,
            "default":"[dd/MMM/yyyy:HH:mm:ss Z]",
            "type":"string"
        },
        "ds-cfg-asynchronous":{
            "description":"Indicates whether the File Based HTTP Access Log Publisher will publish records asynchronously. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-auto-flush":{
            "description":"Specifies whether to flush the writer after every log record. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-queue-size":{
            "description":"The maximum number of log records that can be stored in the asynchronous queue. ",
            "readOnly":false,
            "default":"5000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-time-interval":{
            "description":"Specifies the interval at which to check whether the log files need to be rotated. ",
            "readOnly":false,
            "default":"5s",
            "type":"string"
        },
        "ds-cfg-log-file":{
            "description":"The file name to use for the log files generated by the File Based HTTP Access Log Publisher. The path to the file is relative to the server root. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-log-controls":{
            "description":"Indicates whether the request controls and response controls should be logged along with the operations that are requested by the client applications. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-log-file-permissions":{
            "description":"The UNIX permissions of the log files created by this File Based HTTP Access Log Publisher. ",
            "readOnly":false,
            "default":"640",
            "type":"string"
        },
        "ds-cfg-append":{
            "description":"Specifies whether to append to existing log files. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-retention-policy":{
            "description":"The retention policy to use for the File Based HTTP Access Log Publisher . ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

ネストされたスキーマ: ds-cfg-operations-to-log

型: array

ログに記録する操作を示します。

デフォルト値: [ "administration", "user", "adminbrowsing" ]

使用可能な値: [ "adminbrowsing", "administration", "all", "user" ]

ソースを表示

• 配列: 文字列

{
    "description":"Indicates which operations has to be logged. ",
    "readOnly":false,
    "default":[
        "administration",
        "user",
        "adminbrowsing"
    ],
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "adminbrowsing",
        "administration",
        "all",
        "user"
    ]
}

ネストされたスキーマ: ds-cfg-retention-policy

型: array

ファイル・ベースHTTPアクセス・ログ・パブリッシャに使用する保持ポリシー。

ソースを表示

• 配列: 文字列

{
    "description":"The retention policy to use for the File Based HTTP Access Log Publisher . ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-rotation-policy

型: array

ファイル・ベースHTTPアクセス・ログ・パブリッシャに使用するローテーション・ポリシー。

ソースを表示

• 配列: 文字列

{
    "description":"The rotation policy to use for the File Based HTTP Access Log Publisher . ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

• 配列: 文字列

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

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文 ()

ルート・スキーマ: ファイル・ベースHTTPアクセス・ログ・パブリッシャのSuccessResponse

型: object

ソースを表示

• compareResult: boolean
  LDAP比較操作の結果を示します。
• msgType(required): 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(required): array searchResultEntries
  LDAP操作後に返される検索結果エントリの数。
• totalResults(required): 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/File Based HTTP Access Log Publisher SearchResultEntry"
            }
        },
        "compareResult":{
            "description":"Indicates the result of LDAP compare operation.",
            "type":"boolean"
        }
    }
}

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

型: array

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

ソースを表示

• 配列: オブジェクト ファイル・ベースHTTPアクセス・ログ・パブリッシャのSearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/File Based HTTP Access Log Publisher SearchResultEntry"
    }
}

ネストされたスキーマ: ファイル・ベースHTTPアクセス・ログ・パブリッシャのSearchResultEntry

型: object

ソースを表示

• attributes(required): object ファイル・ベースHTTPアクセス・ログ・パブリッシャのプロパティ
• dn(required): string
  作成するエントリのLDAP DN。

{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/File Based HTTP Access Log Publisher Properties"
        }
    }
}

ネストされたスキーマ: ファイル・ベースHTTPアクセス・ログ・パブリッシャのプロパティ

型: object

ソースを表示

• cn: string
  エントリのCN (共通名)
• ds-cfg-access-log-format-mode: string
  デフォルト値: nsca

  使用可能な: [ "nsca", "w3c" ]

  ファイル・ベースHTTPアクセス・ログ・パブリッシャは、標準のアクセス・ログ形式をサポートしています。次のいずれかになります: 1) nsca 2) extended
• ds-cfg-append: boolean
  デフォルト値: true

  既存のログ・ファイルに追加するかどうかを指定します。
• ds-cfg-asynchronous(required): boolean
  デフォルト値: true

  ファイル・ベースHTTPアクセス・ログ・パブリッシャでレコードを非同期的に公開するかどうかを示します。
• ds-cfg-auto-flush: boolean
  デフォルト値: true

  ログ・レコードを書き込むたびに、ライターをフラッシュするかどうかを指定します。
• ds-cfg-buffer-size: string
  デフォルト値: 64kb

  ログ・ファイル・バッファのサイズを指定します。
• ds-cfg-enabled(required): boolean
  ログ・パブリッシャが使用可能かどうかを示します。
• ds-cfg-http-access-log-formatting-text: string
  デフォルト値: common

  ログ・レコードをフォーマットしてHTTPアクセス・ログに書き込む方法を指定します。
• ds-cfg-java-class(required): string
  デフォルト値: org.opends.server.loggers.http.TextHTTPAccessLogPublisher

  ファイル・ベースHTTPアクセス・ログ・パブリッシャの実装を提供するJavaクラスの完全修飾名。
• ds-cfg-log-controls: boolean
  デフォルト値: false

  クライアント・アプリケーションによってリクエストされた操作とともにリクエスト制御およびレスポンス制御をログに記録する必要があるかどうかを示します。
• ds-cfg-log-date-time-format: string
  デフォルト値: [dd/MMM/yyyy:HH:mm:ss Z]

  ロギングの日時書式を指定します。
• ds-cfg-log-file(required): string
  ファイル・ベースHTTPアクセス・ログ・パブリッシャによって生成されたログ・ファイルに使用されるファイル名。ファイルへのパスは、サーバー・ルートに対して相対的です。
• ds-cfg-log-file-permissions(required): string
  デフォルト値: 640

  このファイル・ベースHTTPアクセス・ログ・パブリッシャで作成されたログ・ファイルのUNIXアクセス権。
• ds-cfg-log-file-use-local-time: boolean
  デフォルト値: false

  ローテーションされるファイルの名前にローカル時間とGMTのどちらを使用するかを指定します。
• ds-cfg-operations-to-log: array ds-cfg-operations-to-log
  ログに記録する操作を示します。
• ds-cfg-queue-size: integer(int32)
  デフォルト値: 5000

  非同期キューに格納できる最大ログ・レコード数。
• ds-cfg-retention-policy: array ds-cfg-retention-policy
  ファイル・ベースHTTPアクセス・ログ・パブリッシャに使用する保持ポリシー。
• ds-cfg-rotation-policy: array ds-cfg-rotation-policy
  ファイル・ベースHTTPアクセス・ログ・パブリッシャに使用するローテーション・ポリシー。
• ds-cfg-time-interval: string
  デフォルト値: 5s

  ログ・ファイルをローテーションする必要があるかどうかを確認する間隔を指定します。
• objectclass(required): array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-enabled",
        "ds-cfg-asynchronous",
        "ds-cfg-log-file",
        "ds-cfg-log-file-permissions"
    ],
    "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":"The fully-qualified name of the Java class that provides the File Based HTTP Access Log Publisher implementation. ",
            "readOnly":false,
            "default":"org.opends.server.loggers.http.TextHTTPAccessLogPublisher",
            "type":"string"
        },
        "ds-cfg-log-file-use-local-time":{
            "description":"Specifies whether to use local time or GMT for the name of the rotated files. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-rotation-policy":{
            "description":"The rotation policy to use for the File Based HTTP Access Log Publisher . ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-buffer-size":{
            "description":"Specifies the log file buffer size. ",
            "readOnly":false,
            "default":"64kb",
            "type":"string"
        },
        "ds-cfg-http-access-log-formatting-text":{
            "description":"Specifies how log records should be formatted and written to the HTTP access log. ",
            "readOnly":false,
            "default":"common",
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Log Publisher is enabled for use. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-operations-to-log":{
            "description":"Indicates which operations has to be logged. ",
            "readOnly":false,
            "default":[
                "administration",
                "user",
                "adminbrowsing"
            ],
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "adminbrowsing",
                "administration",
                "all",
                "user"
            ]
        },
        "ds-cfg-access-log-format-mode":{
            "description":"The File Based HTTP Access Log Publisher supports standard access log formats. It can be one of the following: 1) nsca 2) extended ",
            "readOnly":false,
            "default":"nsca",
            "type":"string",
            "enum":[
                "nsca",
                "w3c"
            ]
        },
        "ds-cfg-log-date-time-format":{
            "description":"Specifies the date time format for logging. ",
            "readOnly":false,
            "default":"[dd/MMM/yyyy:HH:mm:ss Z]",
            "type":"string"
        },
        "ds-cfg-asynchronous":{
            "description":"Indicates whether the File Based HTTP Access Log Publisher will publish records asynchronously. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-auto-flush":{
            "description":"Specifies whether to flush the writer after every log record. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-queue-size":{
            "description":"The maximum number of log records that can be stored in the asynchronous queue. ",
            "readOnly":false,
            "default":"5000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-time-interval":{
            "description":"Specifies the interval at which to check whether the log files need to be rotated. ",
            "readOnly":false,
            "default":"5s",
            "type":"string"
        },
        "ds-cfg-log-file":{
            "description":"The file name to use for the log files generated by the File Based HTTP Access Log Publisher. The path to the file is relative to the server root. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-log-controls":{
            "description":"Indicates whether the request controls and response controls should be logged along with the operations that are requested by the client applications. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-log-file-permissions":{
            "description":"The UNIX permissions of the log files created by this File Based HTTP Access Log Publisher. ",
            "readOnly":false,
            "default":"640",
            "type":"string"
        },
        "ds-cfg-append":{
            "description":"Specifies whether to append to existing log files. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-retention-policy":{
            "description":"The retention policy to use for the File Based HTTP Access Log Publisher . ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストされたスキーマ: ds-cfg-operations-to-log

型: array

ログに記録する操作を示します。

デフォルト値: [ "administration", "user", "adminbrowsing" ]

使用可能な値: [ "adminbrowsing", "administration", "all", "user" ]

ソースを表示

• 配列: 文字列

{
    "description":"Indicates which operations has to be logged. ",
    "readOnly":false,
    "default":[
        "administration",
        "user",
        "adminbrowsing"
    ],
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "adminbrowsing",
        "administration",
        "all",
        "user"
    ]
}

ネストされたスキーマ: ds-cfg-retention-policy

型: array

ファイル・ベースHTTPアクセス・ログ・パブリッシャに使用する保持ポリシー。

ソースを表示

• 配列: 文字列

{
    "description":"The retention policy to use for the File Based HTTP Access Log Publisher . ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-rotation-policy

型: array

ファイル・ベースHTTPアクセス・ログ・パブリッシャに使用するローテーション・ポリシー。

ソースを表示

• 配列: 文字列

{
    "description":"The rotation policy to use for the File Based HTTP Access Log Publisher . ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

• 配列: 文字列

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

201レスポンス

作成済

本文 ()

ルート・スキーマ: ファイル・ベースHTTPアクセス・ログ・パブリッシャのADDResponse

型: object

ソースを表示

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

  RESTメッセージ・タイプ
• searchResultEntries(required): array searchResultEntries
• totalResults(required): 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/File Based HTTP Access Log Publisher SearchResultEntry"
            }
        }
    }
}

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

型: array

ソースを表示

• 配列: オブジェクト ファイル・ベースHTTPアクセス・ログ・パブリッシャのSearchResultEntry

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/File Based HTTP Access Log Publisher SearchResultEntry"
    }
}

ネストされたスキーマ: ファイル・ベースHTTPアクセス・ログ・パブリッシャのSearchResultEntry

型: object

ソースを表示

• attributes(required): object ファイル・ベースHTTPアクセス・ログ・パブリッシャのプロパティ
• dn(required): string
  作成するエントリのLDAP DN。

{
    "type":"object",
    "required":[
        "dn",
        "attributes"
    ],
    "properties":{
        "dn":{
            "description":"LDAP DN of the entry to be created",
            "type":"string"
        },
        "attributes":{
            "$ref":"#/definitions/File Based HTTP Access Log Publisher Properties"
        }
    }
}

ネストされたスキーマ: ファイル・ベースHTTPアクセス・ログ・パブリッシャのプロパティ

型: object

ソースを表示

• cn: string
  エントリのCN (共通名)
• ds-cfg-access-log-format-mode: string
  デフォルト値: nsca

  使用可能な: [ "nsca", "w3c" ]

  ファイル・ベースHTTPアクセス・ログ・パブリッシャは、標準のアクセス・ログ形式をサポートしています。次のいずれかになります: 1) nsca 2) extended
• ds-cfg-append: boolean
  デフォルト値: true

  既存のログ・ファイルに追加するかどうかを指定します。
• ds-cfg-asynchronous(required): boolean
  デフォルト値: true

  ファイル・ベースHTTPアクセス・ログ・パブリッシャでレコードを非同期的に公開するかどうかを示します。
• ds-cfg-auto-flush: boolean
  デフォルト値: true

  ログ・レコードを書き込むたびに、ライターをフラッシュするかどうかを指定します。
• ds-cfg-buffer-size: string
  デフォルト値: 64kb

  ログ・ファイル・バッファのサイズを指定します。
• ds-cfg-enabled(required): boolean
  ログ・パブリッシャが使用可能かどうかを示します。
• ds-cfg-http-access-log-formatting-text: string
  デフォルト値: common

  ログ・レコードをフォーマットしてHTTPアクセス・ログに書き込む方法を指定します。
• ds-cfg-java-class(required): string
  デフォルト値: org.opends.server.loggers.http.TextHTTPAccessLogPublisher

  ファイル・ベースHTTPアクセス・ログ・パブリッシャの実装を提供するJavaクラスの完全修飾名。
• ds-cfg-log-controls: boolean
  デフォルト値: false

  クライアント・アプリケーションによってリクエストされた操作とともにリクエスト制御およびレスポンス制御をログに記録する必要があるかどうかを示します。
• ds-cfg-log-date-time-format: string
  デフォルト値: [dd/MMM/yyyy:HH:mm:ss Z]

  ロギングの日時書式を指定します。
• ds-cfg-log-file(required): string
  ファイル・ベースHTTPアクセス・ログ・パブリッシャによって生成されたログ・ファイルに使用されるファイル名。ファイルへのパスは、サーバー・ルートに対して相対的です。
• ds-cfg-log-file-permissions(required): string
  デフォルト値: 640

  このファイル・ベースHTTPアクセス・ログ・パブリッシャで作成されたログ・ファイルのUNIXアクセス権。
• ds-cfg-log-file-use-local-time: boolean
  デフォルト値: false

  ローテーションされるファイルの名前にローカル時間とGMTのどちらを使用するかを指定します。
• ds-cfg-operations-to-log: array ds-cfg-operations-to-log
  ログに記録する操作を示します。
• ds-cfg-queue-size: integer(int32)
  デフォルト値: 5000

  非同期キューに格納できる最大ログ・レコード数。
• ds-cfg-retention-policy: array ds-cfg-retention-policy
  ファイル・ベースHTTPアクセス・ログ・パブリッシャに使用する保持ポリシー。
• ds-cfg-rotation-policy: array ds-cfg-rotation-policy
  ファイル・ベースHTTPアクセス・ログ・パブリッシャに使用するローテーション・ポリシー。
• ds-cfg-time-interval: string
  デフォルト値: 5s

  ログ・ファイルをローテーションする必要があるかどうかを確認する間隔を指定します。
• objectclass(required): array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-enabled",
        "ds-cfg-asynchronous",
        "ds-cfg-log-file",
        "ds-cfg-log-file-permissions"
    ],
    "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":"The fully-qualified name of the Java class that provides the File Based HTTP Access Log Publisher implementation. ",
            "readOnly":false,
            "default":"org.opends.server.loggers.http.TextHTTPAccessLogPublisher",
            "type":"string"
        },
        "ds-cfg-log-file-use-local-time":{
            "description":"Specifies whether to use local time or GMT for the name of the rotated files. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-rotation-policy":{
            "description":"The rotation policy to use for the File Based HTTP Access Log Publisher . ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-buffer-size":{
            "description":"Specifies the log file buffer size. ",
            "readOnly":false,
            "default":"64kb",
            "type":"string"
        },
        "ds-cfg-http-access-log-formatting-text":{
            "description":"Specifies how log records should be formatted and written to the HTTP access log. ",
            "readOnly":false,
            "default":"common",
            "type":"string"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Log Publisher is enabled for use. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-operations-to-log":{
            "description":"Indicates which operations has to be logged. ",
            "readOnly":false,
            "default":[
                "administration",
                "user",
                "adminbrowsing"
            ],
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "adminbrowsing",
                "administration",
                "all",
                "user"
            ]
        },
        "ds-cfg-access-log-format-mode":{
            "description":"The File Based HTTP Access Log Publisher supports standard access log formats. It can be one of the following: 1) nsca 2) extended ",
            "readOnly":false,
            "default":"nsca",
            "type":"string",
            "enum":[
                "nsca",
                "w3c"
            ]
        },
        "ds-cfg-log-date-time-format":{
            "description":"Specifies the date time format for logging. ",
            "readOnly":false,
            "default":"[dd/MMM/yyyy:HH:mm:ss Z]",
            "type":"string"
        },
        "ds-cfg-asynchronous":{
            "description":"Indicates whether the File Based HTTP Access Log Publisher will publish records asynchronously. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-auto-flush":{
            "description":"Specifies whether to flush the writer after every log record. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-queue-size":{
            "description":"The maximum number of log records that can be stored in the asynchronous queue. ",
            "readOnly":false,
            "default":"5000",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-time-interval":{
            "description":"Specifies the interval at which to check whether the log files need to be rotated. ",
            "readOnly":false,
            "default":"5s",
            "type":"string"
        },
        "ds-cfg-log-file":{
            "description":"The file name to use for the log files generated by the File Based HTTP Access Log Publisher. The path to the file is relative to the server root. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-log-controls":{
            "description":"Indicates whether the request controls and response controls should be logged along with the operations that are requested by the client applications. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-log-file-permissions":{
            "description":"The UNIX permissions of the log files created by this File Based HTTP Access Log Publisher. ",
            "readOnly":false,
            "default":"640",
            "type":"string"
        },
        "ds-cfg-append":{
            "description":"Specifies whether to append to existing log files. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-retention-policy":{
            "description":"The retention policy to use for the File Based HTTP Access Log Publisher . ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストされたスキーマ: ds-cfg-operations-to-log

型: array

ログに記録する操作を示します。

デフォルト値: [ "administration", "user", "adminbrowsing" ]

使用可能な値: [ "adminbrowsing", "administration", "all", "user" ]

ソースを表示

• 配列: 文字列

{
    "description":"Indicates which operations has to be logged. ",
    "readOnly":false,
    "default":[
        "administration",
        "user",
        "adminbrowsing"
    ],
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "adminbrowsing",
        "administration",
        "all",
        "user"
    ]
}

ネストされたスキーマ: ds-cfg-retention-policy

型: array

ファイル・ベースHTTPアクセス・ログ・パブリッシャに使用する保持ポリシー。

ソースを表示

• 配列: 文字列

{
    "description":"The retention policy to use for the File Based HTTP Access Log Publisher . ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-rotation-policy

型: array

ファイル・ベースHTTPアクセス・ログ・パブリッシャに使用するローテーション・ポリシー。

ソースを表示

• 配列: 文字列

{
    "description":"The rotation policy to use for the File Based HTTP Access Log Publisher . ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

• 配列: 文字列

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

204レスポンス

コンテンツがありません

406レスポンス

受入れできません

本文 ()

ルート・スキーマ: ErrorResponse

型: object

ソースを表示

• ldapErrorCode: integer(int32)
  操作に対して返されるLDAPエラー・コードを指定します。
• message(required): string
  操作に対して返されるエラー・メッセージ。
• msgType(required): 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."
        }
    }
}

先頭に戻る