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

18.3.4 queuesリソース

Systemwalker Operation Managerに登録済みのキューを操作します。

以下の操作が可能です。

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

HTTP
メソッド

操作内容

/v1/queues/{queuename}

GET

指定したキューの情報を取得します。

POST

指定したキューを操作します。

PUT

指定したキューの定義を一時変更します。

/v1/queues

GET

プロジェクト情報の一覧を取得します。

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

なお、システムで一意のキューを指定する場合、SE版では、キュー名を指定します。EE版およびGEE版では、サブシステム番号とキュー名を指定します。

フィールド名

型

説明

host

文字列

接続先のホスト名

subsystem

数値

サブシステム番号

queuename

文字列

キュー名

status

リスト

キューの状態
ACT：キューは動作中です
INACT：キューは停止中です

maxexec

数値

多重度
無制限の場合、-1を返却します。

run

数値

実行中ジョブ数

que

数値

実行待ちジョブ数

hold

数値

実行保留ジョブ数

qprty

数値

実行優先順位

dprty

数値

実行優先度

maxjob

数値

投入可能ジョブ数
無制限の場合、-1を返却します。

elapse

数値

経過時間制限
無制限の場合、0を返却します。

hostgroup

文字列

ホストグループ名
指定されていない場合、“*”を返却します。

18.3.4.1 キュー情報の取得

機能説明

queuesリソースを指定したGETメソッドのリクエストを送ることで、対象のキュー情報を取得します。

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

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

リクエスト

HTTPメソッド

GET

リクエストURI

/v1/subsystems/{subsystem}/queues/{queuename}

/v1/queues/{queuename}  (サブシステム番号を省略する場合)

リクエストパラメータ

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

パラメータ

指定方法

型

説明

subsystem

パス

数値

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

queuename(*)

パス

文字列

対象のキュー名を指定します。

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

パス：パスパラメータ

レスポンス

ステータスコード

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

コード

説明

200

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

401

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

403

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

404

対象のキューは存在しません。

  • システムに対象のキューが存在しない

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

500

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

レスポンスボディ

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

使用例

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

リクエスト例
GET /Systemwalker-omgr/api/v1/subsystems/0/queues/queue1 HTTP/1.1
Host: Systemwalker Operation Managerサーバのホスト名:9900
Authorization: Basic ********************
レスポンス例
{
  "host": "Systemwalker Operation Managerサーバのホスト名",
  "subsystem": 0,
  "queuename": "queue1",
  "status": "ACT",
  "maxexec": 256,
  "run": 0,
  "que": 0,
  "hold": 0,
  "qprty": 31,
  "dprty": 2,
  "maxjob": -1,
  "elapse": 0,
  "hostgroup": "hostgroup1"
}

18.3.4.2 キューの定義の一時変更

機能説明

queuesリソースを指定したPUTメソッドのリクエストを送ることで、対象のキューの定義を一時変更します。

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

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

リクエスト

HTTPメソッド

PUT

リクエストURI

/v1/subsystems/{subsystem}/queues/{queuename}

/v1/queues/{queuename}  (サブシステム番号を省略する場合)

リクエストパラメータ

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

パラメータ

指定方法

型

説明

subsystem

パス

数値

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

queuename(*)

パス

文字列

対象のキュー名を指定します。

maxexec

ボディ

数値

多重度(同時実行可能数)をします。範囲は1～999です。

qprty

ボディ

数値

実行優先順位をします。範囲は0～63です。

dprty

ボディ

数値

実行優先度をします。範囲は、Windows版の場合は0～4、Linux版の場合は-20～19です。

maxjob

ボディ

数値

投入可能ジョブ数を指定します。範囲は1～999です。

elapse

ボディ

数値

経過時間制限値をします。範囲は1～99999999です。

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

パス：パスパラメータ

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

レスポンス

ステータスコード

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

コード

説明

200

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

400

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

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

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

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

401

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

403

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

404

対象のキューは存在しません。

  • システムに対象のキューが存在しない

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

500

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

レスポンスボディ

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

注意事項

使用例

サブシステム番号0、キュー名が“queue1”のキューの多重度を99に、投入可能ジョブ数を200にする場合のAPIの使用例を以下に示します。

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

{
  "maxexec": 99,
  "maxjob": 200
}
レスポンス例

多重度が99に、投入可能ジョブ数が200に変更されたqueuesリソースのオブジェクトが返ります。“18.3.4.1 キュー情報の取得”のレスポンス例を参照してください。

18.3.4.3 キューの操作

機能説明

queuesリソースを指定したPOSTメソッドのリクエストを送ることで、対象のキューを操作(停止/開始)します。

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

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

リクエスト

HTTPメソッド

POST

リクエストURI

/v1/subsystems/{subsystem}/queues/{queuename}

/v1/queues/{queuename}  (サブシステム番号を省略する場合)

リクエストパラメータ

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

パラメータ

指定方法

型

説明

subsystem

パス

数値

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

queuename(*)

パス

文字列

対象のキュー名を指定します。

control(*)

ボディ

リスト

キューへの操作種別を指定します。

start: キューを起動します

stop: キューを停止します

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

パス：パスパラメータ

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

レスポンス

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

コード

説明

200

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

400

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

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

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

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

401

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

403

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

404

対象のキューは存在しません。

  • システムに対象のキューが存在しない

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

500

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

レスポンスボディ

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

使用例

サブシステム番号0、キュー名が“queue2”のキューを停止する場合のAPIの使用例を以下に示します。

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

{
  "control": "stop"
}
レスポンス例

“18.3.4.1 キュー情報の取得”のレスポンス例を参照してください。

18.3.4.4 キュー情報の一覧取得

機能説明

queuesリソースの一覧を取得します。

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

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

リクエスト

HTTPメソッド

GET

リクエストURI

/v1/queues

リクエストパラメータ

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

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

レスポンス

ステータスコード

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

コード

説明

200

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

400

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

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

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

401

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

403

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

500

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

レスポンスボディ

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

使用例

サブシステム番号0のキューの一覧を取得する場合の、APIの使用例を次に示します。

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

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

前次
Copyright 1995-2021 FUJITSU LIMITED