ジャンプ先

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

DNによるリソース制限QOSポリシーの変更

PATCH

/rest/v1/admin/{dn}

DNによるリソース制限QOSポリシーの変更

リクエスト

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

• application/json

パス・パラメータ

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

本文 ()

変更する必要があるリソース制限QOSポリシー

ルート・スキーマ: 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

本文 ()

ルート・スキーマ: リソース制限QOSポリシーの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/Resource Limits QOS Policy SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• 配列: オブジェクト リソース制限QOSポリシーのSearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/Resource Limits QOS Policy SearchResultEntry"
    }
}

ネストされたスキーマ: リソース制限QOSポリシーのSearchResultEntry

型: object

ソースを表示

• attributes(required): object リソース制限QOSポリシーのプロパティ
• 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/Resource Limits QOS Policy Properties"
        }
    }
}

ネストされたスキーマ: リソース制限QOSポリシーのプロパティ

型: object

ソースを表示

• cn: string
  エントリのCN (共通名)
• ds-cfg-java-class(required): string
  デフォルト値: org.opends.server.core.networkgroups.ResourceLimitsPolicyFactory

  リソース制限QOSポリシーの実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-max-concurrent-ops-per-connection: integer(int32)
  デフォルト値: 0

  クライアント接続ごとの同時操作の最大数を指定します。
• ds-cfg-max-connections: integer(int32)
  デフォルト値: 0

  サーバーに対する同時クライアント接続の最大数を指定します。
• ds-cfg-max-connections-from-same-ip: integer(int32)
  デフォルト値: 0

  同じソース・アドレスからのクライアント接続の最大数を指定します。
• ds-cfg-max-ops-interval: string
  デフォルト値: 1s

  操作数が制限される間隔を指定します。
• ds-cfg-max-ops-per-connection: integer(int32)
  デフォルト値: 0

  クライアント接続ごとの操作の最大数を指定します。
• ds-cfg-max-ops-per-interval: integer(int32)
  デフォルト値: 0

  指定した間隔内で同じネットワーク・グループで実行できる最大操作数を指定します。
• ds-cfg-min-substring-length: integer(int32)
  デフォルト値: 0

  検索フィルタ部分文字列の最小長を指定します。
• ds-cfg-size-limit: integer(int32)
  1回の検索操作の間にクライアントに返されるエントリの最大数を指定します。
• ds-cfg-time-limit: string
  検索操作の処理に費やせる最大時間を指定します。
• objectclass(required): array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class"
    ],
    "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":"Specifies the fully-qualified name of the Java class that provides the Resource Limits QOS Policy implementation. ",
            "readOnly":false,
            "default":"org.opends.server.core.networkgroups.ResourceLimitsPolicyFactory",
            "type":"string"
        },
        "ds-cfg-time-limit":{
            "description":"Specifies the maximum length of time that should be spent processing a search operation. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-max-ops-per-interval":{
            "description":"Specifies the maximum number of operations that can take place on the same network group during the specified interval. ",
            "readOnly":false,
            "default":"0",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-max-connections-from-same-ip":{
            "description":"Specifies the maximum number of client connections from the same source address. ",
            "readOnly":false,
            "default":"0",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-min-substring-length":{
            "description":"Specifies the minimum length for a search filter substring. ",
            "readOnly":false,
            "default":"0",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-max-connections":{
            "description":"Specifies the maximum number of concurrent client connections to the server. ",
            "readOnly":false,
            "default":"0",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-max-concurrent-ops-per-connection":{
            "description":"Specifies the maximum number of concurrent operations per client connection. ",
            "readOnly":false,
            "default":"0",
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-max-ops-interval":{
            "description":"Specifies the interval during which the number of operations is limited. ",
            "readOnly":false,
            "default":"1s",
            "type":"string"
        },
        "ds-cfg-size-limit":{
            "description":"Specifies the maximum number of entries that can be returned to the client during a single search operation. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-max-ops-per-connection":{
            "description":"Specifies the maximum number of operations per client connection. ",
            "readOnly":false,
            "default":"0",
            "type":"integer",
            "format":"int32"
        }
    }
}

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

先頭に戻る