ジャンプ先

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

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/Proportional Load Balancing Route SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• [0]: object 比例ロード・バランシング・ルートのSearchResultEntry

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

ネストされたスキーマ: 比例ロード・バランシング・ルートのプロパティ

型: object

ソースを表示

• cn(optional): string
  エントリのCN (共通名)
• ds-cfg-add-weight: integer(int32)
  デフォルト値: 1

  追加操作のルートの重み。
• ds-cfg-bind-weight: integer(int32)
  デフォルト値: 1

  バインド操作のルートの重み。
• ds-cfg-compare-weight: integer(int32)
  デフォルト値: 1

  比較操作のルートの重み。
• ds-cfg-delete-weight: integer(int32)
  デフォルト値: 1

  削除操作のルートの重み。
• ds-cfg-extended-weight: integer(int32)
  デフォルト値: 1

  拡張操作のルートの重み。
• ds-cfg-modify-weight: integer(int32)
  デフォルト値: 1

  変更操作のルートの重み。
• ds-cfg-modifydn-weight: integer(int32)
  デフォルト値: 1

  識別名変更操作のルートの重み。
• ds-cfg-search-weight: integer(int32)
  デフォルト値: 1

  検索操作のルートの重み。
• ds-cfg-workflow-element(optional): string
  読取り専用: true

  ルートを含むワークフロー要素。
• objectclass: array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-compare-weight",
        "ds-cfg-search-weight",
        "ds-cfg-delete-weight",
        "ds-cfg-add-weight",
        "ds-cfg-bind-weight",
        "ds-cfg-modify-weight",
        "ds-cfg-extended-weight",
        "ds-cfg-modifydn-weight"
    ],
    "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-compare-weight":{
            "description":"The weight of the route for compare operations. ",
            "readOnly":false,
            "default":1,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-search-weight":{
            "description":"The weight of the route for search operations. ",
            "readOnly":false,
            "default":1,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-workflow-element":{
            "description":"The workflow element which contains the route. ",
            "readOnly":true,
            "type":"string"
        },
        "ds-cfg-delete-weight":{
            "description":"The weight of the route for delete operations. ",
            "readOnly":false,
            "default":1,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-add-weight":{
            "description":"The weight of the route for add operations. ",
            "readOnly":false,
            "default":1,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-bind-weight":{
            "description":"The weight of the route for bind operations. ",
            "readOnly":false,
            "default":1,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-modify-weight":{
            "description":"The weight of the route for modify operations. ",
            "readOnly":false,
            "default":1,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-extended-weight":{
            "description":"The weight of the route for extended operations. ",
            "readOnly":false,
            "default":1,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-modifydn-weight":{
            "description":"The weight of the route for modifyDN operations. ",
            "readOnly":false,
            "default":1,
            "type":"integer",
            "format":"int32"
        }
    }
}

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

先頭に戻る