ページの先頭行へ戻る
Systemwalker Operation Manager  リファレンス集
FUJITSU Software
第18章 Web API【Windows版】【Linux版】 > 18.3 各APIのリファレンス > 18.3.5 contained-hostsリソース
前次

18.3.5 contained-hostsリソース

Systemwalker Operation Managerに登録済みのホストグループに対して、構成ホストを操作します。

以下の操作が可能です。

エンドポイント
(/Systemwalker-omgr/api 以降)

HTTP
メソッド

操作内容

/v1/host-groups/{hostgroupname}/contained-hosts/{hostname}

GET

指定した構成ホストの情報を取得します。

POST

指定した構成ホストの属性を変更します。

DELETE

指定した構成ホストをホストグループから削除します。

/v1/contained-hosts

POST

ホストグループに構成ホストを追加します。

GET

構成ホストの情報の一覧を取得します。

contained-hostsリソースのオブジェクトのフィールドは、以下のとおりです。

なお、システムで一意の構成ホストを指定する場合、SE版では、ホストグループ名と構成ホストのホスト名を指定します。EE版およびGEE版では、サブシステム番号とホストグループ、構成ホストのホスト名を指定します。

フィールド名

型

説明

host

文字列

接続先のホスト名

subsystem

数値

サブシステム番号

hostgroupname

文字列

ホストグループ名

hostname

文字列

構成ホストのホスト名

status

リスト

構成ホストの状態
ACT：構成ホストがダウンしていない
DOWN：構成ホストがダウンしている
NA：構成ホストの状態が取得できない

maxexec

数値

構成ホストの最大多重度

run

数値

構成ホストで実行中のジョブ数

18.3.5.1 構成ホスト情報の取得

機能説明

contained-hostsリソースを指定したGETメソッドのリクエストを送ることで、対象の構成ホスト情報を取得します。

実行に必要な権限/実行環境

Systemwalker Operation Manager環境設定でSystemwalker Operation Manager利用者の限定をしている場合、swadminグループに所属するユーザの権限が必要です。Systemwalker Operation Manager利用者の限定をしていない場合は、一般ユーザの権限で使用できます。

リクエスト

HTTPメソッド

GET

リクエストURI

/v1/subsystems/{subsystem}/host-groups/{hostgroupname}/contained-hosts/{hostname}

/v1/host-groups/{hostgroupname}/contained-hosts/{hostname}  (サブシステム番号を省略する場合)

リクエストパラメータ

パスパラメータで、以下のパラメータを指定します。

パラメータ

指定方法

型

説明

subsystem

パス

数値

対象の構成ホストが存在するサブシステム番号(0～9)を指定します。サブシステム番号を省略する場合は0になります。

hostgroupname (*)

パス

文字列

対象の構成ホストが存在するホストグループを指定します。(注1)

hostname(*)

パス

文字列

対象の構成ホスト名を指定します。

(*)：必須のパラメータ

パス：パスパラメータ

注1)

hostgroupnameには、いずれかのキューに登録されたホストグループを指定できます。“18.3.4.4 キュー情報の一覧取得”のWeb APIでqueuesリソースの一覧を取得し、そのhostgroupフィールド値からホストグループを確認できます。

レスポンス

以下のHTTPステータスコードを返却します。

コード

説明

200

リクエストの処理が正常終了しました。

401

認証情報の指定に誤りがあります。

403

swadminグループに所属するユーザの権限ではありません。

404

対象の構成ホストは存在しません。

  • システムに対象の構成ホストが存在しない

  • パスパラメータの指定内容が誤っている

500

リクエストの処理中にサーバで異常が発生しました。

レスポンスボディ

対象のcontained-hostsリソースのオブジェクトを返却します。

使用例

サブシステム番号0、ホストグループ名が“hostgroup1”、構成ホスト名が“host1”の構成ホストを取得する場合のAPIの使用例を以下に示します。なお、レスポンス例は、dataフィールドに格納されるcontained-hostsリソースのオブジェクトを示しており、レスポンスヘッダおよび他のフィールドは省略しています。

リクエスト例
GET /Systemwalker-omgr/api/v1/subsystems/0/host-groups/hostgroup1/contained-hosts/host1  HTTP/1.1
Host: Systemwalker Operation Managerサーバのホスト名:9900
Authorization: Basic ********************
レスポンス例
{
  "host": "Systemwalker Operation Managerサーバのホスト名",
  "subsystem": 0,
  "hostgroupname": "hostgroup1",
  "hostname": "host1",
  "status": "ACT",
  "maxexec": 10,
  "run": 0
}

18.3.5.2 構成ホストの定義の一時変更

機能説明

contained-hostsリソースを指定したPUTメソッドのリクエストを送ることで、対象の構成ホストの定義を一時変更します。

実行に必要な権限/実行環境

システム管理者(Administratorsグループに属するユーザ/スーパーユーザ)権限が必要です。

リクエスト

HTTPメソッド

PUT

リクエストURI

/v1/subsystems/{subsystem}/host-groups/{hostgroupname}/contained-hosts/{hostname}

/v1/host-groups/{hostgroupname}/contained-hosts/{hostname}  (サブシステム番号を省略する場合)

リクエストパラメータ

パスパラメータおよびリクエストボディで、以下のパラメータを指定します。

パラメータ

指定方法

型

説明

subsystem

パス

数値

対象の構成ホストが存在するサブシステム番号(0～9)を指定します。サブシステム番号を省略する場合は0になります。

hostgroupname(*)

パス

文字列

対象の構成ホストが存在するホストグループを指定します。

hostname(*)

パス

文字列

対象の構成ホスト名を指定します。

maxexec

ボディ

数値

対象の構成ホストのジョブの多重度（同時実行可能数）を指定します。範囲は1～999です。

(*)：必須のパラメータ

パス：パスパラメータ

ボディ：リクエストボディ

レスポンス

ステータスコード

以下のHTTPステータスコードを返却します。

コード

説明

200

リクエストの処理が正常終了しました。

400

リクエストパラメータに誤りがあります。

  • 必須パラメータを指定していない

  • 指定不要のパラメータを指定している

  • パラメータの指定値に誤りがある

401

認証情報の指定に誤りがあります。

403

システム管理者の権限ではありません。

404

対象の構成ホストは存在しません。

  • システムに対象の構成ホストが存在しない

  • パスパラメータの指定内容が誤っている

500

リクエストの処理中にサーバで異常が発生しました。

レスポンスボディ

指定したcontained-hostsリソースのオブジェクトを返却します。

注意事項

構成ホストの属性変更により変更した内容は、ジョブ実行制御を初期化モードで起動するまでの間、保持されます。ジョブ実行制御を初期化モードで起動すると、分散実行の設定は、初期化ファイルに定義した内容に変更されます。

使用例

サブシステム番号0、ホストグループ名が“hostgroup1”、ホスト名が“host1”の構成ホストのジョブの多重度(同時実行可能数)を2に変更する場合のAPIの使用例を以下に示します。

リクエスト例
PUT /Systemwalker-omgr/api/v1/subsystems/0/host-groups/hostgroup1/contained-hosts/host1  HTTP/1.1
Host: Systemwalker Operation Managerサーバのホスト名:9900
Authorization: Basic ********************
Content-Type: application/json

{
  "maxexec": 2
}
レスポンス例

ジョブの多重度(同時実行可能数)が2に変更されたcontained-hostsリソースのオブジェクトが返ります。“18.3.5.1 構成ホスト情報の取得”のレスポンス例を参照してください。

18.3.5.3 構成ホストの削除

機能説明

contained-hostsリソースを指定したDELETEメソッドのリクエストを送ることで、対象の構成ホストをホストグループから削除します。

実行に必要な権限/実行環境

システム管理者(Administratorsグループに属するユーザ/スーパーユーザ)権限が必要です。

リクエスト

HTTPメソッド

DELETE

リクエストURI

/v1/subsystems/{subsystem}/host-groups/{hostgroupname}/contained-hosts/{hostname}

/v1/host-groups/{hostgroupname}/contained-hosts/{hostname}  (サブシステム番号を省略する場合)

リクエストパラメータ

パスパラメータで、以下のパラメータを指定します。

パラメータ

指定方法

型

説明

subsystem

パス

数値

対象の構成ホストが存在するサブシステム番号(0～9)を指定します。サブシステム番号を省略する場合は0になります。

hostgroupname(*)

パス

文字列

対象の構成ホストが存在するホストグループを指定します。

hostname(*)

パス

文字列

対象の構成ホスト名を指定します。

(*)：必須のパラメータ

パス：パスパラメータ

レスポンス

ステータスコード

以下のHTTPステータスコードを返却します。

コード

説明

200

リクエストの処理が正常終了しました。

401

認証情報の指定に誤りがあります。

403

システム管理者の権限ではありません。

404

対象の構成ホストは存在しません。

  • システムに対象の構成ホストが存在しない

  • パスパラメータの指定内容が誤っている

409

対象の構成ホストへの指定の操作はできません。

  • ホストグループの構成ホストの登録数が1つしかない

500

リクエストの処理中にサーバで異常が発生しました。

レスポンスボディ

dataフィールドが空のcontained-hostsリソースのオブジェクトを返します。

注意事項

ホストグループに登録する構成ホストの最小数は1です。そのため、対象となるホストグループの構成ホストの登録数が1の場合、削除により構成ホストの登録数が0になるため、削除に失敗します。

使用例

サブシステム番号0、ホストグループ名が“hostgroup1”のホストグループから、ホスト名が“host1”の構成ホストを削除する場合のAPIの使用例を以下に示します。

リクエスト例
DELETE /Systemwalker-omgr/api/v1/subsystems/0/host-groups/hostgroup1/contained-hosts/host1 HTTP/1.1
Host: Systemwalker Operation Managerサーバのホスト名:9900
Authorization: Basic ********************
レスポンス例
{
  "next": false,
  "total": 0,
  "data": []
}

18.3.5.4 構成ホストの追加

機能説明

リクエストボディに構成ホスト情報を指定したPOSTメソッドのリクエストを送ることで、対象のホストグループに構成ホストを追加します。

なお、対象の構成ホストがすでに存在していた場合は、上書き更新します。

実行に必要な権限/実行環境

システム管理者(Administratorsグループに属するユーザ/スーパーユーザ)権限が必要です。

リクエスト

HTTPメソッド

POST

リクエストURI

/v1/contained-hosts

リクエストパラメータ

リクエストボディで、以下のパラメータを指定します。

パラメータ

指定方法

型

説明

subsystem

ボディ

数値

対象の構成ホストが存在するサブシステム番号(0～9)を指定します。サブシステム番号を省略する場合は0になります。

hostgroupname(*)

ボディ

文字列

対象の構成ホストが存在するホストグループ名を指定します。

hostname(*)

ボディ

文字列

対象の構成ホスト名を指定します。

  • ホスト名に自ホストを指定しないでください。

  • 実行サブシステム名は使用できません。

Web APIから指定する場合、半角英数字および“-”(半角ハイフン)、“_”(半角アンダーバー)、“:”(半角コロン)、“.”(半角ドット)、“%”(半角パーセント)のみ使用できます。

maxexec

ボディ

数値

対象の構成ホストのジョブの多重度(同時実行可能数)を指定します。
指定可能な値は1～999です。省略値は10です。

(*)：必須のパラメータ

ボディ：リクエストボディ

レスポンス

ステータスコード

以下のHTTPステータスコードを返却します。

コード

説明

200

リクエストの処理が正常終了しました。
(構成ホストの上書き更新)

201

リクエストの処理が正常終了しました。
(構成ホストを追加)

400

リクエストパラメータに誤りがあります。

  • 必須パラメータを指定していない

  • 指定不要のパラメータを指定している

  • パラメータの指定値に誤りがある

401

認証情報の指定に誤りがあります。

403

システム管理者の権限ではありません。

409

対象のホストグループに構成ホストは追加できません。

  • ホストグループの構成ホストの登録数が100である

  • 対象のホストグループが存在しない

500

リクエストの処理中にサーバで異常が発生しました。

レスポンスボディ

追加したcontained-hostsリソースのオブジェクトを返却します。

注意事項

使用例

サブシステム番号0、ホストグループ名が“hostgroup1”のホストグループに、構成ホスト名が“host2”、多重度(同時実行可能数)が4の構成ホストを追加する場合のAPIの使用例を以下に示します。

リクエスト例
POST /Systemwalker-omgr/api/v1/contained-hosts HTTP/1.1
Host: Systemwalker Operation Managerサーバのホスト名:9900
Authorization: Basic ********************
Content-Type: application/json

{
  "subsystem": 0,
  "hostgroupname": "hostgroup1",
  "hostname": "host2",
  "maxexec": 4
}
レスポンス例

“18.3.5.1 構成ホスト情報の取得”のレスポンス例を参照してください。

18.3.5.5 構成ホスト情報の一覧取得

機能説明

contained-hostsリソースの一覧を取得します。

実行に必要な権限/実行環境

Systemwalker Operation Manager環境設定でSystemwalker Operation Manager利用者の限定をしている場合、swadminグループに所属するユーザの権限が必要です。Systemwalker Operation Manager利用者の限定をしていない場合は、一般ユーザの権限で使用できます。

リクエスト

HTTPメソッド

GET

リクエストURI

/v1/contained-hosts

リクエストパラメータ

共通仕様のクエリパラメータが使用できます。

詳細については、“18.2.3.2 リクエストの形式”を参照してください。

レスポンス

ステータスコード

以下のHTTPステータスコードを返却します。

コード

説明

200

リクエストの処理が正常終了しました。

400

リクエストパラメータに誤りがあります。

  • 指定不要のパラメータを指定している

  • 同じクエリパラメータを複数指定している

401

認証情報の指定に誤りがあります。

403

swadminグループに所属するユーザの権限ではありません。

500

リクエストの処理中にサーバで異常が発生しました。

レスポンスボディ

contained-hostsリソースのオブジェクトを返却します。

使用例

サブシステム番号0に存在する構成ホストの一覧を取得する場合の、APIの使用例を次に示します。

リクエスト例
GET /Systemwalker-omgr/api/v1/contained-hosts?subsystem=0 HTTP/1.1
Host: Systemwalker Operation Managerサーバのホスト名:9900
Authorization: Basic ********************
レスポンス例

dataフィールドのオブジェクト配列として、contained-hostsリソースのオブジェクトを返却します。contained-hostsリソースのオブジェクトについては、“18.3.5.1 構成ホスト情報の取得”のレスポンス例を参照してください。

前次
Copyright 1995-2021 FUJITSU LIMITED