Systemwalker Operation Managerに登録済みのプロジェクトを操作します。
以下の操作が可能です。
エンドポイント | HTTP | 操作内容 |
|---|---|---|
/v1/projects/{projectname} | GET | 指定したプロジェクトの情報を取得します。 |
POST | 指定したプロジェクトに存在するジョブネットを一括操作します。 | |
/v1/projects | GET | プロジェクト情報の一覧を取得します。 |
projectsリソースのオブジェクトのフィールドは、以下のとおりです。
なお、システムで一意のプロジェクトを指定する場合、SE版では、プロジェクト名を指定します。EE版およびGEE版では、サブシステム番号とプロジェクト名を指定します。
フィールド名 | 型 | 説明 |
|---|---|---|
host | 文字列 | 接続先のホスト名 |
subsystem | 数値 | サブシステム番号 |
projectname | 文字列 | プロジェクト名 |
normal | 数値 | 正常終了のジョブネット数 |
abend | 数値 | 異常終了のジョブネット数 |
forced | 数値 | 強制終了のジョブネット数 |
warning | 数値 | 警告のジョブネット数 |
execute | 数値 | 実行中のジョブネット数 |
wait | 数値 | 実行待ちのジョブネット数 |
pause | 数値 | 一時停止のジョブネット数 |
disable | 数値 | 無効状態のジョブネット数 |
coped | 数値 | 確認済みのジョブネット数 |
pseudo | 数値 | 疑似正常のジョブネット数 |
機能説明
projectsリソースを指定したGETメソッドのリクエストを送ることで、対象のプロジェクト情報を取得します。
実行に必要な権限/実行環境
指定のプロジェクトに対して、参照権以上の権限が必要です。
リクエスト
GET
/v1/subsystems/{subsystem}/projects/{projectname}
/v1/projects/{projectname} (サブシステム番号を省略する場合)
パスパラメータで、以下のパラメータを指定します。
パラメータ | 指定方法 | 型 | 説明 |
|---|---|---|---|
subsystem | パス | 数値 | 対象のプロジェクトが存在するサブシステム番号(0～9)を指定します。サブシステム番号を省略する場合は0になります。 |
projectname(*) | パス | 文字列 | 対象のプロジェクト名を指定します。 |
(*)：必須のパラメータ
パス：パスパラメータ
レスポンス
以下のHTTPステータスコードを返却します。
コード | 説明 |
|---|---|
200 | リクエストの処理が正常終了しました。 |
401 | 認証情報の指定に誤りがあります。 |
404 | 対象のプロジェクトは存在しません。
|
500 | リクエストの処理中にサーバで異常が発生しました。 |
対象のprojectsリソースのオブジェクトを返却します。
使用例
サブシステム番号0、プロジェクト名が“SampleProject”のプロジェクトを取得する場合のAPIの使用例を以下に示します。なお、レスポンス例は、dataフィールドに格納されるprojectsリソースのオブジェクトを示しており、レスポンスヘッダおよび他のフィールドは省略しています。
GET /Systemwalker-omgr/api/v1/subsystems/0/projects/SampleProject HTTP/1.1 Host: Systemwalker Operation Managerサーバのホスト名:9900 Authorization: Basic ********************
{
"host": "Systemwalker Operation Managerサーバのホスト名",
"subsystem": 0,
"projectname": "SampleProject",
"normal": 0,
"abend": 0,
"forced": 0,
"warning": 0,
"execute": 0,
"wait": 0,
"pause": 0,
"disable": 0,
"coped": 0,
"pseudo": 0
}機能説明
projectsリソースを指定したPOSTメソッドのリクエストを送ることで、対象のプロジェクトに存在するジョブネットを一括操作(すべて停止/すべて停止解除/すべて無効/すべて無効解除)します。
実行に必要な権限/実行環境
指定のプロジェクトに対して、操作権以上の権限が必要です。
リクエスト
POST
/v1/subsystems/{subsystem}/projects/{projectname}
/v1/projects/{projectname} (サブシステム番号を省略する場合)
パスパラメータおよびリクエストボディで、以下のパラメータを指定します。
パラメータ | 指定方法 | 型 | 説明 |
|---|---|---|---|
subsystem | パス | 数値 | 対象のプロジェクトが存在するサブシステム番号(0～9)を指定します。サブシステム番号を省略する場合は0になります。 |
projectname(*) | パス | 文字列 | 対象のプロジェクト名を指定します。 |
control(*) | ボディ | リスト | 指定可能な値は以下のとおりです。 pause ：すべて停止 |
(*)：必須のパラメータ
パス：パスパラメータ
ボディ：リクエストボディ
レスポンス
以下のHTTPステータスコードを返却します。
コード | 説明 |
|---|---|
202 | リクエストの処理が正常終了しました。 |
400 | リクエストパラメータに誤りがあります。
|
401 | 認証情報の指定に誤りがあります。 |
403 | 対象のプロジェクトへの権限がありません。 |
404 | 対象のプロジェクトは存在しません。 |
409 | 対象のプロジェクトへの指定の操作はできません。
|
500 | リクエストの処理中にサーバで異常が発生しました。 |
指定したprojectsリソースのオブジェクトを返却します。
注意
Web APIによるプロジェクトに存在するジョブネットへの操作は、Systemwalker Operation Managerサーバの処理と同期を取っていません。そのため、Web APIのレスポンスはサーバでの処理の完了を保証するものではありません。レスポンスボディで返却するオブジェクトは、操作が反映されていない場合があります。
対象のプロジェクトに存在するジョブネットの中に操作できないジョブネットがあった場合、処理は中断されず、操作できるジョブネットはすべて処理されます。この場合、異常終了時の応答の形式で応答します。
使用例
サブシステム番号0、プロジェクト名が“SampleProject”のプロジェクトに対して、“すべて停止”の操作をする場合のAPIの使用例を次に示します。
POST /Systemwalker-omgr/api/v1/subsystems/0/projects/SampleProject HTTP/1.1
Host: Systemwalker Operation Managerサーバのホスト名:9900
Authorization: Basic ********************
Content-Type: application/json
{
"control": "pause"
}“18.3.1.1 プロジェクト情報の取得”のレスポンス例を参照してください。
機能説明
projectsリソースの一覧を取得します。
対象は、認証情報に指定したユーザが参照権以上を持つプロジェクトとなります。
リクエスト
レスポンス
以下のHTTPステータスコードを返却します。
コード | 説明 |
|---|---|
200 | リクエストの処理が正常終了しました。 |
400 | リクエストパラメータに誤りがあります。
|
401 | 認証情報の指定に誤りがあります。 |
500 | リクエストの処理中にサーバで異常が発生しました。 |
projectsリソースのオブジェクトを返却します。
使用例
サブシステム番号0に所属するプロジェクトの一覧を取得する場合の、APIの使用例を以下に示します。
GET /Systemwalker-omgr/api/v1/projects?subsystem=0 HTTP/1.1 Host: Systemwalker Operation Managerサーバのホスト名:9900 Authorization: Basic ********************
dataフィールドのオブジェクト配列として、projectsリソースのオブジェクトを返却します。projectsリソースのオブジェクトについては、“18.3.1.1 プロジェクト情報の取得”のレスポンス例を参照してください。