Hitachi

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


2.1 API一覧

JP1/AOで使用できるAPIの一覧を次の表に示します。

表2‒1 サービステンプレート機能のAPI一覧

API名

機能

参照先

サービステンプレート一覧の取得

JP1/AOに登録されているサービステンプレートの一覧を取得します。

2.4.1 サービステンプレート一覧の取得

サービステンプレートの情報取得

指定したサービステンプレートの情報を取得します。

2.4.2 サービステンプレートの情報取得

サービステンプレートの削除

指定したサービステンプレートを削除します。

2.4.3 サービステンプレートの削除

サービステンプレートに対する操作一覧の取得

指定したサービステンプレートに対して実行できる操作の一覧を取得します。

2.4.4 サービステンプレートに対する操作一覧の取得

サービステンプレートのインポートに必要なHTMLファイルの取得

指定したサービステンプレートのインポートに必要なHTMLファイルを取得します。

2.4.5 サービステンプレートのインポートに必要なHTMLファイルの取得

サービステンプレートのインポート

指定したサービステンプレートをインポートします。

2.4.6 サービステンプレートのインポート

サービステンプレートのエクスポートに必要な情報の取得

指定したサービステンプレートのエクスポートに必要な情報を取得します。

2.4.7 サービステンプレートのエクスポートに必要な情報の取得

サービステンプレートのエクスポート

指定したサービステンプレートをエクスポートします。

2.4.8 サービステンプレートのエクスポート

サービステンプレートの詳細説明を表示するURLの取得

指定したサービステンプレートの詳細説明を表示するURLを取得します。

2.4.9 サービステンプレートの詳細説明を表示するURLの取得

サービステンプレートを基にしたサービスの作成に必要な情報の取得

指定したサービステンプレートからサービスを作成する場合に必要な情報を取得します。

2.4.10 サービステンプレートを基にしたサービスの作成に必要な情報の取得

サービステンプレートを基にしたサービスの作成

指定したサービステンプレートからサービスを作成します。サービスの作成時に,プロパティを指定できます。

2.4.11 サービステンプレートを基にしたサービスの作成

表2‒2 サービス機能のAPI一覧

API名

機能

参照先

サービス一覧の取得

JP1/AOに登録されているサービスの一覧を取得します。

2.5.1 サービス一覧の取得

サービスの情報取得

指定したサービスの情報を取得します。

2.5.2 サービスの情報取得

サービスの編集

指定したサービスを編集します。

2.5.3 サービスの編集

サービスの削除

指定したサービスを削除します。

2.5.4 サービスの削除

サービスに対する操作一覧の取得

指定したサービスに対して実行できる操作の一覧を取得します。

2.5.5 サービスに対する操作一覧の取得

サービス実行に必要な情報の取得

指定したサービスの実行操作に必要な情報を取得します。

2.5.6 サービス実行に必要な情報の取得

サービスの実行

指定したサービスを実行します。

2.5.7 サービスの実行

サービスのカウンターのリセットに必要な情報の取得

指定したサービスのカウンターのリセット(統計情報の初期化)に必要な情報を取得します。

2.5.8 サービスのカウンターのリセットに必要な情報の取得

サービスのカウンターのリセット

指定したサービスのカウンターをリセット(統計情報を初期化)します。

2.5.9 サービスのカウンターのリセット

サービスの状態を「リリース」に変更する操作に必要な情報の取得

指定したサービスの状態を「リリース」に変更する操作に必要な情報を取得します。

2.5.10 サービスの状態を「リリース」に変更する操作に必要な情報の取得

サービスの状態を「リリース」に変更

指定したサービスの状態を「リリース」に変更します。

2.5.11 サービスの状態を「リリース」に変更

サービスの状態を「メンテナンス」に変更する操作に必要な情報の取得

指定したサービスの状態を「メンテナンス」に変更する操作に必要な情報を取得します。

2.5.12 サービスの状態を「メンテナンス」に変更する操作に必要な情報の取得

サービスの状態を「メンテナンス」に変更

指定したサービスの状態を「メンテナンス」に変更します。

2.5.13 サービスの状態を「メンテナンス」に変更

サービスの状態を「無効」に変更する操作に必要な情報の取得

指定したサービスの状態を「無効」に変更する操作に必要な情報を取得します。

2.5.14 サービスの状態を「無効」に変更する操作に必要な情報の取得

サービスの状態を「無効」に変更

指定したサービスの状態を「無効」に変更します。

2.5.15 サービスの状態を「無効」に変更

サービスの詳細説明のURLを取得

指定したサービスの詳細説明を表示するURLを取得します。

2.5.16 サービスの詳細説明のURLを取得

サービスが使用するサービステンプレートのバージョン変更に必要な情報の取得

指定したサービスが使用するサービステンプレートのバージョン変更に必要な情報を取得します。

2.5.17 サービスが使用するサービステンプレートのバージョン変更に必要な情報の取得

サービスが使用するサービステンプレートのバージョン変更

指定したサービスに,任意のバージョンのサービステンプレートを適用します。

2.5.18 サービスが使用するサービステンプレートのバージョン変更

表2‒3 スケジュール機能のAPI一覧

API名

機能

参照先

スケジュール一覧の取得

タスクに設定されているスケジュール一覧を取得します。

2.6.1 スケジュール一覧の取得

スケジュールの情報取得

指定したスケジュールの情報を取得します。

2.6.2 スケジュールの情報取得

スケジュールに対する操作一覧の取得

指定したスケジュールに対して実行できる操作の一覧を取得します。

2.6.3 スケジュールに対する操作一覧の取得

スケジュールのキャンセルに必要な情報の取得

指定したスケジュールをキャンセルするために必要な情報を取得します。

2.6.4 スケジュールのキャンセルに必要な情報の取得

スケジュールのキャンセル

指定したスケジュールをキャンセルします。

2.6.5 スケジュールのキャンセル

スケジュールの一時停止に必要な情報の取得

指定したスケジュールを一時停止するために必要な情報を取得します。

2.6.6 スケジュールの一時停止に必要な情報の取得

スケジュールの一時停止

指定したスケジュールを一時停止します。

2.6.7 スケジュールの一時停止

スケジュールの再開に必要な情報の取得

指定したスケジュールを再開するために必要な情報を取得します。

2.6.8 スケジュールの再開に必要な情報の取得

スケジュールの再開

指定したスケジュールを再開します。

2.6.9 スケジュールの再開

表2‒4 タスク機能のAPI一覧

API名

機能

参照先

タスク一覧の取得

タスクの一覧を取得します。

2.7.1 タスク一覧の取得

タスクの情報取得

指定したタスクの情報を取得します。

2.7.2 タスクの情報取得

タスクの編集

指定したタスクのノートおよびTODOを編集します。

2.7.3 タスクの編集

タスクの削除

指定したタスクを削除します。指定したタスクがデバッグタスク以外の場合は,アーカイブするためのURLを取得します。

2.7.4 タスクの削除

タスク操作一覧の取得

指定したタスクに対して実行できる操作の一覧を取得します。

2.7.5 タスク操作一覧の取得

タスクの実行停止に必要な情報の取得

指定したタスクを実行停止するために必要な情報を取得します。

2.7.6 タスク実行停止に必要な情報の取得

タスクの実行停止

指定したタスクを実行停止します。

2.7.7 タスクの実行停止

タスクの強制停止に必要な情報の取得

指定したタスクを強制停止するために必要な情報を取得します。

2.7.8 タスクの強制停止に必要な情報の取得

タスクの強制停止

指定したタスクを強制停止します。

2.7.9 タスクの強制停止

タスクの再実行に必要な情報の取得

指定したタスクを再実行するために必要な情報を取得します。

2.7.10 タスクの再実行に必要な情報の取得

タスクの再実行

指定したタスクを再実行します。

2.7.11 タスクの再実行

応答待ち中のタスクに応答するために必要な情報の取得

応答待ち中のタスクに応答するために必要な情報を取得します。取得するのは,指定したIDのタスクの中で,応答待ち中になった日時が最も古いステップの情報です。

2.7.12 応答待ち中のタスクに応答するために必要な情報の取得

応答待ち中のタスクに応答

指定したIDのタスクの中で,応答待ち中になった日時が最も古いステップに応答入力します。

2.7.13 応答待ち中のタスクに応答

タスクのリトライに必要な情報の取得(失敗したステップからリトライ)

タスクを指定し,失敗したステップからリトライするために必要な情報を取得します。

2.7.14 タスクのリトライに必要な情報の取得(失敗したステップからリトライ)

失敗したステップからリトライ

タスクを指定し,失敗したステップからリトライします。

2.7.15 失敗したステップからリトライ

タスクのリトライに必要な情報の取得(失敗した次のステップからリトライ)

タスクを指定し,失敗した次のステップからリトライするために必要な情報を取得します。

2.7.16 タスクのリトライに必要な情報の取得(失敗した次のステップからリトライ)

失敗した次のステップからリトライ

タスクを指定し,失敗した次のステップからリトライします。

2.7.17 失敗した次のステップからリトライ

タスクのアーカイブに必要な情報の取得

指定したタスクをアーカイブするために必要な引数のテンプレートを取得します。

2.7.18 タスクのアーカイブに必要な情報の取得

タスクのアーカイブ

指定したタスクをアーカイブします。

2.7.19 タスクのアーカイブ

ステップ一覧の取得

指定したタスクに含まれるステップのうち,[タスク詳細]画面に表示されるステップの一覧を取得します。

2.7.20 ステップ一覧の取得

タスクログの取得

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

2.7.21 タスクログの取得

表2‒5 履歴関連のAPI一覧

API名

機能

参照先

履歴一覧の取得

履歴の一覧を取得します。

2.8.1 履歴一覧の取得

履歴の削除(条件指定)

クエリパラメータの条件に従って,履歴を削除します。

2.8.2 履歴の削除(条件指定)

履歴の取得

指定したIDの履歴を取得します。

2.8.3 履歴の取得

履歴の削除(ID指定)

指定したIDの履歴を削除します。

2.8.4 履歴の削除(ID指定)

履歴に対する操作一覧の取得

指定したIDの履歴に対して実行できる操作の一覧を取得します。

2.8.5 履歴に対する操作一覧の取得

表2‒6 プロパティ関連のAPI一覧

API名

機能

参照先

プロパティ定義一覧の取得

プロパティ定義の一覧を取得します。

2.9.1 プロパティ定義一覧の取得

プロパティ定義情報の取得

指定したプロパティ定義の情報を取得します。

2.9.2 プロパティ定義情報の取得

プロパティ定義に対する操作一覧の取得

指定したプロパティ定義に対して実行できる操作の一覧を取得します。

2.9.3 プロパティ定義に対する操作一覧の取得

プロパティ定義およびプロパティ値一覧の取得

プロパティ定義およびプロパティ値の情報の一覧を取得します。

2.9.4 プロパティ定義およびプロパティ値一覧の取得

プロパティ値一覧の取得

次に示すプロパティ値の一覧を取得します。

  • サービス共有プロパティ

  • 特定のサービスに関連するプロパティ

  • 特定のスケジュールに関連するプロパティ

2.9.5 プロパティ値一覧の取得

プロパティ値の一括更新

次に示すプロパティ値を一括更新します。

  • 特定のタスクに関連するプロパティ値

  • 特定のサービスに関連するプロパティ値

  • サービス共有プロパティの値

  • 複数のサービスのプロパティ値

2.9.6 プロパティ値の一括更新

プロパティ値の取得

指定したプロパティ値の情報を取得します。

2.9.7 プロパティ値の取得

プロパティ値の更新

指定したIDのプロパティ値を更新します。

2.9.8 プロパティ値の更新

プロパティ値に対する操作一覧の取得

指定したプロパティ値に対する操作の一覧を取得します。

2.9.9 プロパティ値に対する操作一覧の取得

プロパティグループ一覧の取得

サービスが保持するプロパティが所属しているプロパティグループの一覧を取得します。

2.9.10 プロパティグループ一覧の取得

表2‒7 サービスグループ関連のAPI一覧

API名

機能

参照先

サービスグループ一覧の取得

サービスグループ一覧を取得します。

2.10.1 サービスグループ一覧の取得

サービスグループ情報の取得

指定したサービスグループの情報を取得します。

2.10.2 サービスグループ情報の取得

サービスグループに対する操作一覧の取得

指定したサービスグループに対して実行できる操作の一覧を取得します。

2.10.3 サービスグループに対する操作一覧の取得

表2‒8 タグ関連のAPI一覧

API名

機能

参照先

タググループ一覧の取得

タググループの一覧を取得します。また,タググループに所属するタグ一覧を取得します。

2.11.1 タググループ一覧の取得

タグ一覧の取得

指定したリソースに設定されているタグの一覧を取得します。

2.11.2 タグ一覧の取得

表2‒9 情報管理のAPI一覧

API名

機能

参照先

ユーザー情報の取得

APIを実行したユーザーの情報を取得します。

2.12.1 ユーザー情報の取得

バージョン情報の取得

JP1/AOとAPIのバージョンを取得します。

2.12.2 バージョン情報の取得