ジャンプ先

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

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/Replication Server SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• [0]: object レプリケーション・サーバーのSearchResultEntry

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

ネストされたスキーマ: レプリケーション・サーバーのプロパティ

型: object

ソースを表示

• cn(optional): string
  エントリのCN (共通名)
• ds-cfg-assured-timeout(optional): string
  デフォルト値: 1000ms

  保証モードの肯定応答を待機する際のタイムアウト値。
• ds-cfg-degraded-status-threshold(optional): integer(int32)
  デフォルト値: 5000

  ディレクトリ・サーバーを機能低下ステータスにする際のしきい値となる、保留中の変更の数。
• ds-cfg-disk-full-replication-purge-delay(optional): string
  デフォルト値: 18000s

  ディスク容量がdisk-low-thresholdで指定された値を下回った場合に、レプリケーション・サーバーがすべての持続的な情報を消去するまでの時間(秒)。
• ds-cfg-disk-full-threshold(optional): string
  デフォルト値: 20 megabytes

  レプリケーション・サーバーを停止するための、フル・ディスクしきい値
• ds-cfg-disk-low-threshold(optional): string
  デフォルト値: 100 megabytes

  持続的な情報すべてのパージを開始するための、下限ディスクしきい値
• ds-cfg-group-id(optional): integer(int32)
  デフォルト値: 1

  レプリケーション・サーバーのグループID。
• ds-cfg-heartbeat-interval(optional): string
  デフォルト値: 10000ms

  ピアRSへの接続がアクティブとみなされる最大時間。
• ds-cfg-monitoring-period(optional): string
  デフォルト値: 3000ms

  モニタリング・メッセージの送信の間隔。
• ds-cfg-queue-size(optional): integer(int32)
  デフォルト値: 10000

  レプリケーション・ドメイン内のディレクトリ・サーバーごとに、メモリーに保持される変更の数を指定します。
• ds-cfg-replication-db-directory(optional): string
  読取り専用: true

  デフォルト値: changelogDb

  レプリケーション・サーバーがすべての持続的な情報を格納する場所のパス。
• ds-cfg-replication-port: integer(int32)
  レプリケーション・サーバーが他のレプリケーション・サーバーまたはディレクトリ・サーバーからの接続を待機するポート。
• ds-cfg-replication-purge-delay(optional): string
  デフォルト値: 360000s

  レプリケーション・サーバーがすべての持続的な情報を消去するまでの時間(秒)。
• ds-cfg-replication-server(optional): array ds-cfg-replication-server
  このレプリケーション・サーバーが起動時に接続しようとする他のレプリケーション・サーバーのアドレスを指定します。
• ds-cfg-replication-server-id(optional): integer(int32)
  読取り専用: true

  レプリケーション・サーバーの一意の識別子を指定します。
• ds-cfg-weight(optional): integer(int32)
  デフォルト値: 1

  レプリケーション・サーバーの重み。
• ds-cfg-window-size(optional): integer(int32)
  デフォルト値: 100

  レプリケーション・サーバーが他のレプリケーション・サーバーとの通信で使用するウィンドウ・サイズを指定します。
• objectclass: array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-replication-port"
    ],
    "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-heartbeat-interval":{
            "description":"The maximum period of time that the connection to a peer RS will be considered active. ",
            "readOnly":false,
            "default":"10000ms",
            "type":"string"
        },
        "ds-cfg-degraded-status-threshold":{
            "description":"The number of pending changes as threshold value for putting a directory server in degraded status. ",
            "readOnly":false,
            "default":5000,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-group-id":{
            "description":"The group id for the replication server. ",
            "readOnly":false,
            "default":1,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-disk-full-threshold":{
            "description":"Full disk threshold to stop the replication server ",
            "readOnly":false,
            "default":"20 megabytes",
            "type":"string"
        },
        "ds-cfg-replication-db-directory":{
            "description":"The path where the Replication Server stores all persistent information. ",
            "readOnly":true,
            "default":"changelogDb",
            "type":"string"
        },
        "ds-cfg-replication-port":{
            "description":"The port on which this Replication Server waits for connections from other Replication Servers or Directory Servers. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-weight":{
            "description":"The weight of the replication server. ",
            "readOnly":false,
            "default":1,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-disk-low-threshold":{
            "description":"Low disk threshold to start purging all persistent information ",
            "readOnly":false,
            "default":"100 megabytes",
            "type":"string"
        },
        "ds-cfg-monitoring-period":{
            "description":"The period between sending of monitoring messages. ",
            "readOnly":false,
            "default":"3000ms",
            "type":"string"
        },
        "ds-cfg-disk-full-replication-purge-delay":{
            "description":"The time (in seconds) after which the Replication Server erases all persistent information when the disk space falls below the value specified disk-low-threshold. ",
            "readOnly":false,
            "default":"18000s",
            "type":"string"
        },
        "ds-cfg-assured-timeout":{
            "description":"The timeout value when waiting for assured mode acknowledgments. ",
            "readOnly":false,
            "default":"1000ms",
            "type":"string"
        },
        "ds-cfg-replication-server-id":{
            "description":"Specifies a unique identifier for the Replication Server. ",
            "readOnly":true,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-queue-size":{
            "description":"Specifies the number of changes that are kept in memory for each Directory Server in the Replication Domain. ",
            "readOnly":false,
            "default":10000,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-replication-server":{
            "description":"Specifies the addresses of other Replication Servers to which this Replication Server tries to connect at startup time. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-replication-purge-delay":{
            "description":"The time (in seconds) after which the Replication Server erases all persistent information. ",
            "readOnly":false,
            "default":"360000s",
            "type":"string"
        },
        "ds-cfg-window-size":{
            "description":"Specifies the window size that the Replication Server uses when communicating with other Replication Servers. ",
            "readOnly":false,
            "default":100,
            "type":"integer",
            "format":"int32"
        }
    }
}

ネストされたスキーマ: ds-cfg-replication-server

型: array

このレプリケーション・サーバーが起動時に接続しようとする他のレプリケーション・サーバーのアドレスを指定します。

ソースを表示

• [0]: string

{
    "description":"Specifies the addresses of other Replication Servers to which this Replication Server tries to connect at startup time. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

先頭に戻る