ジャンプ先

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

DNによる高etimeファイル・ベース・アクセス・ログ・パブリッシャの検索

GET

/rest/v1/admin/{dn}

DNによって高etimeファイル・ベース・アクセス・ログ・パブリッシャを返します

リクエスト

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

• application/json

パス・パラメータ

• dn(required): string
  フェッチするエントリのLDAP DN。

問合せパラメータ

• attributes: array[string]
  コレクション形式: multi

  エントリに対してフェッチする属性のリスト。
• controls: array[string]
  コレクション形式: multi

  検索操作のためにサーバーに送信するLDAP制御。
• filter: string
  LDAP検索操作用の検索フィルタ。LDAP検索フィルタの構文に従う必要があります。
• scope: string
  LDAP検索操作の範囲。

  指定可能な値: [ "base", "sub", "one" ]

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文 ()

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

型: object

ソースを表示

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

  RESTメッセージ・タイプ
• searchResultEntries(required): array searchResultEntries
  LDAP操作後に返される検索結果エントリの数。
• 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:SearchResponse",
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "description":"Number of search result entries returned after the LDAP operation.",
            "items":{
                "$ref":"#/definitions/High Etime File Based Access Log Publisher SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

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

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

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

型: object

ソースを表示

• attributes(required): object 高etimeファイル・ベース・アクセス・ログ・パブリッシャのプロパティ
• 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/High Etime File Based Access Log Publisher Properties"
        }
    }
}

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

型: object

ソースを表示

• cn: string
  エントリのCN (共通名)
• ds-cfg-append: boolean
  デフォルト値: true

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

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

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

  ログ・ファイル・バッファのサイズを指定します。
• ds-cfg-enabled(required): boolean
  ログ・パブリッシャが使用可能かどうかを示します。
• ds-cfg-java-class(required): string
  デフォルト値: org.opends.server.loggers.HighEtimeAccessLogPublisher

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

  クライアント・アプリケーションによってリクエストされた操作とともにリクエスト制御およびレスポンス制御をログに記録する必要があるかどうかを示します。
• ds-cfg-log-file(required): string
  ファイル・ベース・アクセス・ログ・パブリッシャによって生成されたログ・ファイルに使用されるファイル名。ファイルへのパスは、サーバー・ルートに対して相対的です。
• ds-cfg-log-file-permissions(required): string
  デフォルト値: 640

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

  ローテーションされるファイルの名前にローカル時間とGMTのどちらを使用するかを指定します。
• ds-cfg-log-high-etime-limit(required): string
  デフォルト値: 10 milliseconds

  高etime制限をミリ秒単位で指定します。この値以上のetimeは、高etimeファイル・ベース・アクセス・ログ・パブリッシャによってログに記録されます。
• ds-cfg-log-qtime: boolean
  デフォルト値: false

  操作でキューの前処理に要した時間をログに記録します。
• 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
  ファイル・ベース・アクセス・ログ・パブリッシャに使用する保持ポリシー。
• ds-cfg-rotation-policy: array ds-cfg-rotation-policy
  ファイル・ベース・アクセス・ログ・パブリッシャに使用するローテーション・ポリシー。
• ds-cfg-time-interval: string
  デフォルト値: 5s

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

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-log-high-etime-limit",
        "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 High Etime File Based Access Log Publisher implementation. ",
            "readOnly":false,
            "default":"org.opends.server.loggers.HighEtimeAccessLogPublisher",
            "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-log-high-etime-limit":{
            "description":"Specifies the high etime limit in milliseconds. etime equal to or above this value will be logged by High etime Access Log Publisher. ",
            "readOnly":false,
            "default":"10 milliseconds",
            "type":"string"
        },
        "ds-cfg-rotation-policy":{
            "description":"The rotation policy to use for the File Based 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-enabled":{
            "description":"Indicates whether the Log Publisher is enabled for use. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-log-qtime":{
            "description":"Logs the time spent in preprocessing queue for an operation. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-operations-to-log":{
            "description":"Indicates which operations has to be logged. ",
            "readOnly":false,
            "default":[
                "administration",
                "user",
                "adminbrowsing",
                "synchronization"
            ],
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "adminbrowsing",
                "administration",
                "all",
                "internal",
                "synchronization",
                "user"
            ]
        },
        "ds-cfg-asynchronous":{
            "description":"Indicates whether the File Based 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 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 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 Access Log Publisher . ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

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

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

指定可能な値: [ "adminbrowsing", "administration", "all", "internal", "synchronization", "user" ]

ソースを表示

• 配列: 文字列

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

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

型: array

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

ソースを表示

• 配列: 文字列

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

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

型: array

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

ソースを表示

• 配列: 文字列

{
    "description":"The rotation policy to use for the File Based 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"
    }
}

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

先頭に戻る