2.6.1 スケジュール一覧の取得
機能
指定したタスクに設定されているスケジュール一覧を取得します。
実行権限
Adminロール,Developロール,Modifyロール,Submitロール
APIのバージョン
v1
リクエスト形式
GET http://host:port/Automation/version/objects/Schedules
APIの実行ユーザーが権限を持つ,すべてのスケジュールを対象として一覧を取得します。クエリパラメータを指定すると,一覧を取得する対象を絞り込めます。クエリパラメータは,次の形式で指定してください。
?クエリパラメータ=値[&クエリパラメータ=値...]
クエリパラメータ |
フィルタ条件 |
---|---|
serviceID |
指定した値と等しい |
serviceGroupID |
|
serviceTemplateID |
|
scheduleStatus※ |
未実行のタスクのスケジュール情報 |
- 注※
未実行のタスクのスケジュール情報を取得したい場合は,scheduleStatus に「running」を指定してください。
そのほかに指定できるクエリパラメータについては,「2.2.9 クエリパラメータ」を参照してください。
- 指定例
クエリパラメータとして,serviceIDに2015を指定する例を次に示します。
?serviceID=2015
ステータスコード
リクエストに対するレスポンスとして返却されるステータスコードを,次の表に示します。
ステータスコード |
メッセージ |
説明 |
---|---|---|
200 |
OK |
成功しました。 |
400 |
Bad Request |
クエリパラメータが不正です。 |
401 |
Unauthorized |
ログイン権限がありません。 |
412 |
Precondition failed |
サーバが利用できません。 |
500 |
Server-side error |
サーバ処理エラーが発生しました。 |
レスポンスのスキーマ
レスポンスボディーには,リクエストで指定したクエリパラメータの条件に合致したデータが返却されます。レスポンスボディーのスキーマを次に示します。
{ "data" : [ {"スケジュール機能のリソース(Schedules)のメンバー" : 値 ... }, ... ], "count" : クエリパラメータの条件に合致したデータの個数(0~n) }
使用例
すべてのスケジュールを対象として,スケジュール一覧を取得する場合の使用例を示します。
リクエストヘッダー: GET /Automation/v1/objects/Schedules 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:25:42 GMT Server: Cosminexus HTTP Server Access-Control-Expose-Headers: WWW-Authenticate WWW-Authenticate: HSSO 1aa95d66e62d885b5583da3620bd166fd3a3_Vlo8Y30JBWoKHUYTEXAMXx5iHgQ=_V0810 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" : 2060, "name" : "testService1_20140714044426_Resubmit", "submitter" : "System", "scheduleType" : "immediate", "createTime" : "2014-07-14T05:19:39.000-0700", "modifyTime" : "2014-07-14T05:19:39.000-0700", "description" : "", "serviceState" : "release", "serviceID" : 2015 }, { "instanceID" : 2029, "name" : "testService1_20140714045613", "submitter" : "System", "scheduleType" : "immediate", "createTime" : "2014-07-14T04:56:15.000-0700", "modifyTime" : "2014-07-14T04:56:15.000-0700", "description" : "", "serviceState" : "release", "serviceID" : 2015 }, { "instanceID" : 2025, "name" : "testService1_20140714044426", "submitter" : "System", "scheduleType" : "immediate", "createTime" : "2014-07-14T04:45:34.000-0700", "modifyTime" : "2014-07-14T04:45:34.000-0700", "description" : "", "serviceState" : "release", "serviceID" : 2015 }, { "instanceID" : 2056, "name" : "Execute remote command_20140714045708", "submitter" : "System", "scheduleType" : "immediate", "createTime" : "2014-07-14T04:57:09.000-0700", "modifyTime" : "2014-07-14T04:57:09.000-0700", "description" : "", "serviceState" : "test", "serviceID" : 2040 }, { "instanceID" : 2134, "name" : "stop_20140714052330", "submitter" : "System", "scheduleType" : "immediate", "createTime" : "2014-07-14T05:23:32.000-0700", "modifyTime" : "2014-07-14T05:23:32.000-0700", "description" : "", "serviceState" : "test", "serviceID" : 2092 } ], "count" : 5 }