ジャンプ先

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

DNによるRDBMS拡張機能の検索

GET

/rest/v1/admin/{dn}

DNによってRDBMS拡張機能を返します

リクエスト

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

• 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

本文 ()

ルート・スキーマ: RDBMS拡張機能の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/RDBMS Extension SearchResultEntry"
            }
        }
    }
}

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

型: array

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

ソースを表示

• [0]: object RDBMS拡張機能のSearchResultEntry

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

ネストされたスキーマ: RDBMS拡張機能のSearchResultEntry

型: object

ソースを表示

• attributes: object RDBMS拡張機能のプロパティ
• 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/RDBMS Extension Properties"
        }
    }
}

ネストされたスキーマ: RDBMS拡張機能のプロパティ

型: object

ソースを表示

• cn(optional): string
  エントリのCN (共通名)
• ds-cfg-connection-pool-provider(optional): string
  デフォルト値: universal-connection-pool

  指定可能な値: [ "simple-pool", "universal-connection-pool" ]

  この拡張機能に対して使用する接続プール実装。デフォルトでは、ユニバーサル接続プール(UCP)を使用します。注意: Simple_Poolを使用する場合、RDBMS拡張機能を複数のRDBMS WorkflowElement で共有できません。
• ds-cfg-connection-reuse-count(optional): integer(int32)
  デフォルト値: 0

  最大接続再使用数プロパティを設定します。このプロパティは、プールが接続を閉じて削除するまでに接続を再利用できる最大回数を指定します。この機能を有効にするには、値を0より大きくする必要があります。たとえば、指定した値が100の場合、接続がプールから100回再利用または流用されると、接続は閉じられてプールから削除されます。接続がプールに戻され、プロパティ値を超えると、接続は正常に閉じられます。デフォルトは0であり、これはこの機能が無効であることを意味します。
• ds-cfg-enabled: boolean
  拡張機能が使用可能かどうかを示します。
• ds-cfg-inactive-connection-timeout(optional): integer(int32)
  デフォルト値: 0

  非アクティブ接続タイムアウトを設定します。このタイムアウトによって、使用可能な接続が接続プールから削除されるまで、プールに存在している時間が決まります。有効値の範囲は、0からInteger.MAX_VALUEまでです。デフォルトは0です。値を0に設定すると、非アクティブ接続タイムアウト処理は無効になります。
• ds-cfg-initial-connection-pool-size(optional): integer(int32)
  デフォルト値: 0

  ConnectionPoolによって設定される初期の接続数。これは、プールの起動時に作成されてプールに配置される接続の数です。有効値の範囲は、0からInteger.MAX_VALUEまでです。これを最大プール・サイズより大きい値に設定すると無効になります。デフォルトは0です。
• ds-cfg-java-class: string
  デフォルト値: com.oracle.dps.server.workflowelement.rdbms.RDBMSExtension

  RDBMS拡張機能の実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-jdbc-connection-properties(optional): array ds-cfg-jdbc-connection-properties
  接続プロパティもサポートするDataSource接続ファクトリの名前と値のペアとしての、オプションのJDBCドライバ関連接続プロパティ。
• ds-cfg-jdbc-driver-class: string
  RDBMSベンダーにJDBCドライバの実装を提供するJavaクラスの完全修飾名を指定します。
• ds-cfg-jdbc-factory-properties(optional): boolean
  デフォルト値: false

  JDBCドライバ関連接続プロパティを接続ファクトリ・プロパティとして設定する必要があるかどうかを指定するオプションのフラグ。値ペア。
• ds-cfg-jdbc-keystore-prop-name(optional): string
  デフォルト値: javax.net.ssl.keyStore

  JDBCドライバのKeyStoreプロパティ名。
• ds-cfg-jdbc-keystore-pwd-prop-name(optional): string
  デフォルト値: javax.net.ssl.keyStorePassword

  JDBCドライバのKeyStoreパスワード・プロパティ名。
• ds-cfg-jdbc-keystore-type-prop-name(optional): string
  デフォルト値: javax.net.ssl.keyStoreType

  JDBCドライバのKeyStoreタイプ・プロパティ名。
• ds-cfg-jdbc-truststore-prop-name(optional): string
  デフォルト値: javax.net.ssl.trustStore

  JDBCドライバのTrustStoreプロパティ名。
• ds-cfg-jdbc-truststore-pwd-prop-name(optional): string
  デフォルト値: javax.net.ssl.trustStorePassword

  JDBCドライバのTrustStoreパスワード・プロパティ名。
• ds-cfg-jdbc-truststore-type-prop-name(optional): string
  デフォルト値: javax.net.ssl.trustStoreType

  JDBCドライバのTrustStoreタイプ・プロパティ名。
• ds-cfg-jdbc-url: string
  データベースに接続するためのJDBC URL。
• ds-cfg-login-timeout(optional): integer(int32)
  デフォルト値: 0

  データベースへの接続試行中に、このデータ・ソースが待機する最長時間(秒)を指定します。値が0のとき、デフォルトのシステム・タイムアウトが設定されている場合はその値になります。そうでない場合はタイムアウトしないことを意味します。
• ds-cfg-maximum-connection-pool-size(optional): integer(int32)
  デフォルト値: 20

  接続プールで設定できる最大接続数。最大接続数には、使用中の接続数と使用可能な接続数が含まれます。有効値の範囲は、1からInteger.MAX_VALUEまでです。デフォルトは20です。
• ds-cfg-minimum-connection-pool-size(optional): integer(int32)
  デフォルト値: 10

  接続プールによって設定される最小接続数を設定します。使用可能な接続数と使用中の接続数の合計が最小数未満の場合、接続はプールに戻されます。それ以外の場合、接続は閉じられます。有効値の範囲は、0からInteger.MAX_VALUEまでです。これを最大プール・サイズより大きい値に設定すると無効になります。デフォルトは10です。
• ds-cfg-rdbms-password(optional): string
  デフォルト値:

  接続を取得するためのパスワード。
• ds-cfg-rdbms-username: string
  接続を取得するためのユーザー名。
• ds-cfg-ssl-key-manager-provider(optional): string
  使用する鍵マネージャ・プロバイダを指定します。RDBMS拡張機能。この鍵マネージャ・プロバイダは必須ではなく、リモート・サーバーがクライアント認証用に構成されている場合に使用できます。
• ds-cfg-ssl-trust-manager-provider(optional): string
  使用する信頼マネージャ・プロバイダを指定します。RDBMS拡張機能。この信頼マネージャ・プロバイダは、リモート・バックエンドとセキュアな接続を確立する必要がある場合に必須です。
• ds-cfg-target-database(optional): string
  指定可能な値: [ "db2", "db2mainframe", "derby", "mysql", "mysql4", "oracle", "oracle10g", "oracle11", "oracle8i", "oracle9i", "postgresql", "sqlserver", "timesten" ]

  バックエンド内のターゲット・データベースを指定します。
• ds-cfg-use-ssl(optional): boolean
  デフォルト値: false

  データベースへのセキュアなJDBC接続を使用することを指定します。
• objectclass: array objectclass
  このエントリが属するオブジェクト・クラス。

{
    "type":"object",
    "required":[
        "objectclass",
        "ds-cfg-java-class",
        "ds-cfg-enabled",
        "ds-cfg-jdbc-driver-class",
        "ds-cfg-rdbms-username",
        "ds-cfg-jdbc-url"
    ],
    "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 RDBMS Extension implementation. ",
            "readOnly":false,
            "default":"com.oracle.dps.server.workflowelement.rdbms.RDBMSExtension",
            "type":"string"
        },
        "ds-cfg-jdbc-factory-properties":{
            "description":"Optional flag to specify if JDBC driver related connection properties need to be set as connection factory properties. value pair. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-jdbc-keystore-pwd-prop-name":{
            "description":"KeyStore password property name for the JDBC driver. ",
            "readOnly":false,
            "default":"javax.net.ssl.keyStorePassword",
            "type":"string"
        },
        "ds-cfg-target-database":{
            "description":"Specify the Target Database in the backend. ",
            "readOnly":false,
            "type":"string",
            "enum":[
                "db2",
                "db2mainframe",
                "derby",
                "mysql",
                "mysql4",
                "oracle",
                "oracle10g",
                "oracle11",
                "oracle8i",
                "oracle9i",
                "postgresql",
                "sqlserver",
                "timesten"
            ]
        },
        "ds-cfg-enabled":{
            "description":"Indicates whether the Extension is enabled. ",
            "readOnly":false,
            "type":"boolean"
        },
        "ds-cfg-connection-reuse-count":{
            "description":"Sets the maximum connection reuse count property. This property specifies the maximum number of times any connection can be reused after which the pool removes and closes a connection. The value must be greater than 0 for this feature to be enabled. For example, if the specified value is 100, then when a connection is reused or borrowed 100 times from the pool, it is closed and removed from the pool. Connections are closed gracefully after they are returned to the pool and the property value has been exceeded. Default is 0, which means this feature is not enabled. ",
            "readOnly":false,
            "default":0,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-rdbms-password":{
            "description":"The password with which connections have to be obtained. ",
            "readOnly":false,
            "default":"",
            "type":"string"
        },
        "ds-cfg-ssl-key-manager-provider":{
            "description":"Specifies key manager provider to use. RDBMS Extension This key manager provider is not mandatory and may be used if the remote server is configured for client authentication. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-maximum-connection-pool-size":{
            "description":"The maximum number of connections that can be setup by the connection pool. The maximum number of connections includes the number of connections that are in use as well as the number of available connections. The range of valid values is 1 to Integer.MAX_VALUE. Defaults to 20. ",
            "readOnly":false,
            "default":20,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-use-ssl":{
            "description":"Specifies to use secure JDBC connection to the database. ",
            "readOnly":false,
            "default":false,
            "type":"boolean"
        },
        "ds-cfg-jdbc-keystore-prop-name":{
            "description":"KeyStore property name for the JDBC driver. ",
            "readOnly":false,
            "default":"javax.net.ssl.keyStore",
            "type":"string"
        },
        "ds-cfg-login-timeout":{
            "description":"Sets the maximum time in seconds that this data source will wait while attempting to connect to a database. A value of zero specifies that the timeout is the default system timeout if there is one; otherwise, it specifies that there is no timeout. ",
            "readOnly":false,
            "default":0,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-jdbc-connection-properties":{
            "description":"Optional JDBC driver related connection properties as name value pair for DataSource connection factories that also support connection properties. ",
            "readOnly":false,
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "ds-cfg-ssl-trust-manager-provider":{
            "description":"Specifies trust manager provider to use. RDBMS Extension This trust manager provider is mandatory when secure connection needs to be established with the remote backend. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-jdbc-truststore-type-prop-name":{
            "description":"TrustStore type property name for the JDBC driver. ",
            "readOnly":false,
            "default":"javax.net.ssl.trustStoreType",
            "type":"string"
        },
        "ds-cfg-jdbc-keystore-type-prop-name":{
            "description":"KeyStore type property name for the JDBC driver. ",
            "readOnly":false,
            "default":"javax.net.ssl.keyStoreType",
            "type":"string"
        },
        "ds-cfg-jdbc-driver-class":{
            "description":"Specifies the fully-qualified name of the Java class that provides the JDBC driver implementation for the RDBMS vendor. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-connection-pool-provider":{
            "description":"The connection pool implementation to use for this extension. By default we use Universal Connection Pool (UCP). NOTE: In case Simple_Pool is used then the RDBMS Extension cannot be shared across multiple RDBMS WorkflowElements. ",
            "readOnly":false,
            "default":"universal-connection-pool",
            "type":"string",
            "enum":[
                "simple-pool",
                "universal-connection-pool"
            ]
        },
        "ds-cfg-rdbms-username":{
            "description":"The user name with which connections have to be obtained. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-jdbc-url":{
            "description":"JDBC URL for connecting to the database. ",
            "readOnly":false,
            "type":"string"
        },
        "ds-cfg-jdbc-truststore-prop-name":{
            "description":"TrustStore property name for the JDBC driver. ",
            "readOnly":false,
            "default":"javax.net.ssl.trustStore",
            "type":"string"
        },
        "ds-cfg-minimum-connection-pool-size":{
            "description":"Sets the minimum number of connections set up by the connection pool. If the number of available connections + the number of connections in use is less than the minimum then the connection is returned to the pool. Otherwise, the connection is closed. The range of valid values is 0 to Integer.MAX_VALUE. It is illegal to set this to a value greater than the maximum pool size. Defaults to 10. ",
            "readOnly":false,
            "default":10,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-inactive-connection-timeout":{
            "description":"Sets the inactive connection timeout. This timeout determines how long an available connection remains in the connection pool before it is removed from the pool. The range of valid values is 0 to Integer.MAX_VALUE. Defaults to 0. Setting the value to 0 disables inactive connection timeout processing. ",
            "readOnly":false,
            "default":0,
            "type":"integer",
            "format":"int32"
        },
        "ds-cfg-jdbc-truststore-pwd-prop-name":{
            "description":"TrustStore password property name for the JDBC driver. ",
            "readOnly":false,
            "default":"javax.net.ssl.trustStorePassword",
            "type":"string"
        },
        "ds-cfg-initial-connection-pool-size":{
            "description":"The initial number of connections setup by the ConnectionPool. This is the number of connections that will be created and placed in the pool when the pool is started. The range of valid values is 0 to Integer.MAX_VALUE. It is illegal to set this to a value greater than the maximum pool size. Defaults to 0. ",
            "readOnly":false,
            "default":0,
            "type":"integer",
            "format":"int32"
        }
    }
}

ネストされたスキーマ: ds-cfg-jdbc-connection-properties

型: array

接続プロパティもサポートするDataSource接続ファクトリの名前と値のペアとしての、オプションのJDBCドライバ関連接続プロパティ。

ソースを表示

• [0]: string

{
    "description":"Optional JDBC driver related connection properties as name value pair for DataSource connection factories that also support connection properties. ",
    "readOnly":false,
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: array

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

ソースを表示

• [0]: string

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

先頭に戻る