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":"..."
}

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

レスポンスボディー

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

ApiResult

{
       "id":...
}

属性データ型説明
idinteger1管理対象リソース探索のために登録されたタスクのタスクIDが返ります。

リターンコード

HTTPステータスコード結果コード詳細コード説明
20200正常終了。
40020101discoveryTypeに無効な値を指定しました。
40020102firstに無効な値を指定しました。
40020103unresponsiveに無効な値を指定しました。
40020104failedに無効な値を指定しました。
40020105emailNotificationTypeに無効な値を指定しました。
40020106scheduleを指定していません。
40020107scheduleに無効な値を指定しました。
40020108scheduleに'LATER'を指定する場合は,timeも指定する必要があります。
40020109timeに無効な値を指定しました。
400201010指定した日付は2100年12月31日以降です。
400201011discoveryTypeに'Undiscovery'を指定したにも関わらず,first,unresponsiveおよびfailedのすべてに'Disable'が指定されています。
4002010100リクエストボディーが指定されていません。
4002010101リクエストボディーの書式が無効です。JSONの書式で記述してください。
40110001HTTPヘッダーのAuthorizationが指定されていません。
40110002HTTPヘッダーのAuthorizationの値が不正です(Basic認証,HSSOセッション認証のどちらでもありません)。
40110003HTTPヘッダーのAuthorizationのBasic認証の値が不正です(認証情報のフォーマットが不正です)。
40110004ログインに失敗しました。
40110021ログインセッションが切断されました。または,不正なHSSOトークンが指定されました。
40310031基本ライセンスが登録されていない,または有効期限を過ぎています。
40320171管理対象を参照する権限がありません。
404--指定したinstanceIDまたはcollectionはありません。
405--サポートされていないメソッドです。
40620101HTTPヘッダーのAcceptの値が不正です。
41220181timeに過去の時刻を指定しました。
415--HTTPヘッダーのContent-Typeにサポートされていない形式が指定されています。
500--HTTPヘッダーのContent-Typeに不正な値が指定されている,またはそれ以外の内部エラーです。
50010001ログインに失敗しました(内部エラー)。
50320201要求の数がAPIの同時最大接続数を超えました。