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

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

8.6 リソースを探索する

instanceIDで指定したIPアドレス範囲の情報を使用してネットワーク内のリソースを探索し，管理対象に追加します。

ロール

All-Resources-Admin

リクエストライン

PUT http://＜host＞:＜port＞/ComputeSystemsManager/v1/objects/IPAddressRanges/＜instanceID＞/actions/Discovery/invoke

instanceID:
Compute Systems Managerによって割り当てられた識別キー。

リクエストボディー

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

IPAddressRanges 

{
        "discoveryType":"...",
        "first":"...",
        "unresponsive":"...",
        "failed":"...",
        "emailNotificationType":"...",
        "schedule":"...",
        "time":"..."
}
属性 データ型 数 説明
discoveryType string 0～1 探索種別。
  • All：ipAddressRangeに指定されたすべてのリソースを探索します。
  • Undiscovery：ipAddressRangeに指定されたリソースのうち，前回探索していないリソースを探索します。（デフォルト）
first string 0～1 以前に探索していないリソースを探索します。discoveryTypeに'Undiscovery'を指定した場合に有効。
  • Disable
  • Enable（デフォルト）
unresponsive string 0～1 前回の探索で応答のなかったリソースを探索します。discoveryTypeに'Undiscovery'を指定した場合に有効。
  • Disable
  • Enable（デフォルト）
failed string 0～1 前回の探索で失敗したリソースを探索します。discoveryTypeに'Undiscovery'を指定した場合に有効。
  • Disable
  • Enable（デフォルト）
emailNotificationType string 0～1 Eメール送信モード。
  • SEND：Eメールを送信します。
  • SEND_ONLY_DISCOVERED_RESOURCES：新たにリソースが探索されたときだけEメールを送信します。
  • NOT_SEND：Eメールを送信しません。（デフォルト）
schedule string 1 探索を実行するタイミング。
  • NOW：すぐに実行します。
  • LATER：timeで指定した時間に実行します。
time string 0～1 探索を実行する管理サーバの時刻（書式：YYYY/MM/DD HH:MM:SS）。過去の時刻は指定できません。scheduleが'LATER'のときに有効です。

レスポンスボディー

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

ApiResult 

{
        "id":...
}
属性 データ型 数 説明
id integer 1 管理対象リソース探索のために登録されたタスクのタスクIDが返ります。

リターンコード

HTTPステータスコード 結果コード 詳細コード 説明
202 0 0 正常終了。
400 2010 1 discoveryTypeに無効な値を指定しました。
400 2010 2 firstに無効な値を指定しました。
400 2010 3 unresponsiveに無効な値を指定しました。
400 2010 4 failedに無効な値を指定しました。
400 2010 5 emailNotificationTypeに無効な値を指定しました。
400 2010 6 scheduleを指定していません。
400 2010 7 scheduleに無効な値を指定しました。
400 2010 8 scheduleに'LATER'を指定する場合は，timeも指定する必要があります。
400 2010 9 timeに無効な値を指定しました。
400 2010 10 指定した日付は2100年12月31日以降です。
400 2010 11 discoveryTypeに'Undiscovery'を指定したにも関わらず，first，unresponsiveおよびfailedのすべてに'Disable'が指定されています。
400 2010 100 リクエストボディーが指定されていません。
400 2010 101 リクエストボディーの書式が無効です。JSONの書式で記述してください。
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 管理対象を参照する権限がありません。
404 - - 指定したinstanceIDまたはcollectionはありません。
405 - - サポートされていないメソッドです。
406 2010 1 HTTPヘッダーのAcceptの値が不正です。
412 2018 1 timeに過去の時刻を指定しました。
415 - - HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500 - - HTTPヘッダーのContent-Typeに不正な値が指定されている，またはそれ以外の内部エラーです。
500 1000 1 ログインに失敗しました（内部エラー）。
503 2020 1 要求の数がAPIの同時最大接続数を超えました。

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

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