変更の始まり

Db2 REST サービスの作成

必要な権限を持っている場合、Db2® REST サービス・マネージャー API を使用して、新規ユーザー定義サービスを作成できます。

始める前に

サービスの作成時に、Db2 は、ユーザー、つまりサービスのデフォルト所有者として使用する許可 ID を識別します。 そのため、サービスを作成して関連パッケージをコレクションにバインドするために必要な特権を持っている必要があります。 例えば、サービスに組み込まれている SQL ステートメントの実行が許可されている必要があります。 Db2 REST サービスのパッケージの作成に必要な特権または権限については、BIND PACKAGE (DSN) を参照してください。

手順

  • サービスを作成するには、以下の URI を使用して、REST クライアントを介して HTTP/HTTPS POST 要求を発行します。
    POST https://host:port/services/DB2ServiceManager
  • 要求の HTTP ヘッダーの Accept フィールドおよび Content-Type フィールドを application/json に設定します。
  • 要求に以下の HTTP 本体を指定します。
    {
     "requestType": "createService",
     "sqlStmt": "sqlStatement",
     "collectionID": "serviceCollectionID",
     "serviceName": "serviceName",
     "description": "serviceDescription",
     "bindOption": "bindOptionValue",
    ...
     "bindOption": "bindOptionValue"
    }

    各変数の意味は次のとおりです。

    • createService は、新規サービスの作成を要求することを示します。
    • sqlStatement は、新規サービスに組み込む SQL ステートメントです。新規サービスごとに、単一の CALL、DELETE、INSERT、SELECT、TRUNCATE、UPDATE、WITH の各 SQL ステートメントを組み込むことができます。 サービスを作成する際に、Db2 は、サービスの呼び出しに使用するパッケージもバインドします。

      Db2 は、サービスのユーザー定義の SYSIBM.DSNSERVICE カタログ表に新しい行を追加し、バインドされたパッケージをディレクトリー内に保管します。 また、Db2 は、SYSIBM.SYSPACKAGE 表および SYSIBM.SYSPACKCOPY 表の HOSTLANG 列を 「R」に設定して、REST API のパッケージにマークを付けます。

    • serviceCollectionID は、新規サービスに関連付けられているパッケージのコレクション ID です。 serviceCollectionID プロパティーは、オプションです。 serviceCollectionID を指定すると、Db2 は、collectionID.serviceName の形式でパッケージに名前を付けます。 指定しないと、Db2 は、デフォルトの形式 SYSIBMSERVICE.serviceName を使用します。
    • serviceName は、作成する新規サービスの名前です。
    • serviceDescription は、新規サービスの簡単な説明です。serviceDescription プロパティーは、オプションです。指定した場合、Db2 は、その値を SYSIBM.DSNSERVICE カタログ表の DESCRIPTION 列に保管します。
    • bindOption は、新規サービスに関連付けられているパッケージをバインドするために指定するオプションです。 bindOption プロパティーは、オプションです。パッケージの既存の BIND オプションおよび REBIND オプションに加えて、Db2 REST サービスの新しい DATE、TIME、DEC、DECDEL、および STRDEL の各バインド・オプションを指定することもできます。

例

サービス simpleSelect1 を作成するには、以下の URI を入力して HTTPS POST 要求を開始します。

POST https://host:port/services/DB2ServiceManager

要求に以下の HTTP ヘッダー・フィールドを指定します。

Accept:application/json
Content-Type:application/json

要求に以下の HTTP 本体を指定します。

{
 "requestType": "createService",
 "sqlStmt": "SELECT DEPTNAME FROM DSN8B10.DEPT WHERE LOCATION = :LOCATION",
 "collectionID": "SYSIBMSERVICE",
 "serviceName": "simpleSelect1",
 "description": "Select department name based on location."
}

Db2 は、JSON で以下の応答を返します。

{
 "StatusCode":201,
 "StatusDescription":"DB2 Rest Service simpleSelect1 was created successfully.",
 "URL": "http://host:port/services/SYSIBMSERVICE/simpleSelect1"
}
この応答は、サービス simpleSelect1 が正常に作成されたことを示しています。
注: IBM® Data Studio クライアントを使用して、ユーザー定義サービスを作成することもできます。 手順については、IBM Data Studio クライアントを使用したユーザー定義のサービスの作成を参照してください。

Data Studio クライアントを使用してサービスを作成およびデプロイする場合は、新規サービスに固有のコレクション ID を指定することはできません。 代わりに、Db2 は、デフォルトの形式 SYSIBMSERVICE.serviceName を使用してサービスを識別します。さらに、サービス用の z/OS® Connect サーバーへの接続をセットアップする場合は、Db2 サブシステムの IP アドレスとポート番号を使用する必要があります。

変更の終わり