IBM Tivoli Netcool/OMNIbusnObjectServer HTTP CtFX tXEKCh...Netcool/OMNIbus バージョン 8 リリース 1 ObjectServer HTTP インターフェースリファレンス・ガイド

Netcool/OMNIbusバージョン 8 リリース 1

ObjectServer HTTP インターフェースリファレンス・ガイド

SA88-5313-04

IBM

注記

本書および本書で紹介する製品をご使用になる前に、 65 ページの『特記事項』に記載されている情報をお読みください。

本書は、IBM Tivoli Netcool/OMNIbus (製品番号 5724-S44) バージョン 8 リリース 1、および新しい版で明記されていない限り、以降のすべてのリリースおよびモディフィケーションに適用されます。

お客様の環境によっては、資料中の円記号がバックスラッシュと表示されたり、バックスラッシュが円記号と表示されたりする場合があります。

原典： SC27-5612-04Netcool/OMNIbusVersion 8 Release 1ObjectServer HTTP Interface Reference Guide

発行：日本アイ・ビー・エム株式会社

担当：トランスレーション・サービス・センター

© Copyright IBM Corporation 1994, 2017.

目次

本書について . . . . . . . . . . . . . v対象読者. . . . . . . . . . . . . . . . v資料 . . . . . . . . . . . . . . . . . vアクセシビリティー . . . . . . . . . . . viiTivoli 技術研修 . . . . . . . . . . . . . viiサポート情報 . . . . . . . . . . . . . . vii本書の規則 . . . . . . . . . . . . . . viii略語リスト . . . . . . . . . . . . . . xii

第 1 章 ObjectServer HTTP インターフェースの概要 . . . . . . . . . . . . . 1ObjectServer で HTTP インターフェースと OSLCインターフェースを使用可能にする . . . . . . . 1

HTTP インターフェースと OSLC インターフェースを制御する ObjectServer プロパティー . . . . 3チャンク送信エンコード . . . . . . . . . 6拡張 ObjectServer HTTP インターフェースの構成 7

IBM JazzSM サービス・プロバイダー・レジストリーの使用可能化と構成 . . . . . . . . . . . . 9

registry.oslc 表 . . . . . . . . . . . . 10

第 2 章 HTTP インターフェースの URI 13表収集サービス . . . . . . . . . . . . . 13

表収集サービス GET 要求 . . . . . . . . 13表収集サービス: GET 応答 . . . . . . . . 14表収集サービス POST 要求 . . . . . . . . 15表収集サービス POST への応答 . . . . . . 16表収集サービス PATCH 要求 . . . . . . . 17表収集サービス: PATCH 応答 . . . . . . . 18表収集サービス DELETE 要求 . . . . . . . 19表収集サービス DELETE への応答 . . . . . 19

行エレメントのサービス . . . . . . . . . . 20行エレメント GET 要求 . . . . . . . . . 24行エレメント GET への応答 . . . . . . . 24行エレメント PATCH 要求 . . . . . . . . 25行エレメント PATCH への応答 . . . . . . 26行エレメント DELETE 要求 . . . . . . . . 27行エレメント DELETE への応答 . . . . . . 27

SQL コマンド・ファクトリー . . . . . . . . 29SQL コマンド・ファクトリー POST 要求 . . . 29SQL コマンド・ファクトリー POST への応答 . 30

システム情報サービス . . . . . . . . . . . 31GET 収集の要求 . . . . . . . . . . . . 31GET 収集応答 . . . . . . . . . . . . 32GET 要求のエレメント . . . . . . . . . 33GET 応答のエレメント . . . . . . . . . 33

第 3 章共通の動作 . . . . . . . . . 35HTTP と HTTPS サポート . . . . . . . . . 35HTTP 応答コード . . . . . . . . . . . . 35

照会パラメーター . . . . . . . . . . . . 36認証メカニズム . . . . . . . . . . . . . 37成功 JSON メッセージ・ペイロード . . . . . . 38エラー JSON メッセージ・ペイロード . . . . . 38メッセージの暗号化 . . . . . . . . . . . 39Accept MIME タイプ . . . . . . . . . . . 39コンテンツ MIME タイプ . . . . . . . . . 39応答のキャッシング . . . . . . . . . . . 39

付録 A. JSON ペイロードの例 . . . . . 41JSON 行セット GET の例 . . . . . . . . . 41JSON 行セット PATCH の例 . . . . . . . . 42JSON 行セット POST の例 . . . . . . . . . 43SQL コマンド・ファクトリー: POST の例 . . . . 44JSON 成功メッセージの例 . . . . . . . . . 44JSON エラー・メッセージの例 . . . . . . . . 44JSON パスワード変更の例 . . . . . . . . . 45

付録 B. HTTP 要求と応答の例 . . . . . 47表収集 POST 要求の例 . . . . . . . . . . 47表収集 POST への応答の例 . . . . . . . . . 48表収集 GET 要求の例 . . . . . . . . . . . 48表収集 GET への応答の例 . . . . . . . . . 48表収集 PATCH 要求の例. . . . . . . . . . 50表収集 PATCH への応答の例 . . . . . . . . 51表収集 DELETE 要求の例 . . . . . . . . . 51表収集 DELETE への応答の例 . . . . . . . . 51RowSerial による行エレメント GET 要求の例 . . 51RowSerial による行エレメント GET への応答の例 51KeyField による行エレメント GET 要求の例 . . . 54キー・フィールドによる行エレメント GET への応答の例 . . . . . . . . . . . . . . . . 54行エレメント PATCH 要求の例 . . . . . . . 56行エレメント PATCH への応答の例 . . . . . . 57行エレメント DELETE 要求の例 . . . . . . . 57行エレメント DELETE への応答の例 . . . . . . 57SQL コマンド・ファクトリー POST 要求の例 . . 57SQL コマンド・ファクトリー POST への応答の例 58システム情報 GET 要求の例 . . . . . . . . 58システム情報 GET への応答の例 . . . . . . . 58システム情報エレメント GET 要求の例 . . . . . 59システム情報エレメント GET への応答の例 . . . 59MIME タイプ設定と HTTP ヘッダーを備えたJSON 構成ファイル . . . . . . . . . . . 59

付録 C. 略語リスト. . . . . . . . . . 63

特記事項 . . . . . . . . . . . . . . 65商標 . . . . . . . . . . . . . . . . . 68

© Copyright IBM Corp. 1994, 2017 iii

iv IBM Tivoli Netcool/OMNIbus: ObjectServer HTTP インターフェースリファレンス・ガイド

本書について

Tivoli Netcool/OMNIbus は、複雑なネットワークと IT ドメインをリアルタイムに一元的にモニターするサービス・レベル管理 (SLM) システムです。

「IBM Tivoli Netcool/OMNIbus ObjectServer HTTP インターフェースリファレンス・ガイド」では、ObjectServer HTTP インターフェースと呼ばれるアプリケーション・プログラミング・インターフェース (API) の URI および共通の動作を説明します。API を使用可能にする方法を説明し、JSON ペイロードおよび HTTP 要求と応答の例を提供します。

対象読者この資料は、Tivoli Netcool/OMNIbus の構成を担当する管理者を対象としています。

資料このセクションでは、Tivoli Netcool/OMNIbus ライブラリーの資料および関連資料をリストします。またこのセクションでは、Tivoli 資料にオンラインでアクセスする方法と、Tivoli の資料を注文する方法についても説明します。

Tivoli Netcool/OMNIbus ライブラリー

以下の資料を Tivoli Netcool/OMNIbus ライブラリーから入手できます。

v IBM Tivoli Netcool/OMNIbus インストールとデプロイメント・ガイド,

Tivoli Netcool/OMNIbus のインストールおよびアップグレード手順を含み、セキュリティーおよびコンポーネント通信の構成方法を説明します。また、TivoliNetcool/OMNIbus アーキテクチャーの例が含まれており、その実装方法について説明します。

v IBM Tivoli Netcool/OMNIbus 管理ガイド,

Tivoli Netcool/OMNIbus 管理者 GUI、コマンド行ツール、およびプロセス制御を使用して管理用タスクを実行する方法を説明します。また、ObjectServerSQL の構文および自動化の説明と例も含まれています。

v IBM Tivoli Netcool/OMNIbus Web GUI 管理およびユーザーズ・ガイド,

Tivoli Netcool/OMNIbus Web GUI を使用した、管理タスクおよびイベント視覚化タスクの実行方法が記載されています。

v IBM Tivoli Netcool/OMNIbus ユーザーズ・ガイド,

デスクトップ・ツールについて概説し、これらのツールを使用したイベント管理に関連したオペレーター・タスクについて説明します。

v IBM Tivoli Netcool/OMNIbus プローブとゲートウェイ・ガイド,

© Copyright IBM Corp. 1994, 2017 v

プローブ・ルール・ファイル構文やゲートウェイ・コマンドなどの、プローブおよびゲートウェイに関する概説および参照情報が含まれています。

v IBM Tivoli Monitoring for Tivoli Netcool/OMNIbus Agent ユーザーズ・ガイド,

Tivoli Netcool/OMNIbus のヘルス・モニター・エージェントのインストール方法についての説明、およびそのエージェントに関する参照情報が記載されています。

v IBM Tivoli Netcool/OMNIbus Event Integration Facility リファレンス,

ご使用のネットワーク環境および貴社固有のニーズに合わせて調整されたイベント・アダプターを開発する方法について説明しています。この資料では、ソースでイベントをフィルター処理する方法についても説明しています。

v IBM Tivoli Netcool/OMNIbus エラー・メッセージ・ガイド,

Tivoli Netcool/OMNIbus のシステム・メッセージおよびそれらのメッセージへの対処方法について説明しています。

v IBM Tivoli Netcool/OMNIbus Web GUI Administration API (WAAPI) ユーザーズ・ガイド,

WAAPI と呼ばれる XML アプリケーション・プログラミング・インターフェースを使用して Tivoli Netcool/OMNIbus Web GUI を管理する方法を示します。

v IBM Tivoli Netcool/OMNIbus ObjectServer HTTP インターフェースリファレンス・ガイド, ObjectServer HTTP インターフェースと呼ばれるアプリケーション・プログラミング・インターフェース (API) の URI および共通の動作を説明します。API を使用可能にする方法を説明し、JSON ペイロード、および HTTP要求と応答の例を提供します。

v IBM Tivoli Netcool/OMNIbus ObjectServer OSLC インターフェースリファレンス・ガイド, ObjectServer OSLC インターフェースと呼ばれる Open Servicesfor Lifecycle Collaboration (OSLC) アプリケーション・プログラミング・インターフェース (API) のサービス、リソース、および共通の動作を説明します。API を使用可能にする方法を説明し、サービス・プロバイダー定義、RDF/XMLペイロード、および HTTP 要求と応答の例を提供します。

他の IBM 製品 (DB2、IBM Tivoli Monitoring、Tivoli Common Reporting など) を使用して、Tivoli Netcool/OMNIbus の機能を拡張する場合は、その製品のインフォメーション・センターを参照して、関連資料を入手してください。

用語集へのオンライン・アクセス

利便性を高めるために、「IBM Terminology」Web サイトで IBM 製品ライブラリーの用語を一元管理しています。「IBM Terminology」Web サイトには以下のWeb アドレスからアクセスできます。

http://www.ibm.com/software/globalization/terminology

vi IBM Tivoli Netcool/OMNIbus: ObjectServer HTTP インターフェースリファレンス・ガイド

http://www.ibm.com/software/globalization/terminology

資料へのオンライン・アクセス

IBM では、この製品およびその他のすべての Tivoli 製品に関する資料を、使用可能になった時点および更新された時点で、以下の Tivoli ダウンロード・サイトに載せています。

ftp://public.dhe.ibm.com/software/tivoli/Netcool/NetcoolOmnibus/library/

注: PDF 文書をレターサイズ以外の用紙に印刷する場合は、Adobe Reader のメニューから「ファイル」 > 「印刷」ウィンドウでオプションを設定し、レターサイズのページをご使用の用紙に印刷できるようにしてください。

アクセシビリティーアクセシビリティー機能は、運動障害または視覚障害など身体に障害を持つユーザーがソフトウェア・プロダクトを快適に使用できるようにサポートします。

この製品では、音声によりインターフェースをナビゲートできる支援技術を使用できます。また、マウスの代わりにキーボードを使用して、グラフィカル・ユーザー・インターフェースの複数の機能を操作できます。

Tivoli® 技術研修

以下は英語のみの対応となります。Tivoli技術研修の情報については、以下の IBMTivoli Education Web サイトを参照してください。

http://www.ibm.com/software/tivoli/education

サポート情報ご使用の IBM ソフトウェアに問題がある場合は、速やかに解決する必要があります。IBM は、お客様が必要とされているサポートを受けられるよう、以下の方法を提供しています。

オンラインIBM ソフトウェア・サポート・サイト http://www.ibm.com/software/support/probsub.html にアクセスし、指示に従います。

IBM Support AssistantIBM Support Assistant (ISA) は、IBM ソフトウェア・プロダクトに関する疑問や問題を解決する上で役に立つ、無料のローカル・ソフトウェア・サービス・ワークベンチです。ISA を利用すると、問題判別のためのサポート関連情報と保守性ツールに素早くアクセスできます。ISA ソフトウェアをインストールするには、http://www.ibm.com/software/support/isa にアクセスしてください。

資料このガイドの内容や編成を改善するためのご意見については、以下の TivoliNetcool/OMNIbus 資料開発チームにお送りください。

mailto://[email protected]

本書について vii

ftp://public.dhe.ibm.com/software/tivoli/Netcool/NetcoolOmnibus/library/http://www.ibm.com/software/tivoli/educationhttp://www.ibm.com/software/support/probsub.htmlhttp://www.ibm.com/software/support/probsub.htmlhttp://www.ibm.com/software/support/isamailto://[email protected]

本書の規則本書では、特別な用語および操作、ならびにオペレーティング・システム固有のコマンドおよびパスについて、いくつかの規則を使用しています。

オペレーティング・システムに依存する変数およびパス

本書では、環境変数の指定やディレクトリー表記に UNIX の規則を使用します。

Windows コマンド行を使用する場合、環境変数では $variable を %variable% に置き換え、ディレクトリーのパスでは各スラッシュ (/) を円記号 (¥) に置き換えてください。例えば、UNIX システムで、$NCHOME 環境変数は Netcool® ホーム・ディレクトリーのパスを示します。Windows システムでは、%NCHOME% 環境変数が Netcool ホーム・ディレクトリーのパスを示します。環境変数の名前は、Windows 環境と UNIX 環境で必ずしも同じではありません。例えば、Windows環境の %TEMP% は、UNIX 環境の $TMPDIR に相当します。

Windows システムで bash シェルを使用している場合は、UNIX 規則を使用できます。

Netcool ホーム・ロケーション

Netcool ホーム・ロケーションとは、Tivoli Netcool/OMNIbus がインストールされる基本ディレクトリーです。Netcool ホーム・ロケーションは、NCHOME 環境変数によって定義されます。NCHOME の値は以下のとおりです。

v UNIX Linux $NCHOME のデフォルト値は /opt/IBM/tivoli/netcool です。

v Windows %NCHOME% のデフォルト値は C:¥IBM¥Tivoli¥Netcool です。

ディレクトリーやコマンドのパスが NCHOME 変数で始まる場合、その情報はサポートされるオペレーティング・システムすべてに適用されます。

NCHOME 環境変数を使用する他の製品 (IBM Tivoli Network Manager IPEdition など) を Netcool ホーム・ロケーションにインストールできます。各製品は、固有のコンポーネントやファイルを、Netcool ホーム・ロケーション内の専用の product サブディレクトリーにインストールします。すべての製品に共通のファイルは、Netcool ホーム・ロケーション内の共用サブディレクトリーにインストールされます。

オペレーティング・システムに依存するディレクトリー名

Tivoli Netcool/OMNIbus ファイルが NCHOME の下の arch ディレクトリー内に存在すると示されている場合、arch は、次の表に示すように、ご使用のオペレーティング・システム・ディレクトリーを表す変数です。

表 1. arch 変数のディレクトリー名

arch によって表されるディレクトリー名オペレーティング・システム

aix5 AIX® システム

hpux11hpia HP-UX Itanium ベースのシステム

linux2x86 Red Hat Linux および SUSE システム

viii IBM Tivoli Netcool/OMNIbus: ObjectServer HTTP インターフェースリファレンス・ガイド

表 1. arch 変数のディレクトリー名 (続き)

arch によって表されるディレクトリー名オペレーティング・システム

linux2s390 Linux for System z®

solaris2 Solaris システム

win32 Windows システム

OMNIHOME のロケーション

プローブとゲートウェイ、および以前のバージョンの Tivoli Netcool/OMNIbus では、 OMNIHOME 環境変数が多くの構成ファイルで使用されています。OMNIHOME の値は以下のように設定します。

v UNIX Linux $OMNIHOME を $NCHOME/omnibus に設定します。

v Windows %OMNIHOME% を %NCHOME%¥omnibus に設定します。

Web GUI のホーム・ディレクトリー

WEBGUI_HOMEWeb GUI がインストールされているディレクトリーを指します。このディレクトリーは、Web GUI ホーム・ディレクトリーとして知られています。デフォルトは以下のとおりです。

UNIX

Linux

/opt/IBM/tivoli/netcool/omnibus_webgui

Windows C:¥IBM¥tivoli¥netcool¥omnibus_webgui

Web GUI ホーム・ディレクトリーは、 Jazz for Service Management ホーム・ディレクトリーとは異なります。

Jazz for Service Management のホーム・ディレクトリー

WAS_HOMEWebSphere Application Server がインストールされているロケーションを指します。このロケーションは、インストール時に指定できます。デフォルトは以下のとおりです。

UNIX

Linux

/opt/IBM/WebSphere/AppServer

Windows C:¥Program Files¥IBM¥WebSphere¥AppServer

JazzSM_HOMEJazz for Service Management がインストールされているロケーションを指します。このロケーションは、インストール時に指定できます。デフォルトは以下のとおりです。

UNIX

Linux

/opt/IBM/JazzSM

Windows C:¥Program Files¥IBM¥JazzSM

JazzSM_WAS_ProfileJazz for Service Management に使用されているアプリケーション・サーバ

本書について ix

ー・プロファイルのロケーションを指します。このロケーションは、Jazzfor Service Management ホーム・ディレクトリーの /profile/ サブディレクトリー内にあります。

UNIX

Linux

/opt/IBM/JazzSM/profile

Windows C:¥Program Files¥IBM¥JazzSM¥profile

DASH_HOMEDashboard Application Services Hub がインストールされているロケーションを指します。このロケーションは、インストール時に指定できます。デフォルトは以下のとおりです。

UNIX

Linux

/opt/IBM/JazzSM/ui

Windows C:¥Program Files¥IBM¥JazzSM¥ui

他の Jazz for Service Management インストール・ディレクトリーについては、Jazz for Service Management インフォメーション・センター(http://www-01.ibm.com/support/knowledgecenter/SSEKCU/welcome) を参照してください。

キューイング・グラフィックの規則

Tivoli Netcool/OMNIbus の資料には、トピックまたは説明の一部分が特定の条件下でのみ適用されることを示すキューイング・グラフィックが含まれています。以下の表に、各グラフィックの意味を示します。

表 2. Tivoli Netcool/OMNIbus のキューイング・グラフィック

グラフィック説明

PureDataWeb GUI テキストまたは説明は、Web GUI コンポーネントにのみ適用されます。

UNIX テキストまたは説明は、UNIX オペレーティング・システム (AIX およびSolaris を含む) にのみ適用されます。以下のキューイング・グラフィックは、必要な場合、AIX および Solaris に使用されます。

AIX

Solaris

Linux テキストまたは説明は、Linux オペレーティング・システムにのみ適用されます。

Windows テキストまたは説明は、Windows オペレーティング・システムにのみ適用されます。

32-bit テキストまたは説明は、32 ビット・オペレーティング・システムにのみ適用されます。

64-bit テキストまたは説明は、64 ビット・オペレーティング・システムにのみ適用されます。

FIPS 140-2 テキストまたは説明は、FIPS 140-2 暗号化の使用または構成にのみ適用されます。

Default テキストまたは説明は、デフォルト動作を記述しているか、デフォルト構成にのみ適用されます。

x IBM Tivoli Netcool/OMNIbus: ObjectServer HTTP インターフェースリファレンス・ガイド

http://www-01.ibm.com/support/knowledgecenter/SSEKCU/welcome

表 2. Tivoli Netcool/OMNIbus のキューイング・グラフィック (続き)

グラフィック説明

Fix Pack 1 テキストまたは説明は、グラフィックで示されているフィックスパック番号にのみ適用されます。テキストで記述されている機能または機能拡張は、示されているフィックスパックのインストール後にのみ使用できます。

注: サーバー・コンポーネントのフィックスパックと Web GUI コンポーネントのフィックスパックは、別々にリリースされます。Web GUI のフィックスパックは、以下のように示されます。

PureDataWeb GUI

Fix Pack 1

Administrator テキストまたは説明は、Web GUI 管理者にのみ適用されます。つまり、ncw_user 役割と ncw_admin 役割が割り当てられているユーザーです。

C テキストまたは説明は、C プログラミング言語にのみ適用されます。

Java テキストまたは説明は、Java™ プログラミング言語にのみ適用されます。

書体の規則

本書では、以下の書体の規則を使用します。

太字

v 周囲のテキストとの区別が難しい小文字コマンドおよび大/小文字混合コマンド

v インターフェース・コントロール (チェック・ボックス、プッシュボタン、ラジオ・ボタン、スピン・ボタン、フィールド、フォルダー、アイコン、リスト・ボックス、リスト・ボックス内の項目、複数列のリスト、コンテナー、メニュー選択、メニュー名、タブ、プロパティー・シート)、ラベル (「ヒント:」、および「オペレーティング・システムの考慮事項:」など)

v 本文中のキーワードおよびパラメーター

イタリック

v 引用 (例: 資料、ディスケット、および CD のタイトル)

v 本文中で定義される語句 (例: 非交換回線は Point-to-Point 回線と呼ばれます)

v 語句および文字の強調 (語単位の強調の例: 「語 that は制限節を導くために使用します。」、文字単位の強調の例: 「LUN アドレスの先頭文字には、文字 L を使用してください。」)

v 本文中の新規用語 (定義リスト内を除く): ビューは、データが含まれたワークスペース内のフレームです。

v 入力する必要がある変数および値: ... ここで myname は .... を表します。

モノスペース

v 例およびコード例

本書について xi

v 周囲のテキストから区別するのが困難なファイル名、プログラミング・キーワード、およびその他のエレメント

v ユーザー宛のメッセージ・テキストおよびプロンプト

v ユーザーが入力する必要があるテキスト

v 引数またはコマンド・オプションの値

略語リストObjectServer HTTP インターフェースおよび ObjectServer OSLC インターフェースの API 資料では、以下の略語と用語を使用します。

HTTP Hyper Text Transfer Protocol (ハイパーテキスト転送プロトコル)。HTTPバージョン 1.1 は、RFC2616 で規定されています。別に記述されていない場合は、用語 HTTP は本書では HTTP と HTTPS の両方を意味します。

HTTPSHyper Text Transfer Protocol Secure (RFC 2818 で規定)。

JazzSMJazz for Service Management。https://www.ibm.com/developerworks/mydeveloperworks/groups/service/html/communityview?communityUuid=69ec672c-dd6b-443d-add8-bb9a9a490ebaから入手できます。

JSON JavaScript Object Notation (ECMA-262 で規定)。

MIMEMultipurpose Internet Mail Extensions。「IANA MIME Media Types」で定義されている MIME メディア・タイプ。

OSLC Open Services for Lifecycle Collaboration (http://open-services.netで規定)。

REST Representational State Transfer (「Architectural Styles and the Design ofNetwork-based Software Architectures」で起草され、非公式に規定)。

URI Uniform Resource Identifier (統一資源識別子)(RFC 3986 で規定)。

XML eXtensible Markup Language (拡張可能なマーク付け言語)(W3C で規定)。

xii IBM Tivoli Netcool/OMNIbus: ObjectServer HTTP インターフェースリファレンス・ガイド

https://www.ibm.com/developerworks/mydeveloperworks/groups/service/html/communityview?communityUuid=69ec672c-dd6b-443d-add8-bb9a9a490ebahttps://www.ibm.com/developerworks/mydeveloperworks/groups/service/html/communityview?communityUuid=69ec672c-dd6b-443d-add8-bb9a9a490ebahttps://www.ibm.com/developerworks/mydeveloperworks/groups/service/html/communityview?communityUuid=69ec672c-dd6b-443d-add8-bb9a9a490ebahttp://open-services.net

第 1 章 ObjectServer HTTP インターフェースの概要

HTTP インターフェースは、ObjectServer でホストされる軽量のアプリケーション・プログラミング・インターフェース (API) です。HTTP インターフェースは、HTTP を使用する構造化 URI 形式を使用して、ObjectServer 内の表データへのアクセスを提供します。POST、PATCH、GET、および DELETE の要求。要求は、表 URI または行 URI に対してサポートされます。URI へのアクセスは、基本HTTP 認証を使用して既知の ObjectServer ユーザーによって認証されます。インターフェースは、HTTPS 接続で保護することができます。インターフェースは、ObjectServer でプロパティーを設定することで使用可能にすることができます。

ObjectServer は、OSLC インターフェースと呼ばれる別の API をホストします。この API は、リソースにリンクされたイベントのデータ・ビュー、関連ジャーナル、および詳細リソースを提供するイベント・サーバー・プロバイダーです。OSLCインターフェースについて詳しくは、「IBM Tivoli Netcool/OMNIbus ObjectServerOSLC インターフェースリファレンス・ガイド」を参照してください。

基本 URI

HTTP インターフェースの基本 URI は、次のとおりです。

http://host:port/objectserver/restapi/

関連タスク:

『ObjectServer で HTTP インターフェースと OSLC インターフェースを使用可能にする』ObjectServer の HTTP インターフェースと OSLC インターフェースは、そのインターフェースがセキュアなセットアップ用に構成される必要があるため、デフォルトで使用不能になっています。

ObjectServer で HTTP インターフェースと OSLC インターフェースを使用可能にする

ObjectServer の HTTP インターフェースと OSLC インターフェースは、そのインターフェースがセキュアなセットアップ用に構成される必要があるため、デフォルトで使用不能になっています。

始める前に

現在の環境で、HTTP または HTTPS 経由でアクセスする必要がある ObjectServerを特定します。環境内のすべての ObjectServer について、HTTP ベースのメカニズムによる ObjectServer データへのアクセス権限を付与する必要はありません。

このタスクについて

ObjectServer の HTTP インターフェースと OSLC インターフェースのホスティングには、内蔵 HTTP サーバーが必要なため、ObjectServer は HTTP クライアントにファイルをサービスできます。その ObjectServer はページをサービスすることはできますが、Apache Web サーバーとは異なり、ページをサービスするための最適

© Copyright IBM Corp. 1994, 2017 1

化はされていません。そのため、ObjectServer を使用して、基本的な HTML ページや JavaScript ページ以外のページをホストしないでください。

手順1. インターフェースを使用可能にするには、NRestOS.Enable プロパティーを TRUE

に設定します。

2. インターフェースが HTTP ポート上でアクティブになるように内蔵 HTTP サーバーを構成するには、接続タイプに listen ポートを指定します。例えば、インターフェースをポート 8080 で listen させるには、プロパティーを次のように設定します。

NHttpd.EnableHTTP : TRUENHttpd.ListeningPort : 8080

3. インターフェースを 9090 の HTTPS ポート上でアクティブにするには、プロパティーを以下の例のように設定します。 HTTPS ポートは SSL で暗号化されるため、適切な証明書を持つ証明書ファイルを作成してパスワードで保護する必要があります。

NHttpd.SSLEnable : TRUENHttpd.SSLListeningPort : 9090NHttpd.SSLCertificate : "certificatelabel"

4. ObjectServer からのファイル・サービスを使用可能にするには、NHttpd.EnableFileServing プロパティーを設定します。サービスされるページのルートは、NHttpd.DocumentRoot プロパティーで定義されます。

5. Collection リソース・インスタンスと ResponseInfo リソース・インスタンスの両方で、イベント、ジャーナル、および詳細照会機能応答の RDF/XML ペイロードにメンバー・リソース参照リストを生成するには、NRestOS.OSLCRDFMsgFormat を「MIGRATION」に設定します。このパラメーター、およびこのパラメーターを設定する必要がある理由について詳しくは、リリース情報の『HTTP インターフェースおよび OSLC インターフェースの更新』セクションを参照してください。

関連概念:

1 ページの『第 1 章 ObjectServer HTTP インターフェースの概要』HTTP インターフェースは、ObjectServer でホストされる軽量のアプリケーション・プログラミング・インターフェース (API) です。HTTP インターフェースは、HTTP を使用する構造化 URI 形式を使用して、ObjectServer 内の表データへのアクセスを提供します。POST、PATCH、GET、および DELETE の要求。要求は、表 URI または行 URI に対してサポートされます。URI へのアクセスは、基本HTTP 認証を使用して既知の ObjectServer ユーザーによって認証されます。インターフェースは、HTTPS 接続で保護することができます。インターフェースは、ObjectServer でプロパティーを設定することで使用可能にすることができます。

関連資料:

6 ページの『チャンク送信エンコード』大容量の結果セットをうまく制御するために、JSON 応答ペイロードと RDF/XML応答ペイロードは、チャンク送信エンコードを使用して、チャンクとしてクライアントにストリームして返すことができます。

2 IBM Tivoli Netcool/OMNIbus: ObjectServer HTTP インターフェースリファレンス・ガイド

HTTP インターフェースと OSLC インターフェースを制御するObjectServer プロパティー

HTTP インターフェースと OSLC インターフェースを制御する ObjectServer プロパティーについて説明します。

次の表は、HTTP インターフェースと OSLC インターフェースを制御するObjectServer プロパティーのリストです。

表 3. HTTP インターフェースおよび OSLC インターフェースを制御する、プロパティーおよびコマンド行オプション

プロパティーコマンド行オプション説明

NRestOS.Enable TRUE |

FALSE

-nrestosenable TRUE |

FALSE

ObjectServer への HTTP インターフェースおよび OSLCインターフェースを有効にします。

デフォルトは FALSE です。これはインターフェースが無効であることを意味します。

NRestOS.OSLCResource

ConfigFile string-nrestososlcrescfg string OSLC リソース構成ファイル

のパス。この JSON ファイルは、列を ObjectServer スキーマから OSLC イベント・ドメインのプロパティーにマップする方法を定義します。

デフォルトは$OMNIHOME/etc/restos/

resourcecfg.json です。

次の表は、内蔵 HTTP サーバーを制御する ObjectServer プロパティーのリストです。

表 4. 内蔵 HTTP サーバーを制御するためのプロパティーとコマンド行オプション


NHttpd.AccessLog string -nhttpd_accesslog string サーバーが処理するすべての要求をログ記録するログ・ファイルの名前と場所を指定します。

デフォルトは$OMNIHOME/log/

NCOMS_http_access.log です。

第 1 章概要 3

表 4. 内蔵 HTTP サーバーを制御するためのプロパティーとコマンド行オプション (続き)


NHttpd.Authentication

Domain string-nhttpd_authdomain string 認証詳細を HTTP 接続また

は HTTPS 接続で要求するときに使用する認証ドメインを指定します。

デフォルトは omnibus です。

NHttpd.ConfigFile string -nhttpd_configfile string JSON 構成ファイルへのパスを指定します。

デフォルトは$OMNIHOME/etc/

libnhttpd.json です。これは、HTTP 応答ファイル内のmimeType 設定およびHTTP ヘッダーを使用可能にします。

libnhttpd.json 構成ファイルについて詳しくは、 7 ページの『拡張 ObjectServerHTTP インターフェースの構成』を参照してください。

NHttpd.DocumentRoot string -nhttpd_docroot string 内蔵 Web サービスの文書ルートを指定します。

デフォルトは$OMNIHOME/etc/restos/

docroot です。

NHttpd.EnableFileServing

TRUE | FALSE

-nhttpd_enablefs TRUE |

FALSE

このプロパティーを使用して、ObjectServer によるデフォルトのファイル・サービス提供を有効にします。これによって、ObjectServer はローカル・ファイル・システムのファイルを提供する単純HTTP サーバーとして動作可能になります。

デフォルトは FALSE です。

NHttpd.ExpireTimeout

unsigned-nhttpd_exptimeout unsigned HTTP 1.1 接続をドロップせ

ずにアイドル状態を保つ最大時間を秒単位で指定します。

デフォルトは 15 です。




NHttpd.ListeningHostname

string-nhttpd_hostname string ObjectServer の HTTP また

は HTTPS インターフェースの URI のホスト名部分として使用する、listen 先ホスト名または IP アドレスを指定します。

デフォルトは hostname です。

NHttpd.SSLListeningPort

integer-nhttpd_sslport integer ObjectServer が HTTPS 要求

を listen するポートを指定します。

デフォルトは 0 です。

NHttpd.SSLCertificate

string-nhttpd_sslcert string サーバーの SSL 証明書の名

前を指定します。

デフォルトは '' です。

NHttpd.SSLEnable TRUE |

FALSE

-nhttpd_sslenable TRUE |

FALSE

SSL サポートの使用を有効にします。

デフォルトは FALSE です。

第 1 章概要 5



NRestOS.OSLCRDFMsgFormat

stringnrestososlcrmf string このプロパティーをストリン

グ MIGRATION に設定して、ObjectServer OSLC インターフェースに基づくユーティリティーを再作成すると、メンバーのリソース参照リストが、イベント、詳細、およびジャーナル照会機能のRDF/XML ペイロードのResponseInfo リソース・インスタンスではなく、Collection リソース・インスタンスに生成されます。

MIGRATION 設定は、メンバー・リソース参照リストが、Collection リソース・インスタンスと ResponseInfo リソース・インスタンスの両方で生成されることを意味します。OSLC ユーティリティーを再作成して、Collectionリソース・インスタンスのみでメンバー・リソース参照リストを生成してください。ResponseInfo リソース・インスタンスでリストを生成するコードが削除された後、このプロパティーをリセットしてください。

ObjectServer のプロパティーおよびコマンド行オプションの詳細については、「IBM Tivoli Netcool/OMNIbus 管理ガイド」を参照してください.

チャンク送信エンコード大容量の結果セットをうまく制御するために、JSON 応答ペイロードと RDF/XML応答ペイロードは、チャンク送信エンコードを使用して、チャンクとしてクライアントにストリームして返すことができます。

チャンクの有効化/無効化は、サーバー構成 JSON ファイル $OMNIHOME/etc/restos/servercfg.json のチャンク・セクションで設定可能です。また、チャンク・サイズや、チャンクに使用するのに十分な大きさであると識別される結果セットの行数を定義することができます。デフォルト値は以下のとおりです。

{"chunking" : {

"enabled" : true,


"rowSetSize" : 50,"size" : 52428

}}

チャンク値として使用可能なものは以下のとおりです。

v enabled: チャンク機能を有効化/無効化します。デフォルトは True です。

v rowSetSize: チャンクであるとみなされる結果セットの行数。デフォルトは 50です。

v size: 使用するチャンクのサイズ。デフォルトは 50K base 2 です。

関連タスク:

1 ページの『ObjectServer で HTTP インターフェースと OSLC インターフェースを使用可能にする』ObjectServer の HTTP インターフェースと OSLC インターフェースは、そのインターフェースがセキュアなセットアップ用に構成される必要があるため、デフォルトで使用不能になっています。

拡張 ObjectServer HTTP インターフェースの構成libnhttpd.json 構成ファイルを使用して、追加の構成データを内蔵 HTTP ソケット・ライブラリーに提供し、ユーザー定義の静的エレメント・セットを定義し、MIME タイプをファイル拡張子にマップします。

libnhttpd ライブラリー構成の JSON ファイル $OMNIHOME/etc/libnhttpd.json のhttpPort セクションのプロパティーは、インターフェースに同時接続可能なユーザー数を設定します。

libnhttpd.json 構成ファイルを編集して、HTTP インターフェースおよび OSLCインターフェースによって返される HTTP 応答の HTTP ヘッダーおよび MIMEタイプの設定を定義します。 MIME タイプ設定と HTTP ヘッダーを使用可能にするには、NHttpd.ConfigFile プロパティーを有効にします。

{"_comment" : "This file provides additional configuration data to the

embedded HTTPsocket library (libnhttpd).",

"httpPort" : {"_comment" : "This section defines additional operational

settings for any HTTPport that is active.",

"maxConnections" : 500},"httpRequest" : {

"_comment" : "This section defines additional operationalsettings related toHTTP requests received from clients.",

"maxContentLength" : 1048576},"httpResponse" : {

"_comment" : "This section defines a set of user definedstatic elements thatshould be returnedin an HTTP response, such as HTTP headers.",

"corsHeaders" : [{

"name" : "Access-Control-Allow-Headers","value" : "Location"

第 1 章概要 7

},{

"name" : "Access-Control-Expose-Headers","value" : "Location"

}],"httpHeaders" : []

},"mimeTypes" : {

"_comment" : "This section maps MIME types to file extensions.It is used bylibnhttpd to determine the MIME typefor a file that is to be served from its file serving URI.",

"application/json" : ["json"

],"application/rdf+xml" : [

"rdf"],"application/xslt+xml" : [

"xsl", "xslt"],"image/jpeg" : [

"jpg", "jpeg"],"image/gif" : [

"gif"],"image/png" : [

"png"],"text/css" : [

"css"],"text/javascript" : [

"js"],"text/HTML" : [

"htm", "html"],"text/plain" : [

"txt", "log"],"text/xml" : [

"xml"]

}}

以下は、接続とデータに関する値です。

maxConnections一度に許容できる最大接続数を定義します。デフォルトは 500 です。

maxContentLengthHTTP 要求でサーバーに送信できる最大データ量を定義します。この値を超えた場合、要求は HTTP 413 (要求エンティティーが大きすぎます) で終了します。デフォルトは 1048576 です。

MIME タイプ設定と HTTP ヘッダーを使用可能にするセクションは次のとおりです。


httpResponseHTTP インターフェースおよび OLSC インターフェースによって戻されるHTTP 応答に含まれる HTTP ヘッダーを定義します。次のサブセクションがあります。

corsHeadersCross-Origin Resource Sharing (CORS) HTTP ヘッダーをオーバーライドします。デフォルトでは、Location HTTP ヘッダーが許可されて公開されることを示すように、デフォルトのヘッダーがオーバーライドされます。この設定は、HTTP 201 Create responses メッセージに必要です。

httpHeadersユーザー定義の HTTP ヘッダーの場合。これらのヘッダーは、すべてのHTTP 応答に追加されます。クライアントの静的値を追加するには、このセクションを使用します。この例では、サンプルのヘッダーが表示されています。

mimeTypesこのセクションでは、ファイル拡張子 (例: .html) を MIME タイプに割り当てます。ファイル・サービスが使用可能である場合、これらの定義は、ファイルのMIME タイプを判別するのに使用されます。また、ブラウザーがファイルを正しく処理できるように、コンテンツ・タイプ HTTP ヘッダーも設定します。$OMNIHOME/etc/libnhttpd/json ファイルには、追加できるデフォルトの 1 組のMIME タイプ設定があります。

IBM JazzSM サービス・プロバイダー・レジストリーの使用可能化と構成お客様の環境で Jazz for Service Management (JazzSM) を使用している場合、JazzSM サービス・プロバイダー・レジストリーに登録するように ObjectServer を構成できます。ObjectServer は、イベント OSLC サービス・プロバイダーとして登録されます。JazzSM レジストリーへの登録は、OSLC サービス・プロバイダー・レジストリー表 (registry.oslcsp) で構成と管理が行われます。

このタスクについて

この表にアクセスできるのは、root ユーザーと、OSLCAdmin ロールを持っている管理者だけです。登録は更新できません。登録レコードの挿入と削除はできますが、更新することはできません。

手順v 登録を作成するには、登録エントリーを registry.oslcsp 表に挿入します。次の

例は、デフォルトの資格情報を使用してポート 9080 のホストjazzsm.company.com で稼働する JazzSM サービス・プロバイダー・レジストリーのサンプルの SQL INSERT コマンドを示しています。

INSERT INTO registry.oslcsp ( Name, RegistryURI,RegistryUsername, RegistryPassword )VALUES ( 'MyRegistration','http://jazzsm.company.com:9080/oslc/pr','system', 'manager' );

挿入が行われた後、ObjectServer は、定義された JazzSM サービス・プロバイダー・レジストリーに、ローカル ObjectServer の OSLC インターフェースを登録

第 1 章概要 9

することを試みます。登録が成功した場合、作成された登録 URI は、RegistrationURI フィールドに保管されます。Registered フィールドは 1 に設定されます。登録が成功しなかった場合は、Registered フィールドは 0 に設定されます。

v JazzSM サービス・プロバイダー・レジストリーから登録を除去するには、表から登録エントリーを削除します。例えば、前記の例で示される登録を除去するには、次の例で示される SQL DELETE コマンドを使用します。

DELETE FROM registry.oslcsp WHERE Name='MyRegistration';

登録レコードが、定義された JazzSM サービス・プロバイダー・レジストリーに登録されている登録 URI を含んでいる場合は、ユーザーが表から行を削除すると、ObjectServer によってそのレコードが削除されます。

次のタスク

登録が失敗した場合は、ObjectServer のログ・ファイルを参照してください。

registry.oslc 表この表は、IBM® JazzSM サービス・レジストリーに OSLC サービス・プロバイダーの登録を構成して管理するために使用されます。

表 5. OSLC サービス・プロバイダー登録表 registry.oslcsp。

列タイプ説明

Name VARCHAR (64) 登録表エントリーのユーザー定義名。

RegistryURI VARCHAR(1024) OSLC サービス・プロバイダーは、レジストリー・サービスのレコードをサービスします。RegistryURI は、表の 1次キーです。

RegistryUsername VARCHAR (64) JazzSM サービス・プロバイダー・レジストリーで認証するために使用されるユーザー名。

RegistryPassword VARCHAR (64) JazzSM サービス・プロバイダー・レジストリーで認証するために使用されるパスワード。

Registered 整数エントリーが JazzSM レジストリー・サービスに登録レコードがあるかどうかを示します。使用可能な値は以下のとおりです。

v 0: エントリーは登録を持っていません。

v 1: エントリーは登録を持っています。


表 5. OSLC サービス・プロバイダー登録表 registry.oslcsp。 (続き)

列タイプ説明

RegistrationURI VARCHAR(1024) この ObjectServer 用のJazzSM サービス・プロバイダー・レジストリー内の登録レコードの URI。

LastRegistered time JazzSM サービス・プロバイダー・レジストリーに最新の成功した登録の日時。

第 1 章概要 11

第 2 章 HTTP インターフェースの URI

ObjectServer HTTP インターフェースに含まれている URI を使用すれば、表のデータおよび表内の行へのアクセス、HTTP を使用した SQL コマンドの実行、およびシステム情報へのアクセスができます。

表収集サービス表収集サービスの URI を使用して、ObjectServer データ・ストア内の、システム表またはユーザー表などの表にアクセスします。表収集サービスの URI は、最上位の URI です。

この URI の形式は、次のとおりです。

http://host:port/objectserver/restapi/database/table

ここで database は ObjectServer データベースの名前であり、table はそのデータベース内の表の名前です。

表収集サービスの URI は、GET、POST、PATCH、および DELETE の HTTP メソッドをサポートします。

参照される表の行は、単一の要求で取り出し、更新、または削除ができます。POST要求で表に行を挿入することもできます。単一の行のみが挿入できます。一括挿入はできません。

表収集の URI 例は以下のとおりです。

v http://localhost/objectserver/restapi/alerts/status

v http://localhost/objectserver/restapi/catalog/tables

v http://localhost/objectserver/restapi/alerts/conversions

表収集サービス GET 要求ObjectServer 表から行を取り出すための表収集への HTTP GET 要求のエレメント。

表 6. 表収集サービス GET 要求

エレメント説明

HTTP メソッド GET

© Copyright IBM Corp. 1994, 2017 13

表 6. 表収集サービス GET 要求 (続き)


照会パラメーター filter表内の行が満足するべき条件を定義します。このパラメーターが、SQL SELECT文の WHERE 節です。

collist

HTTP 応答の結果内の表の列を定義します。このパラメーターが、SQL SELECT文の列リスト・コンポーネントです。

orderby

結果セットのソート順序を定義します。このパラメーターが、SQL SELECT 文の ORDER BY 節です。

要求ヘッダー許可必須

ホスト必須

Accept application/json

要求本文適用外

関連資料:

37 ページの『認証メカニズム』ObjectServer HTTP インターフェースに接続するためには、認証用に TivoliNetcool/OMNIbus ユーザー資格情報のセットが必要です。基本 HTTP 認証のみがサポートされています。

48 ページの『表収集 GET 要求の例』alerts.status 表からすべての行を選択します。

表収集サービス: GET 応答ObjectServer の表収集に対する HTTP GET 応答のエレメントについて説明します。

表 7. 表収集サービス: GET 応答


応答ヘッダーサーバーHTTPd エンジンの名前。

日付応答の日付または時刻。

接続接続の接続状態。有効な状態は Closeまたは Keep-Alive です。

コンテンツ・タイプ application/json

正常 HTTP 応答コード 200 (Created): JSON 成功メッセージを含む応答本文。


表 7. 表収集サービス: GET 応答 (続き)


エラー HTTP 応答コード 500 (Internal Server Error): サーバーは、予期しない内部の問題により要求の実行に失敗しました。応答本文には、より詳しい情報が記録された JSON エラー・メッセージが含まれています。

その他の共通 HTTP エラー応答コードは、401 (Unauthorised)、403 (Forbidden)、および 406 (Not Acceptable) です。

関連資料:

35 ページの『HTTP 応答コード』ObjectServer HTTP インターフェースからの、HTTP メソッドへの HTTP 応答コードの共通セット。

38 ページの『エラー JSON メッセージ・ペイロード』ObjectServer HTTP インターフェースは、不成功応答コード (500 など) で JSONエラー・メッセージ・ペイロードを返すことがあります。このエラー・メッセージは、要求に関連した ObjectServer 内部の戻りコード失敗についての情報を提供します。

48 ページの『表収集 GET への応答の例』

表収集サービス POST 要求

表 8. 表収集サービス POST 要求


HTTP メソッド POST

照会パラメーター適用外


ホスト必須



要求本文挿入する単一行を含む JSON 行セット。一括挿入はサポートされていません。

関連資料:

43 ページの『JSON 行セット POST の例』次の JSON 行セットは、ObjectServer の alerts.status 表に挿入される行を定義します。

47 ページの『表収集 POST 要求の例』alerts.status 表への行の挿入。

第 2 章 HTTP インターフェースの URI 15

表収集サービス POST への応答ObjectServer での表収集内の 1 行を作成する HTTP POST への応答のエレメント。

表 9. 表収集サービス POST への応答


応答ヘッダーサーバーHTTPd エンジンの名前


接続接続の状態。有効な状態は Close または Keep-Alive です。

ロケーション作成されたリソースの URI。


正常 HTTP 応答コード 201 (Created): 挿入された行の URI が、応答の HTTP ヘッダー Location に含まれます。応答本文には、JSON 成功メッセージが含まれます。

エラー HTTP 応答コード 400 (Bad Request): 挿入する行の JSON行セット定義が無効です。この行は、列が存在しないか、不明な列が含まれているか、正しくない列が含まれているため、無効です。あるいは、列の値が不十分であるか正しくないため、無効です。

409 (Conflict): 1 次キー競合。この行は既に表に存在します。

500 (Internal Server Error): サーバーは、予期しない内部の問題により要求の実行に失敗しました。応答本文には、より詳しい情報が記録された JSON エラー・メッセージが含まれています。

その他の共通 HTTP エラー応答コードは、401 (Unauthorised)、403 (Forbidden)、406(Not Acceptable)、および 415(Unsupported Media Type) です。

関連資料:


38 ページの『成功 JSON メッセージ・ペイロード』ObjectServer HTTP インターフェースは、JSON 成功メッセージをペイロードで返します。HTTP 応答コードにより要求者に要求が成功したかどうかが通知され、JSON メッセージにより追加情報が提供されます。この情報には、要求によって影


響された表収集内の行数が含まれます。


48 ページの『表収集 POST への応答の例』

表収集サービス PATCH 要求ObjectServer 表内の行を更新するための表収集への HTTP PATCH 要求のエレメント。

表 10. HTTP PATCH エレメント


HTTP メソッド PATCH



ホスト必須


要求本文単一行を含む JSON 行セット。行には、どの列を更新するか、およびどの値でその列を更新するかを定義します。

関連資料:


42 ページの『JSON 行セット PATCH の例』次の例は、alerts.status 表でマッチした行のLocation、LastOccurrence、Acknowledged、OwnerUID および OwnerGID 列を更新します。

50 ページの『表収集 PATCH 要求の例』alerts.status 表のすべての行のLocation、LastOccurrence、Acknowledged、OwnerUID および OwnerGID 列を更新します。


表収集サービス: PATCH 応答ObjectServer で表収集の行を更新するための HTTP PATCH 応答のエレメントについて説明します。

表 11. 表収集サービス: PATCH 応答






正常 HTTP 応答コード 200 (OK): 応答本文には JSON 成功メッセージが含まれています。




関連資料:


38 ページの『成功 JSON メッセージ・ペイロード』ObjectServer HTTP インターフェースは、JSON 成功メッセージをペイロードで返します。HTTP 応答コードにより要求者に要求が成功したかどうかが通知され、JSON メッセージにより追加情報が提供されます。この情報には、要求によって影響された表収集内の行数が含まれます。



51 ページの『表収集 PATCH への応答の例』

表収集サービス DELETE 要求ObjectServer 表内の行を削除するための表収集への HTTP DELETE 要求のエレメント。

表 12. 表収集サービス DELETE 要求


HTTP メソッド



ホスト必須



関連資料:


51 ページの『表収集 DELETE 要求の例』alerts.status 表のすべての行を削除します。

表収集サービス DELETE への応答ObjectServer での表収集の行を削除する HTTP DELETE への応答のエレメント。

表 13. 表収集サービス DELETE への応答








表 13. 表収集サービス DELETE への応答 (続き)





関連資料:




51 ページの『表収集 DELETE への応答の例』

行エレメントのサービスこの URI を使用して ObjectServer 表内の特定の行にアクセスして参照します。

以下のメソッドがサポートされています。

RowSerial

ObjectServer 内のすべての表のすべての行には、行が存在する表内で行を一意的に識別する整数値があります。表収集サービス URI に対して、行を取り出す HTTPGET 要求を使用するとき、各行の RowSerial 値が JSON 行セット文書内の列として自動的に返されます。RowSerial 値は、次の例に示されるように、その行に行エレメント URI を構築するために使用できます。


http://host:port/objectserver/restapi/database/table/rowserial/

ここで database は ObjectServer データベースの名前で、table は ObjectServer 表の名前で、そして rowserial は一意的な行の通し番号です。

RowSerial 方式は、GET、PATCH、および DELETE の HTTP メソッドをサポートします。

RowSerial は整数なので、URI を作成して ObjectServer を評価するには便利です。RowSerial URI は、それが最初に決められた ObjectServer にのみ有効です。RowSerial によるアクセスは、優先するべき方法です。

キー・フィールド

ObjectServer 内のすべての表のすべての行には、行が存在する表内で行を一意的に識別するキー・フィールドがあります。従って、次の例で示されるように、RowSerial 値ではなくキー・フィールドを使用して行を参照できます。

http://host:port/objectserver/restapi/database/table/kf/keyfield/

ここで database は ObjectServer データベースの名前で、table は ObjectServer 表の名前で、そして keyfield は一意的な行のキー値です。

キー・フィールド方式は、GET、PATCH、および DELETE の HTTP メソッドをサポートします。

キー・フィールドの作成に関する注意事項

許される場合は、キー・フィールド URI は、HTTP インターフェースが使用可能である、環境内のどの ObjectServer でも有効です。従って、複数の ObjectServerにわたり行への共通したパスを作成して使用できます。

複数の ObjectServer にわたり有効である、行のキー・フィールドは、それがあるObjectServer 表によって、異なります。例えば、alerts.status 表で、1 次キーは ID列です。ID の値は、複数の ObjectServer にわたって、単一のイベント・インスタンスを一意的に指さないので、キー・フィールドの作成には使用できません。代わりに、alerts.status 表での行のキー・フィールドは、ServerSerial 列と ServerName列の値から作成されます。

注: キー・フィールドの生成は、文字によっては URI 内での使用にはエンコードの必要があるので、複数列の 1 次キーがある表では特に、複雑です。複数のObjectServer にわたり有効な URI を必要とするのでないならば、RowSerial URIを使用します。

次の表は、alerts.status 表、alerts.journal 表、alerts.details 表、およびその他のObjectServer 内の一般表について、どのようにキー・フィールドが作成されるかを示します。


表 14. 行エレメントのキー・フィールドの作成

表 (Table) タイプキー・フィールド作成方法

alerts.status イベント ServerSerial フィールドが、コロンで区切られてServerName フィールドに結合されます。次の例は、フィールドが結合される方法を示します。

1234:NCOMS

次の例は、フィールドが URI での使用のためにエンコードされた後どのように構成されているかを示します。

1234%3ANCOMS

次の例は、URI のサンプルを示します。

http://localhost/objectserver/restapi/alerts/status/kf/12510%3ANCOMS

alerts.journal ジャーナルキー・フィールドは、ジャーナル表の KeyField 列で定義されます。ジャーナルは、異なるObjectServer では、異なって再順序付けがなされるので、ジャーナル・キー・フィールドは、複数のObjectServer にわたって有効ではありません。次の例は、KeyField のサンプルを示します。

2684:0:1341416084


12684%3A0%3A1341416084


http://localhost/objectserver/restapi/alerts/journal/kf/12684%3A0%3A1341416084


表 14. 行エレメントのキー・フィールドの作成 (続き)

表 (Table) タイプキー・フィールド作成方法

alerts.details 詳細キー・フィールドは、詳細表の KeyField 列で定義されます。次の例は、KeyField のサンプルを示します。

EventIdentifier@@@@4####4


EventIndentifier%40%40%40%404%23%23%23%234


http://localhost/objectserver/restapi/alerts/details/kf/EventIndentifier%40%40%40%404%23%23%23%234

ObjectServer 内のその他すべての一般表

一般キー・フィールドは、表の 1 次キーを構成する列セットです。表の 1 次キーが複数のキーで構成される場合は、表スキーマにあるのと同じ順序でキー値を指定します。キー値を文字列 #KF# で区切ります。

次の例は、2 つの 1 次列がある表でのキー・フィールドのサンプルで、値を Colvalue01および 654 としています。

ColValue01#KF#654


ColValue01%23KF%23654

次の例は、URI でのこのキー・フィールドを示します。

http://localhost/objectserver/restapi/alerts/mytable/kf/ColValue01%23KF%23654


行エレメント GET 要求ObjectServer 表から特定の 1 行を取り出すための行エレメントへの HTTP GET要求のエレメント。

表 15. 行エレメント GET 要求


HTTP メソッド GET

照会パラメーター collistHTTP 応答の結果内の表の列を定義します。このパラメーターが、SQL SELECT文の列リスト・コンポーネントです。


ホスト必須



関連資料:


51 ページの『RowSerial による行エレメント GET 要求の例』

行エレメント GET への応答ObjectServer 表から特定の 1 行を取り出す HTTP GET への応答のエレメント。

表 16. 行エレメント GET への応答








表 16. 行エレメント GET への応答 (続き)


エラー HTTP 応答コード 404 (Not Found): 要求された行が、行が削除されたために、表に見つかりません。


共通 HTTP エラー応答コードは、401(Unauthorised)、403 (Forbidden)、および406 (Not Acceptable) です。

関連資料:



51 ページの『RowSerial による行エレメント GET への応答の例』

行エレメント PATCH 要求ObjectServer 表内の特定の行エレメントへの HTTP PATCH 要求のエレメント。

表 17. 行エレメント PATCH 要求


HTTP メソッド PATCH



ホスト必須


要求本文単一行を含む JSON 行セット。行には、行内のどの列を更新するかを定義します。

関連資料:



42 ページの『JSON 行セット PATCH の例』次の例は、alerts.status 表でマッチした行のLocation、LastOccurrence、Acknowledged、OwnerUID および OwnerGID 列を更新します。

56 ページの『行エレメント PATCH 要求の例』alerts.status 表の特定の 1 行のLocation、LastOccurrence、Acknowledged、OwnerUID および OwnerGID 列を更新します。

行エレメント PATCH への応答ObjectServer の表の特定の 1 行を更新する HTTP PATCH への応答のエレメント。

表 18. 行エレメント PATCH への応答








404 (Not Found): 要求された行が、行が削除されたために、表に見つかりません。



関連資料:

35 ページの『HTTP 応答コード』ObjectServer HTTP インターフェースからの、HTTP メソッドへの HTTP 応答コ


ードの共通セット。



57 ページの『行エレメント PATCH への応答の例』

行エレメント DELETE 要求ObjectServer 表内の特定の行エレメントへの HTTP DELETE 要求のエレメント。

表 19. 行エレメント DELETE 要求


HTTP メソッド DELETE



ホスト必須



関連資料:


57 ページの『行エレメント DELETE 要求の例』alerts.status 表の特定の 1 行を削除します。

行エレメント DELETE への応答ObjectServer の表の特定の 1 行を削除する HTTP DELETE への応答のエレメント。


表 20. 行エレメント DELETE への応答







エラー HTTP 応答コード 404 (Not Found): 要求された行が、行が削除されたために、表に見つかりません。



関連資料:




57 ページの『行エレメント DELETE への応答の例』


SQL コマンド・ファクトリーObjectServer HTTP インターフェースの SQL コマンド・ファクトリーを使用して、HTTP を介して任意の SQL コマンドを実行します。

このインターフェースにより SQL を実行するには、ユーザーは、読み取り SQLコマンドについては AllowISQL ユーザー権限、書き出し SQL コマンドについては AllowISQLWrite ユーザー権限が必要になります。

ユーザー権限について詳しくは、「IBM Tivoli Netcool/OMNIbus 管理ガイド」を参照してください。

SQL コマンドを実行するには、次の例で示すように、SQL コマンド・ファクトリーの URI に JSON SQLコマンド・メッセージをポストします。

http://host:port/objectserver/restapi/sql/factory

SQL コマンド・ファクトリーは、HTTP メソッドの POST をサポートします。

SQL コマンド・ファクトリー POST 要求ObjectServer で任意の SQL コマンドを実行するための SQL コマンド・ファクトリーに対する POST 要求の要件について説明します。

表 21. SQL コマンド・ファクトリー: POST 要求


HTTP メソッド POST



ホスト必須



要求本文 JSON SQL コマンド・メッセージ

関連資料:


44 ページの『SQL コマンド・ファクトリー: POST の例』次の SQL コマンド・ファクトリーのメッセージ例では、drop user コマンドを実行するように発行します。

57 ページの『SQL コマンド・ファクトリー POST 要求の例』


SQL コマンド・ファクトリー POST への応答ObjectServer で任意の SQL コマンドを実行するための HTTP POST 応答のエレメントについて説明します。

表 22. SQL コマンド・ファクトリー: POST 応答










関連資料:





58 ページの『SQL コマンド・ファクトリー POST への応答の例』

システム情報サービスこの URI を使用して、ObjectServer の HTTP インターフェースおよび OSLC インターフェースのコンパイル詳細とバージョンを照会したり、判別したりし�

Documents

IBM Tivoli Netcool/OMNIbusnObjectServer HTTP CtFX tXEKCh...Netcool/OMNIbus バージョン 8 リリース 1 ObjectServer HTTP インター フェース リファレンス・ガイド

IBM Tivoli Netcool/OMNIbusnObjectServer HTTP CtFX tXEKCh...Netcool/OMNIbus バージョン 8 リリース 1 ObjectServer HTTP インターフェースリファレンス・ガイド