Hitachi

JP1 Version 12 JP1/Automatic Operation コマンド・API リファレンス 


2.7.21 タスクログの取得

機能

指定したタスクのタスクログを取得します。

実行権限

Adminロール,Developロール,Modifyロール,Submitロール

APIのバージョン

v1

リクエスト形式

GET http://host:port/Automation/version/objects/TaskLogs

APIの実行ユーザーが権限を持つすべてのタスクを対象に,指定したtaskIDのタスクログを取得します。クエリパラメータを指定すると,一覧を取得する対象を絞り込めます。

指定したtaskIDのタスクログを,offsetに指定した値を起点にし,最大でreadSize分取得します。reverseを指定した場合は,offsetから逆方向にreadSize分取得します。クエリパラメータは,次の形式で指定してください。

なお,ログは行単位で取得されます。指定したログサイズに達した場合は,取得中の行は取得されません。

?クエリパラメータ=[&クエリパラメータ=...] 
表2‒71 API「タスクログの取得」に指定できるクエリパラメータの一覧

クエリパラメータ

フィルタ条件

taskID

指定した値と等しい

readSize

指定した値と等しい(ただし,タスクログの最後まで)

offset

指定した値と等しい

reverse

offsetからの取得方向を逆にする

注※

reverseには,値を指定しないでください。

そのほかに指定できるクエリパラメータについては,「2.2.9 クエリパラメータ」を参照してください。

指定例

taskID=512のタスクログを,読み出し位置3,000バイトから逆方向に1,000バイト分,取得する場合の指定例を次に示します。

?taskID=512&offset=3000&readSize=1000&reverse

ステータスコード

リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します。

ステータスコード

メッセージ

説明

200

OK

成功しました。

400

Bad Request

引数が不正です。

401

Unauthorized

ログイン権限がありません。

404

Not found

権限が不正です。または,リソースがありません。

412

Precondition failed

サーバが起動していません。

500

Server-side error

サーバ処理エラーが発生しました。

レスポンスのスキーマ

リクエストに対するレスポンスボディーの構造を次に示します。

{
  "data" : [ {"タスクログ機能のリソース(Tasklogs)のメンバー" :  ... }, ... ],
  "count" : クエリパラメータの条件に合致したデータの個数(0~n)
}

使用例

taskID=2052のタスクログを,最初(読み出し位置0バイト)から5,000,000バイト分,取得する場合の使用例を示します。

リクエストヘッダー:

GET /Automation/v1/objects/TaskLogs?taskID=2052&offset=0&readSize=5000000 HTTP/1.1
Host: 10.196.184.238:22015
Accept: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: useragent1
Accept-Language: ja

レスポンスヘッダー:

HTTP/1.1 200 OK
Date: Mon, 14 Jul 2014 12:42:47 GMT
Server: Cosminexus HTTP Server
Access-Control-Expose-Headers: WWW-Authenticate
WWW-Authenticate: HSSO a6daa83f23a873c39c7a65069728796ce882153_V0300
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, HEAD, OPTIONS
Access-Control-Allow-Credentials: true
Cache-Control: no-cache
Transfer-Encoding: chunked
Content-Type: application/json

レスポンスボディー:

{
  "data" : [ {
    "instanceID" : 2052,
    "text" : "**** Windows Server 2012 R2 6.3
TZ=America/Los_Angeles
2014/07/14 04:57:31.730\r\n     
yyyy/mm/dd hh:mm:ss.sss                      pid      tid      message-id            message(LANG=ja)\r\n
8947 2014/07/14 04:57:31.746     Automation       27A4F43E 12252248 KNAE08001-I           部品実行を開始しました(タスク名:Execute remote command_20140714045708,タスクID:2052,ステップID:/remoteHostCommandExe,実行ID:@A102)。\r\n
9101 2014/07/14 04:57:31.824     Automation       27A4F43E 12252248 KNAE08129-I           汎用コマンド実行を開始しました(コマンド:a)。\r\n
9103 2014/07/14 04:57:31.824     Automation       27A4F43E 12252248 KNAE08070-I           root権限に昇格する設定(SSH接続用)が有効になっています。\r\n
9140 2014/07/14 04:57:34.433     Automation       27A4F43E 12252248 KNAE08131-E      ER   汎用コマンド実行に失敗しました(コマンド:a,部品戻り値:77)。\r\n
9148 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08002-I           部品実行を終了しました(タスク名:Execute remote command_20140714045708,タスクID:2052,ステップID:/remoteHostCommandExe,実行ID:@A102,部品戻り値:77)。\r\n
9152 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           schema_version=1.1\r\n9154 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           vendor=com.hitachi.software.dna\r\n
9156 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           name=ExecuteCommandPlugin\r\n9158 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           version=01.10.00\r\n
9160 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           plugin_type=javaClass\r\n9162 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           vendor_display_name=(株)日立製作所\r\n
9164 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           display_name=汎用コマンド実行部品\r\n
9166 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           short_description=コマンドラインを対象ホストで実行する部品です。\r\n
9168 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           tags=Basic,Hitachi\r\n9170 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           enable_SSH_charset_detection=true\r\n
9172 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=com.hitachi.software.dna.sys.mail.bcc, value=\r\n
9174 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=com.hitachi.software.dna.sys.mail.cc, value=\r\n
9177 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=com.hitachi.software.dna.sys.mail.from, value=********\r\n
9179 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=com.hitachi.software.dna.sys.mail.notify, value=false\r\n
9182 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=com.hitachi.software.dna.sys.mail.smtp.password, value=********\r\n
9184 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=com.hitachi.software.dna.sys.mail.smtp.port, value=25\r\n
9186 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=com.hitachi.software.dna.sys.mail.smtp.server, value=\r\n
9188 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=com.hitachi.software.dna.sys.mail.smtp.userid, value=\r\n
9190 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=com.hitachi.software.dna.sys.mail.to, value=\r\n
9192 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=com.hitachi.software.dna.sys.task.log.level, value=10\r\n
9194 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=common.remoteCommand, value=a\r\n
9196 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=common.remoteCommandParameter, value=a\r\n
9198 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=common.stdoutProperty, value=\r\n
9200 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=common.targetHost, value=a\r\n
9202 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=foreach.max_value, value=3\r\n
9204 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=mail.plugin.retry.interval, value=10\r\n
9206 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=mail.plugin.retry.times, value=3\r\n
9208 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=plugin.private.builtin.baseUrl, value=http://WIN-JLTV0PQLK2A:22015/Automation/\r\n
9210 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=reserved.service.category, value=OS_Operations/Basic\r\n
9212 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=reserved.service.name, value=Execute remote command\r\n
9214 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=reserved.service.resourceGroupName, value=DefaultServiceGroup\r\n
9216 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=reserved.step.path, value=/remoteHostCommandExe\r\n
9218 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=reserved.step.prevReturnCode, value=0\r\n
9220 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=reserved.task.description, value=\r\n
9222 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=reserved.task.dir, value=C:\\Program Files\\HiCommand\\Automation\\data\\task\\2052\r\n
9224 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=reserved.task.id, value=2052\r\n
9226 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=reserved.task.name, value=Execute remote command_20140714045708\r\n
9228 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=reserved.task.submitter, value=System\r\n
9230 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=reserved.task.url, value=http://WIN-JLTV0PQLK2A:22015/Automation/launcher/TaskDetails?task_id=2052\r\n
9232 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=account, value=\r\n
9234 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=commandLine, value=a\r\n
9236 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=commandLineParameter, value=a\r\n
9238 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=credentialType, value=destination\r\n
9240 2014/07/14 04:57:34.449     Automation       27A4F43E 12252248 KNAE08004-I           property=destinationHost, value=a\r\n
9243 2014/07/14 04:57:34.457     Automation       27A4F43E 12252248 KNAE08004-I           property=password, value=********\r\n
9245 2014/07/14 04:57:34.457     Automation       27A4F43E 12252248 KNAE08004-I           property=stdoutPattern1, value=((?s).*)\r\n
9247 2014/07/14 04:57:34.457     Automation       27A4F43E 12252248 KNAE08004-I           property=stdoutPattern2, value=\r\n
9249 2014/07/14 04:57:34.457     Automation       27A4F43E 12252248 KNAE08004-I           property=stdoutPattern3, value=\r\n
9252 2014/07/14 04:57:34.457     Automation       27A4F43E 12252248 KNAE08004-I           property=suPassword, value=********\r\n
9254 2014/07/14 04:57:34.457     Automation       27A4F43E 12252248 KNAE08009-I           部品の標準出力はありません。\r\n
9258 2014/07/14 04:57:34.699     Automation       27A4F43E 12252248 KNAE08014-E      ER   指定された接続先ホスト名の名前解決に失敗しました(詳細情報:a  [errno=11004, syscall=getaddrinfo])。
指定された接続先ホスト名の名前解決ができません。接続先ホスト名の指定値,ネットワークおよびDNSの設定を確認して,再度サービスを実行してください。\r\n
9260 2014/07/14 04:57:34.699     Automation       27A4F43E 12252248 KNAE08016-E      ER   部品実行で障害が発生しました(タスク名:Execute remote command_20140714045708,タスクID:2052,ステップID:/remoteHostCommandExe,実行ID:@A102,部品戻り値:77)。\r\n
次の要因が考えられます。\r\n・部品実行で何らかの障害が発生した。\r\n・タスクの強制停止操作が行われた。\r\n
・本製品の停止操作が行われた。\r\n
タスクログおよび公開ログ(Server[n].log)の発生時刻前後のメッセージを確認して対処してください。タスクの強制停止や本製品の停止操作の形跡がなく,
発生時刻前後にエラーメッセージも出力されていない場合は,資料採取ツールで資料を採取し,システム管理者に連絡してください。\r\n
**** Windows Server 2012 R2 6.3                                                    TZ=America/Los_Angeles           2014/07/14 04:58:17.793\r\n
yyyy/mm/dd hh:mm:ss.sss                      pid      tid      message-id            message(LANG=ja)\r\n
9913 2014/07/14 04:58:17.793     Automation       27A4F43E 1A87FBF6 KNAE08904-I           失敗した次のステップからリトライしました(ユーザーID:System)。\r\n",
    "totalSize" : 9477,
    "readSize" : 9477,
    "lineCount" : 66,
    "offset" : 0,
    "reverse" : false
  } ],
  "count" : 1
}