ジャンプ先

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

DNによるHTTP接続ハンドラの検索

GET

/rest/v1/admin/{dn}

DNによってHTTP接続ハンドラを返します

リクエスト

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

• application/json

パス・パラメータ

• dn: string
  フェッチするエントリのLDAP DN。

問合せパラメータ

• attributes: array
  コレクション形式: multi

  エントリに対してフェッチする属性のリスト。

  • [0]: string

  {
      "name":"attributes",
      "in":"query",
      "description":"List of attributes to be fetched for the entry.",
      "type":"array",
      "collectionFormat":"multi",
      "items":{
          "type":"string"
      }
  }

• controls: array
  コレクション形式: multi

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

  • [0]: string

  {
      "name":"controls",
      "in":"query",
      "description":"LDAP controls to be sent to server for search operation.",
      "type":"array",
      "collectionFormat":"multi",
      "items":{
          "type":"string"
      }
  }

• filter: string
  LDAP検索操作用の検索フィルタ。LDAP検索フィルタの構文に従う必要があります。
• scope: string
  LDAP検索操作の範囲。

  指定可能な値: [ "base", "sub", "one" ]

先頭に戻る

レスポンス

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

• application/json

200レスポンス

OK

本文 ()

ルート・スキーマ: HTTP接続ハンドラのGetSuccessResponse

型: object

ソースを表示

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

  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:SearchResponse",
            "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/HTTP Connection Handler SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• 配列: オブジェクト HTTP接続ハンドラのSearchResultEntry

{
    "type":"array",
    "description":"Number of search result entries returned after the LDAP operation.",
    "items":{
        "$ref":"#/definitions/HTTP Connection Handler SearchResultEntry"
    }
}

ネストされたスキーマ: HTTP接続ハンドラのSearchResultEntry

型: object

ソースを表示

• attributes: object HTTP接続ハンドラのプロパティ
• 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/HTTP Connection Handler Properties"
        }
    }
}

ネストされたスキーマ: HTTP接続ハンドラのプロパティ

型: object

ソースを表示

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

  受入れバックログのキューに入れることができる保留中の接続試行の最大数を指定します。この数を超えるとサーバーが新しい接続試行を拒否し始めます。
• ds-cfg-allow-tcp-reuse-address(optional): boolean
  デフォルト値: true

  HTTP接続ハンドラがソケット記述子を再利用するかどうかを示します。
• ds-cfg-allowed-client(optional): array ds-cfg-allowed-client
  この接続ハンドラへの接続の確立を許可されているクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
• ds-cfg-denied-client(optional): array ds-cfg-denied-client
  この接続ハンドラへの接続の確立を許可されていないクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。
• ds-cfg-dos-filter-max-requests-per-sec(optional): integer(int32)
  デフォルト値: 25

  1つの接続の最大リクエスト数/秒を指定します。
• ds-cfg-dos-filter-throttled-requests(optional): integer(int32)
  デフォルト値: 5

  一度に考慮可能なレート制限を超えるリクエスト数。
• ds-cfg-enabled: boolean
  接続ハンドラが使用可能かどうかを示します。
• ds-cfg-header-cache-size(optional): string
  デフォルト値: 6 kilobytes

  ヘッダー・フィールド・キャッシュ・サイズを設定します。
• ds-cfg-http-server-max-thread-pool-size(optional): integer(int32)
  デフォルト値: 24

  埋込みHTTPサーバーによってキューに入れられた操作を処理するために使用されるスレッドの最大数を指定します。
• ds-cfg-http-server-max-work-queue-capacity(optional): integer(int32)
  デフォルト値: 6000

  常にワーク・キューに入れることができる、キュー操作の最大数を指定します。
• ds-cfg-http-server-min-thread-pool-size(optional): integer(int32)
  デフォルト値: 8

  埋込みHTTPサーバーによってキューに入れられた操作を処理するために使用されるスレッドの最小数を指定します。
• ds-cfg-idle-time-limit(optional): string
  デフォルト値: 60000ms

  スレッドがアイドル状態でいられる最大アイドル時間を設定します。
• ds-cfg-java-class: string
  デフォルト値: org.opends.server.protocols.http.HTTPConnectionHandler

  HTTP接続ハンドラの実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-jetty-statistics-enabled(optional): boolean
  デフォルト値: false

  HTTP接続ハンドラがJMXを介してjetty統計情報を使用可能にするかどうかを示します。
• ds-cfg-keep-stats(optional): boolean
  デフォルト値: true

  HTTP接続ハンドラが統計情報を保持するかどうかを示します。
• ds-cfg-key-manager-provider(optional): string
  このHTTP接続ハンドラで使用する必要があるキー・マネージャの名前を指定します。
• ds-cfg-listen-address(optional): array ds-cfg-listen-address
  HTTP接続ハンドラがHTTPクライアントからの接続をリスニングするアドレスまたはアドレスのセットを指定します。
• ds-cfg-listen-port: integer(int32)
  HTTP接続ハンドラがクライアントからの接続をリスニングするポート番号を指定します。
• ds-cfg-max-idle-time-limit(optional): string
  デフォルト値: 2 minutes

  接続の最大アイドル時間を設定します。これは大まかにSocket.setSoTimeout(int)コールに変換されます。
• ds-cfg-num-http-acceptor-threads(optional): integer(int32)
  アクセプタは新しいTCP/IP接続を受け入れます
• ds-cfg-num-http-selector-threads(optional): integer(int32)
  セレクタにより、IOを進行させることができる確立された接続が通知およびスケジュールされます。
• ds-cfg-output-buffer-size(optional): string
  デフォルト値: 32 kilobytes

  レスポンスを送信するためのコンテンツ・バッファのサイズを設定します。
• ds-cfg-request-header-size(optional): string
  デフォルト値: 8 kilobytes

  リクエスト・ヘッダーの最大サイズを設定します。
• ds-cfg-response-header-size(optional): string
  デフォルト値: 32 kilobytes

  レスポンス・ヘッダーの最大サイズを設定します。
• ds-cfg-ssl-cert-nickname(optional): string
  HTTP接続ハンドラがSSL通信の実行時に使用する必要がある証明書のニックネーム(エイリアスとも呼ばれます)を指定します。
• ds-cfg-ssl-cipher-suite(optional): array ds-cfg-ssl-cipher-suite
  SSLまたはStartTLS通信で使用できるSSL暗号スイートの名前を指定します。
• ds-cfg-ssl-client-auth-policy(optional): string
  デフォルト値: optional

  指定可能な値: [ "disabled", "optional", "required" ]

  クライアントSSL証明書に関してHTTP接続ハンドラが使用するポリシーを指定します。
• ds-cfg-ssl-protocol(optional): array ds-cfg-ssl-protocol
  SSLまたはStartTLS通信で使用できるSSLプロトコルの名前を指定します。
• ds-cfg-trust-manager-provider(optional): string
  このHTTP接続ハンドラで使用する必要がある信頼マネージャの名前を指定します。
• ds-cfg-use-ssl(optional): boolean
  デフォルト値: false

  HTTP接続ハンドラがSSLを使用する必要があるかどうかを示します。
• objectclass: array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-enabled",
        "ds-cfg-listen-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-java-class":{
            "description":"Specifies the fully-qualified name of the Java class that provides the HTTP Connection Handler implementation. ",
            "readOnly":false,
            "default":"org.opends.server.protocols.http.HTTPConnectionHandler",
            "type":"string"
        },
        "ds-cfg-keep-stats":{
            "description":"Indicates whether the HTTP Connection Handler should keep statistics. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-dos-filter-max-requests-per-sec":{
            "description":"Specifies the maximum number of requests from a connection per second. ",
            "readOnly":false,
            "default":25,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-ssl-cipher-suite":{
            "description":"Specifies the names of the SSL cipher suites that are allowed for use in SSL or StartTLS communication. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-jetty-statistics-enabled":{
            "description":"Indicates whether the HTTP Connection Handler should enable jetty statistics over JMX. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Connection Handler is enabled. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-key-manager-provider":{
            "description":"Specifies the name of the key manager that should be used with this HTTP Connection Handler . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-accept-backlog":{
            "description":"Specifies the maximum number of pending connection attempts that are allowed to queue up in the accept backlog before the server starts rejecting new connection attempts. ",
            "readOnly":false,
            "default":128,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-num-http-selector-threads":{
            "description":"Selectors notice and schedule established connection that can make IO progress. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-http-server-max-work-queue-capacity":{
            "description":"Specifies the maximum number of queued operations that can be in the work queue at any given time. ",
            "readOnly":false,
            "default":6000,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-denied-client":{
            "description":"Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Connection Handler. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-trust-manager-provider":{
            "description":"Specifies the name of the trust manager that should be used with the HTTP Connection Handler . ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-allow-tcp-reuse-address":{
            "description":"Indicates whether the HTTP Connection Handler should reuse socket descriptors. ",
            "readOnly":false,
            "default":true,
            "type":"boolean"
        },
        "ds-cfg-listen-port":{
            "description":"Specifies the port number on which the HTTP Connection Handler will listen for connections from clients. ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-use-ssl":{
            "description":"Indicates whether the HTTP Connection Handler should use SSL. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-allowed-client":{
            "description":"Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Connection Handler. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-http-server-max-thread-pool-size":{
            "description":"Specifies the maximum number of threads to be used for processing operations placed in the queue by the embedded HTTP server. ",
            "readOnly":false,
            "default":24,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-listen-address":{
            "description":"Specifies the address or set of addresses on which this HTTP Connection Handler should listen for connections from HTTP clients. ",
            "readOnly":false,
            "default":[
                "0.0.0.0"
            ],
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-dos-filter-throttled-requests":{
            "description":"Number of requests over the rate limit able to be considered at once. ",
            "readOnly":false,
            "default":5,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-max-idle-time-limit":{
            "description":"Set the maximum Idle time for a connection, which roughly translates to the Socket.setSoTimeout(int) call. ",
            "readOnly":false,
            "default":"2 minutes",
            "type":"string"
        },
        "ds-cfg-ssl-client-auth-policy":{
            "description":"Specifies the policy that the HTTP Connection Handler should use regarding client SSL certificates. ",
            "readOnly":false,
            "default":"optional",
            "type":"string",
            "enum":[
                "disabled",
                "optional",
                "required"
            ]
        },
        "ds-cfg-num-http-acceptor-threads":{
            "description":"Acceptors accept new TCP/IP connections ",
            "readOnly":false,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-ssl-protocol":{
            "description":"Specifies the names of the SSL protocols that are allowed for use in SSL or StartTLS communication. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-http-server-min-thread-pool-size":{
            "description":"Specifies the minimum number of threads to be used for processing operations placed in the queue by the embedded HTTP server. ",
            "readOnly":false,
            "default":8,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-request-header-size":{
            "description":"Set the maximum size of a request header. ",
            "readOnly":false,
            "default":"8 kilobytes",
            "type":"string"
        },
        "ds-cfg-output-buffer-size":{
            "description":"Sets the size of the content buffer for sending responses. ",
            "readOnly":false,
            "default":"32 kilobytes",
            "type":"string"
        },
        "ds-cfg-ssl-cert-nickname":{
            "description":"Specifies the nickname (also called the alias) of the certificate that the HTTP Connection Handler should use when performing SSL communication. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-idle-time-limit":{
            "description":"Set the maximum Idle time for a thread to be idle. ",
            "readOnly":false,
            "default":"60000 ms",
            "type":"string"
        },
        "ds-cfg-header-cache-size":{
            "description":"Set the header field cache size. ",
            "readOnly":false,
            "default":"6 kilobytes",
            "type":"string"
        },
        "ds-cfg-response-header-size":{
            "description":"Set the maximum size of a response header. ",
            "readOnly":false,
            "default":"32 kilobytes",
            "type":"string"
        }
    }
}

ネストされたスキーマ: ds-cfg-allowed-client

型: array

この接続ハンドラへの接続の確立を許可されているクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。

ソースを表示

• 配列: 文字列

{
    "description":"Specifies a set of host names or address masks that determine the clients that are allowed to establish connections to this Connection Handler. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-denied-client

型: array

この接続ハンドラへの接続の確立を許可されていないクライアントを判断するためのホスト名またはアドレス・マスクのセットを指定します。

ソースを表示

• 配列: 文字列

{
    "description":"Specifies a set of host names or address masks that determine the clients that are not allowed to establish connections to this Connection Handler. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-listen-address

型: array

HTTP接続ハンドラがHTTPクライアントからの接続をリスニングするアドレスまたはアドレスのセットを指定します。

デフォルト値: [ "0.0.0.0" ]

ソースを表示

• 配列: 文字列

{
    "description":"Specifies the address or set of addresses on which this HTTP Connection Handler should listen for connections from HTTP clients. ",
    "readOnly":false,
    "default":[
        "0.0.0.0"
    ],
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-ssl-cipher-suite

型: array

SSLまたはStartTLS通信で使用できるSSL暗号スイートの名前を指定します。

ソースを表示

• 配列: 文字列

{
    "description":"Specifies the names of the SSL cipher suites that are allowed for use in SSL or StartTLS communication. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: ds-cfg-ssl-protocol

型: array

SSLまたはStartTLS通信で使用できるSSLプロトコルの名前を指定します。

ソースを表示

• 配列: 文字列

{
    "description":"Specifies the names of the SSL protocols that are allowed for use in SSL or StartTLS communication. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

• 配列: 文字列

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

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

先頭に戻る