ジャンプ先

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

DNによるファイル・ベース・エラー・ログ・パブリッシャの変更

PATCH

/rest/v1/admin/{dn}

DNによるファイル・ベース・エラー・ログ・パブリッシャの変更

リクエスト

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

• application/json

パス・パラメータ

• dn(required): string
  変更するエントリのLDAP DN。

本文 ()

変更する必要があるファイル・ベース・エラー・ログ・パブリッシャ

ルート・スキーマ: PatchRequest

型: object

ソースを表示

• controls: array controls
  LDAP変更操作のためにサーバーに送信するLDAP制御。
• msgType(required): string
  デフォルト値: urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest

  RESTメッセージ・タイプ
• operations(必須): array operations
  エントリに対して実行する変更(パッチ操作)。

{
    "type":"object",
    "required":[
        "msgType",
        "operations"
    ],
    "properties":{
        "msgType":{
            "description":"The REST message type",
            "default":"urn:ietf:params:rest:schemas:oracle:oud:1.0:ModifyRequest",
            "type":"string"
        },
        "operations":{
            "type":"array",
            "description":"Modifications (Patch operations) to be performed on the entry.",
            "items":{
                "$ref":"#/definitions/PatchOperation"
            }
        },
        "controls":{
            "description":"LDAP controls to be sent to server for LDAP modify operation.",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

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

ソースを表示

• 配列: 文字列

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

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

型: array

エントリに対して実行する変更(パッチ操作)。

ソースを表示

• 配列: オブジェクト PatchOperation

{
    "type":"array",
    "description":"Modifications (Patch operations) to be performed on the entry.",
    "items":{
        "$ref":"#/definitions/PatchOperation"
    }
}

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

型: object

ソースを表示

• attribute(required): string
  変更するエントリ属性。
• opType(required): string
  指定可能な値: [ "add", "delete", "replace", "increment" ]

  パッチ操作のタイプ。
• values: array values
  更新する属性値。

{
    "type":"object",
    "required":[
        "opType",
        "attribute"
    ],
    "properties":{
        "opType":{
            "description":"The type of the Patch Operation.",
            "type":"string",
            "enum":[
                "add",
                "delete",
                "replace",
                "increment"
            ]
        },
        "attribute":{
            "type":"string",
            "description":"The entry attribute to be modified."
        },
        "values":{
            "type":"array",
            "description":"The attribute values to be updated.",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

更新する属性値。

ソースを表示

• 配列: 文字列

{
    "type":"array",
    "description":"The attribute values to be updated.",
    "items":{
        "type":"string"
    }
}

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文 ()

ルート・スキーマ: ファイル・ベース・エラー・ログ・パブリッシャのPatchSuccessResponse

型: object

ソースを表示

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

  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:ModifyResponse",
            "type":"string"
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Specifies the number of entries created, and returned."
        },
        "searchResultEntries":{
            "type":"array",
            "description":"Number of search result entries returned after the LDAP operation.",
            "items":{
                "$ref":"#/definitions/File Based Error Log Publisher SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

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

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

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

型: object

ソースを表示

• attributes(required): object ファイル・ベース・エラー・ログ・パブリッシャのプロパティ
• 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 Error Log Publisher Properties"
        }
    }
}

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

型: object

ソースを表示

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

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

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

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

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

  ファイル・ベース・エラー・ログ・パブリッシャの実装を提供するJavaクラスの完全修飾名。
• 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-override-severity: array ds-cfg-override-severity
  メッセージ・カテゴリに基づくログ出力の優先指定重大度レベルを指定します。
• 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-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 Error Log Publisher implementation. ",
            "readOnly":false,
            "default":"org.opends.server.loggers.TextErrorLogPublisher",
            "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 Error 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-default-severity":{
            "description":"Specifies the default severity levels for the logger. ",
            "readOnly":false,
            "default":[
                "fatal-error",
                "severe-warning",
                "severe-error",
                "mild-error",
                "mild-warning"
            ],
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "all",
                "debug",
                "fatal-error",
                "info",
                "mild-error",
                "mild-warning",
                "none",
                "notice",
                "severe-error",
                "severe-warning"
            ]
        },
        "ds-cfg-asynchronous":{
            "description":"Indicates whether the File Based Error Log Publisher will publish records asynchronously. ",
            "readOnly":false,
            "default":false,
            "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 Error Log Publisher . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-log-file-permissions":{
            "description":"The UNIX permissions of the log files created by this File Based Error 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 Error Log Publisher . ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-override-severity":{
            "description":"Specifies the override severity levels for the logger based on the category of the messages. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

ネストされたスキーマ: ds-cfg-default-severity

型: array

ログ出力のデフォルトの重大度レベルを指定します。

デフォルト値: [ "fatal-error", "severe-warning", "severe-error", "mild-error", "mild-warning" ]

指定可能な値: [ "all", "debug", "fatal-error", "info", "mild-error", "mild-warning", "none", "notice", "severe-error", "severe-warning" ]

ソースを表示

• 配列: 文字列

{
    "description":"Specifies the default severity levels for the logger. ",
    "readOnly":false,
    "default":[
        "fatal-error",
        "severe-warning",
        "severe-error",
        "mild-error",
        "mild-warning"
    ],
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "all",
        "debug",
        "fatal-error",
        "info",
        "mild-error",
        "mild-warning",
        "none",
        "notice",
        "severe-error",
        "severe-warning"
    ]
}

ネストされたスキーマ: ds-cfg-override-severity

型: array

メッセージ・カテゴリに基づくログ出力の優先指定重大度レベルを指定します。

ソースを表示

• 配列: 文字列

{
    "description":"Specifies the override severity levels for the logger based on the category of the messages. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

• 配列: 文字列

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

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

型: array

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

ソースを表示

• 配列: 文字列

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

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

型: array

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

ソースを表示

• 配列: 文字列

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

400レスポンス

ERROR

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

先頭に戻る