Compute Systems Manager REST API リファレンスガイド

[目次][前へ][次へ]

6.1 タスクの情報を取得する

指定された状態または種別のタスクを取得します。

ロール

Admin/Modify/View

リクエストライン

GET http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/Tasks?status=タスクステータス&type=タスクタイプ

クエリーパラメーターに指定できる値を次の表に示します。

パラメーター 説明
status タスクの状態を指定します。指定を省略した場合は、デフォルトで実行されます。
  • All（デフォルト）
  • Waiting
  • InProgress：'In%20Progress'でも可。（クォーテーションはつけない）
  • Canceled
  • Completed
  • Failed
type タスクを登録した管理クライアントの種別を指定します。指定を省略した場合は、デフォルトで実行されます
  • GUI
  • CLI（デフォルト）

リクエストボディー

リクエストボディーには何も設定しません。

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。

TaskExecutionInfo 

{
    "TaskExecutionInfo":[{
        "taskID":"...",
        "taskName":"...",
        "status":"...",
        "taskType":"..."
    },
    :
    ]
}
属性 データ型 数 説明
taskID string 1 タスクユニークキー。タスクを特定する識別子。
taskName string 1 ユーザーが付けたタスクの名前。
status string 1 タスクの状態。
  • Waiting
  • In Progress
  • Canceled
  • Completed
  • Failed
taskType string 1 タスクの種類。
  • Unknown
  • Discovery
  • Host Refresh
  • Host Import
  • Shutdown OS
  • Reboot OS
  • Power On
  • Force Power Off
  • Power Reset
  • VM Power On
  • VM Force Power Off
  • VM Power Reset
  • Server Power On
  • Server Force Power Off
  • Server Power Reset
  • LID On
  • LID Off
  • Start Power Capping
  • Stop Power Capping
  • Start Power Capping Rack
  • Stop Power Capping Rack
  • Failover To Standby Blade(Auto)
  • Failover To Standby Blade
  • Failback To Active Blade
  • Test N+M Cold Standby
  • Reassignment Of Standby Blade
  • Blade Health Check
  • Automated Blade Health Check
  • Assignment Restoration
  • Synchronize Status For Failover
  • Synchronize Status For Failback
  • Deployment - Back up
  • Deployment - Snapshot
  • Deployment - Restore
  • Deployment - Check Disk Configuration
  • Delete Image File
  • Deployment - Deploy
  • Deployment - Remove Resource
  • Deployment - Add Resource
  • Deployment - Edit Settings
  • Resource Refresh
  • Resource Auto Refresh
  • Resource Status Refresh
  • Virtualization Refresh
  • Blade Refresh
  • Chassis Refresh
  • Rack Refresh
  • Server Refresh
  • Chassis Power Refresh
  • Server Power Refresh
  • Host Performance Refresh
  • Rack Power Refresh
  • Hypervisor Refresh
  • Update Firmware
  • HVM Shutdown
  • HVM Restart
  • LPAR Activate
  • LPAR Deactivate
  • LPAR Reactivate
  • USB Unassign from LPAR
  • USB Assign to LPAR
  • Create LPAR
  • Edit LPAR
  • Delete LPARs
  • Quick Create Multiple LPARs
  • Edit LPAR Shared FC Settings
  • Edit LPAR Dedicated FC Settings
  • Edit LPAR Dedicated NIC Settings
  • Edit LPAR Virtual NIC Settings
  • Edit LPAR Settings
  • Configure HVM
  • Specify LPAR USB Auto Assignment
  • Edit LPAR USB Settings
  • Edit LPAR Memory Settings
  • Edit LPAR CPU Settings
  • Save HVM Configuration
  • Edit HVM Advanced Settings
  • Migrate LPAR - Verify Compatibility
  • Migrate LPAR
  • Cold Migrate LPAR - Verify Compatibility
  • Cold Migrate LPAR
  • Recover From Failed Migration
  • VM Refresh
  • LPAR Refresh
  • Edit LPAR Boot Order Settings

リターンコード

HTTPステータスコード 結果コード 詳細コード 説明
200 - - 正常終了。
204 - - 未定義のstatusが指定されました。
400 2010 100 クエリーパラメーターのtypeに指定した値が不正です。
401 1000 1 HTTPヘッダーのAuthorizationが指定されていません。
401 1000 2 HTTPヘッダーのAuthorizationの値が不正です（Basic認証，HSSOセッション認証のどちらでもありません）。
401 1000 3 HTTPヘッダーのAuthorizationのBasic認証の値が不正です（認証情報のフォーマットが不正です）。
401 1000 4 ログインに失敗しました。
401 1002 1 ログインセッションが切断されました。または，不正なHSSOトークンが指定されました。
403 1003 1 基本ライセンスが登録されていない，または有効期限を過ぎています。
403 2017 1 管理対象を参照する権限がありません。
405 - - サポートされていないメソッドです。
406 2010 1 HTTPヘッダーのAcceptの値が不正です。
415 - - HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 - - HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 1000 1 ログインに失敗しました（内部エラー）。
500 3000 103 内部エラーが発生しました。
503 2020 1 要求の数がAPIの同時最大接続数を超えました。

[目次] [前へ] [次へ]

All Rights Reserved. Copyright© 2016, Hitachi, Ltd.