ジャンプ先

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

DNによるデバッグ・ターゲットの変更

PATCH

/rest/v1/admin/{dn}

DNによるデバッグ・ターゲットの変更

リクエスト

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

• application/json

パス・パラメータ

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

本文 ()

変更する必要があるデバッグ・ターゲット

ルート・スキーマ: PatchRequest

型: object

ソースを表示

• controls(optional): array controls
  LDAP変更操作のためにサーバーに送信するLDAP制御。
• msgType: 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制御。

ソースを表示

• [0]: string

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

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

型: array

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

ソースを表示

• [0]: object PatchOperation

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

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

型: object

ソースを表示

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

  パッチ操作のタイプ。
• values(optional): 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

更新する属性値。

ソースを表示

• [0]: string

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

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文 ()

ルート・スキーマ: デバッグ・ターゲットのPatchSuccessResponse

型: object

ソースを表示

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

  RESTメッセージ・タイプ
• searchResultEntries: array searchResultEntries
  LDAP操作後に返される検索結果エントリの数。
• 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: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/Debug Target SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• [0]: object デバッグ・ターゲットのSearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/Debug Target 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/Debug Target Properties"
        }
    }
}

ネストされたスキーマ: デバッグ・ターゲットのプロパティ

型: object

ソースを表示

• cn(optional): string
  エントリのCN (共通名)
• ds-cfg-debug-category(optional): array ds-cfg-debug-category
  ログに記録するデバッグ・メッセージ・カテゴリを指定します。
• ds-cfg-debug-level: string
  指定可能な値: [ "all", "disabled", "error", "info", "verbose", "warning" ]

  ログに記録するデバッグ・メッセージの最小の重大度レベルを指定します。
• ds-cfg-debug-scope(optional): string
  読取り専用: true

  このターゲット定義の設定の影響を受ける完全修飾されたOracle Unified DirectoryのJavaパッケージ、クラスまたはメソッドを指定します。シャープ記号(#)を使用して、クラス名とメソッド名を区切ります(つまり、org.opends.server.core.DirectoryServer#startUp)。
• ds-cfg-include-throwable-cause(optional): boolean
  デフォルト値: false

  例外によってスローおよびキャッチされたメッセージに、例外の原因を含めるかどうかを指定するためのプロパティを指定します。
• ds-cfg-omit-method-entry-arguments(optional): boolean
  デフォルト値: false

  デバッグ・メッセージにメソッド引数を含めるかどうかを指定するためのプロパティを指定します。
• ds-cfg-omit-method-return-value(optional): boolean
  デフォルト値: false

  デバッグ・メッセージに戻り値を含めるかどうかを指定するためのプロパティを指定します。
• ds-cfg-throwable-stack-frames(optional): integer(int32)
  デフォルト値: 0

  メソッド・エントリのスタック・トレース、および例外によってスローされたメッセージに含めるスタック・フレーム数を指定するためのプロパティを指定します。
• objectclass: array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-debug-level"
    ],
    "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-debug-scope":{
            "description":"Specifies the fully-qualified Oracle Unified Directory Java package, class, or method affected by the settings in this target definition. Use the number character (#) to separate the class name and the method name (that is, org.opends.server.core.DirectoryServer#startUp). ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-debug-level":{
            "description":"Specifies the lowest severity level of debug messages to log. ",
            "readOnly":false,
            "type":"string",
            "enum":[
                "all",
                "disabled",
                "error",
                "info",
                "verbose",
                "warning"
            ]
        },
        "ds-cfg-omit-method-entry-arguments":{
            "description":"Specifies the property to indicate whether to include method arguments in debug messages. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-throwable-stack-frames":{
            "description":"Specifies the property to indicate the number of stack frames to include in the stack trace for method entry and exception thrown messages. ",
            "readOnly":false,
            "default":0,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-debug-category":{
            "description":"Specifies the debug message categories to be logged. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "caught",
                "constructor",
                "data",
                "database-access",
                "enter",
                "exit",
                "message",
                "protocol",
                "thrown"
            ]
        },
        "ds-cfg-omit-method-return-value":{
            "description":"Specifies the property to indicate whether to include the return value in debug messages. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-include-throwable-cause":{
            "description":"Specifies the property to indicate whether to include the cause of exceptions in exception thrown and caught messages. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        }
    }
}

ネストされたスキーマ: ds-cfg-debug-category

型: array

ログに記録するデバッグ・メッセージ・カテゴリを指定します。

指定可能な値: [ "caught", "constructor", "data", "database-access", "enter", "exit", "message", "protocol", "thrown" ]

ソースを表示

• [0]: string

{
    "description":"Specifies the debug message categories to be logged. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "caught",
        "constructor",
        "data",
        "database-access",
        "enter",
        "exit",
        "message",
        "protocol",
        "thrown"
    ]
}

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

型: array

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

ソースを表示

• [0]: string

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

400レスポンス

ERROR

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

先頭に戻る