3.6.1 REST型の通信

機能説明

REST型の通信が可能なホストに対して、REST型の通信を行います。

オプション

基本オプション

(1) hostname

REST型で通信を行うホスト名またはIPアドレスです。

管理サーバにREST通信する場合、以下を指定します。

IPv4の場合: 'localhost'または'127.0.0.1'
IPv6の場合: 'localhost'または'::1'

ホスト名またはIPアドレスを省略した場合、引数エラーとなります。

ホスト名またはIPアドレスの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。

(2) methodname

実行するHTTP(HTTPS)のメソッド名です。

GET、POST、PUT、DELETEを指定します。大文字で指定します。

メソッド名を省略した場合、引数エラーとなります。

メソッド名の文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。

(3) resourcepath

利用するリソースのパスです。

リソースのパスを省略した場合、引数エラーとなります。

パスの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。

リソースのパスは、以下のように指定します。

(例) /webdav/index.html

実行するHTTP(HTTPS)のメソッドがPOST、PUT、DELETEのいずれか場合、以下のように利用するリソースへの引数を指定することができます。

リソースのパスとリソースへの引数を「?」で区切って指定します。
引数の指定は、「引数名=引数の値」で指定します。引数名と引数の値を複数指定する場合は、以下のように「&」で区切ります。

(例) /webdav/index.html?label1=value1&label2=value2

(4) param

利用するリソースへの引数名と引数の値を指定します。

実行するHTTP(HTTPS)のメソッドがGETの場合に指定します。

引数名と引数の値を省略した場合、引数を指定しないREST通信となります。

引数名と引数の値の文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。

指定した引数名と引数の値は、UTF-8の文字コードに変換して通信を行います。

リソースへの引数名と引数の値は、以下のように「引数名=引数の値」で指定します。複数指定する場合は、「&」で区切ります。

(例) label1=value1&label2=value2

実行するHTTP(HTTPS)のメソッドがPOST、PUTの場合は、指定した値はリクエストとしてボディに格納します。

(例) label1=value1&label2=value2

他の形式のリクエストを指定する場合は、requestxmlオプションに指定してください。

実行するHTTP(HTTPS)のメソッドがDELETEの場合は、本オプションの指定は無視します。

拡張オプション

(1) port

REST型で通信を行うホストのポート番号です。

ポート番号は整数型で、0～65535の間で指定します。

ポート番号を省略した場合、80を指定します。

(2) basicusername

BASIC認証を行うユーザー名です。

ユーザー名を省略した場合、BASIC認証を利用しないREST通信を行います。

ユーザー名の文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。

(3) basicpassword

BASIC認証を行うユーザーのパスワードです。

パスワードを省略した場合、BASIC認証を利用しないREST通信を行います。

パスワードの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。

(4) element

REST型通信の実行結果(XML形式)を解析するための要素名のアドレスです。

指定可能な文字列は、半角英数字と半角記号です。

実行結果(XML形式)の文字列から、elementで指定したアドレス(xpath)と一致する内容を文字列で出力します。

該当する要素が複数存在する場合は、要素をダブルクォーテーションで囲み、カンマ区切りで文字列を出力します。

(例) データが「要素A」「要素B "C,D"」の場合："要素A","要素B ""C,D"""

該当する要素が存在しない場合、エラーとなります。

要素名を省略した場合、REST型通信の実行結果はXML形式で出力します。

要素名の文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。

要素名のアドレスは、以下のように指定します。

(例) /response/params/item

(5) proxy

プロキシサーバのアドレスです。

プロキシサーバのアドレスを省略した場合、プロキシサーバを利用しない通信となります。

アドレスの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。

(6) proxyport

プロキシサーバのポート番号です。

ポート番号は整数型で、0～65535の間で指定します。

ポート番号を省略した場合、8080を指定します。

(7) protocoltype

REST通信を行うプロトコル種別です。

http、httpsを指定します。小文字で指定します。

プロトコル種別を省略した場合、httpを指定します。

プロトコル種別の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。

(8) requestxml

REST通信のパラメーターです。

REST通信のパラメーターの文字数の上限は、2048文字です。それより大きい場合、引数エラーとなります。

指定したパラメーターは、UTF-8の文字コードに変換して通信を行います。

本オプションを省略した場合、paramオプションの指定が有効になります。

実行するHTTP(HTTPS)のメソッドがGETの場合

利用するリソースへの引数名と引数の値を指定します。

リソースへの引数名と引数の値は、以下のように「引数名=引数の値」で指定します。複数指定する場合は、「&」で区切ります。
(例)

label1=value1&label2=value2

実行するHTTP(HTTPS)のメソッドがPOST、PUTの場合

REST通信でボディに格納するリクエストを指定します。

テキスト形式のリクエストを指定する場合は、以下のように指定します。
(例)

UDA1=value1
UDA2=value2

XML形式のリクエストを指定する場合は、以下のように指定します。
(例)

<request>
  <data>1234</data>
</request>

実行するHTTP(HTTPS)のメソッドがDELETEの場合: 本オプションの指定は無視します。

(9) contenttype

REST通信で利用するデータ形式（MIMEタイプ）です。

データ形式を省略した場合、application/x-www-form-urlencodedを指定します。

contenttypeには、データ形式に加えて、文字セットを指定できます。

データ形式と文字セットの指定は、以下のように指定します。

（データ形式を指定する例）application/xml

（データ形式と文字セットを指定する例）application/xml; charset=utf-8

contenttypeの文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。

(10) accepttype

REST通信で受信可能なデータ形式（MIMEタイプ）です。

データ形式を省略した場合、データ形式は指定されません。この場合、受信するデータの形式は、通信先の指定に従います。

データ形式の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。

データ形式は、以下のように指定します。

（例）text/plain

(11) timeout

運用操作部品の実行の完了待ち合わせ時間(秒)です。

300～86,400(1日)の範囲で指定が可能です。

(例) 完了待ち合わせを10分間行う場合：600

指定した時間を経過しても運用操作部品の実行が完了しない場合は、運用操作部品の処理を復帰値：201で中断します。

(12) retry

運用操作部品の実行の起動リトライ回数です。

運用操作部品が復帰値：161で終了した場合に、起動リトライを行う回数を指定します。0～5の範囲で指定が可能です。

起動リトライにより再実行した結果、運用操作部品が161以外の復帰値で終了した場合は、指定した起動リトライ回数に達していなくても運用操作部品の実行は終了します。運用操作部品の復帰値は最後に実行した値になります。

(例) 起動リトライを2回行う場合：2

(13) retry_interval

運用操作部品のリトライ間隔(秒)です。

運用操作部品が復帰値：161で終了した場合に、起動リトライを行うまでの間隔を指定します。1～14400の範囲で指定が可能です。

(例) 300秒間隔でリトライを行う場合：300

timeout、retry、およびretry_intervalについて、指定を省略した場合や、範囲外の値を入力した場合は、運用操作部品実行定義ファイルで指定した値が有効になります。詳細は、“2.5 運用操作部品実行定義ファイル”を参照してください。

復帰値

アイコン	シンボル名矢印名	復帰値	意味
	成功	0	REST通信に成功しました。
	失敗	161	REST通信に失敗しました。リトライ回数を指定した場合、リトライします。
		176	elementに該当する要素が存在しませんでした。
		188	実行中に通信が切断しました。
		189	サーバに接続できませんでした。
		197	オプションの内容に誤りがありました。
－	－	201	運用操作部品の実行がタイムアウトしました。
		202	運用操作部品が実行されませんでした。
		203	運用操作部品の実行が失敗しました。管理サーバの環境に問題があります。
		205	運用操作部品が実行されませんでした。運用操作部品の入力情報の指定に問題があります。
		206	運用操作部品を正常に実行できませんでした。運用操作部品の出力情報の指定に問題があります。
		207	運用操作部品が実行されませんでした。運用操作部品が管理サーバに登録されていない可能性があります。
		208	運用操作部品の実行途中に自動運用プロセスのリカバリが行われたため、自動運用プロセスを中止状態にしました。

出力情報

変数	意味
message	REST型の通信に成功した場合、以下のメッセージを設定します。 The operation component was successful. REST型の通信に失敗した場合、エラー内容を文字列として設定します。
rest_communication_result	実行結果を文字列またはXML形式の文字列で設定します。
returnCode	復帰値を設定します。

変数

意味

message

REST型の通信に成功した場合、以下のメッセージを設定します。

The operation component was successful.

REST型の通信に失敗した場合、エラー内容を文字列として設定します。

rest_communication_result

実行結果を文字列またはXML形式の文字列で設定します。

returnCode

復帰値を設定します。

注意事項

事前にREST型通信を行うホストの構築および設定を行ってください。
実行するHTTP(HTTPS)のメソッド名を指定する場合、すべて大文字にし、GET、POST、PUT、DELETEのいずれかを指定してください。
paramに指定する引数名と引数の値には、「&」を指定しないでください。
elementに利用可能な文字列は、半角英数字と半角記号です。
各オプションには、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、運用操作部品の実行に失敗する場合があります。
「～」「￡」「―」「∥」「￠」「￢」「￣」「￥」「〃」
復帰値の確認は、Webコンソールで行います。詳細については、“Systemwalker Runbook Automation 運用ガイド”の“運用操作部品の実行状況・実行結果を確認する”を参照してください。
201～208の復帰値が出力された場合は自動運用プロセスが中止状態またはエラー状態となり、以下の場所にエラーメッセージが出力されます。
- 管理サーバのイベントログ(管理サーバがWindows(R)の場合)
- 管理サーバのシスログ(管理サーバがLinuxの場合)
- BPMNのカスタムメッセージ
上記いずれかの場所でメッセージを確認し、適切な対処を実施してください。メッセージの詳細については、“Systemwalker Runbook Automation メッセージ集”を参照してください。