JP1 Version 11 JP1/Operations Analytics REST APIリファレンス

3021-3-B94-10

前書き

対象製品

P-2A2C-DCBL JP1/Operations Analytics 11-50 （適用OS：Windows Server 2008 R2，Windows Server 2012，Windows Server 2012 R2，Windows Server 2016）　

輸出時の注意

本製品を輸出される場合には、外国為替及び外国貿易法の規制並びに米国輸出管理規則など外国の輸出関連法規をご確認の上、必要な手続きをお取りください。

なお、不明な場合は、弊社担当営業にお問い合わせください。

商標類

HITACHI ，JP1 は，株式会社 日立製作所の商標または登録商標です。

IBM，AIXは，世界の多くの国で登録されたInternational Business Machines Corporationの商標です。

Linuxは，Linus Torvalds氏の日本およびその他の国における登録商標または商標です。

MicrosoftおよびHyper-Vは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

OracleとJavaは，Oracle Corporation 及びその子会社，関連会社の米国及びその他の国における登録商標です。

This product includes software developed by the Apache Software Foundation (http://www.apache.org/).

This product includes software developed by IAIK of Graz University of Technology.

RSAおよびBSAFEは，米国EMC コーポレーションの米国およびその他の国における商標または登録商標です。

SAP，および本文書に記載されたその他の SAP 製品，サービス，ならびにそれぞれのロゴは，ドイツおよびその他の国々における SAP AG の商標または登録商標です。

UNIXは，The Open Groupの米国ならびに他の国における登録商標です。

Windowsは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

Windows Serverは，米国Microsoft Corporationの米国およびその他の国における登録商標または商標です。

その他記載の会社名，製品名などは，それぞれの会社の商標もしくは登録商標です。

JP1/Operations Analyticsは，米国EMC コーポレーションのRSA BSAFE(R)ソフトウェアを搭載しています。

This product includes software developed by Ben Laurie for use in the Apache-SSL HTTP server project.

Portions of this software were developed at the National Center for Supercomputing Applications (NCSA) at the University of Illinois at Urbana-Champaign.

This product includes software developed by the University of California, Berkeley and its contributors.

This software contains code derived from the RSA Data Security Inc. MD5 Message-Digest Algorithm, including various modifications by Spyglass Inc., Carnegie Mellon University, and Bell Communications Research, Inc (Bellcore).

Regular expression support is provided by the PCRE library package, which is open source software, written by Philip Hazel, and copyright by the University of Cambridge, England. The original software is available from ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/

This product includes software developed by Ralf S. Engelschall <rse@engelschall.com> for use in the mod_ssl project (http://www.modssl.org/).

This product includes software developed by Daisuke Okajima and Kohsuke Kawaguchi (http://relaxngcc.sf.net/).

This product includes software developed by the Java Apache Project for use in the Apache JServ servlet engine project (http://java.apache.org/).

This product includes software developed by Andy Clark.

Java is a registered trademark of Oracle and/or its affiliates.

発行

2017年 11月 3021-3-B94-10

著作権

All Rights Reserved. Copyright (C) 2017, Hitachi, Ltd.

変更内容

変更内容（3021-3-B94-10）JP1/Operations Analytics 11-50

追加・変更内容

変更個所

探索範囲（IPAddrRangeリソース）のメンバーにdeviceClassificationLabelを追加した。

1.3.1，1.8.2

コレクター（Collectorsリソース）のメンバーにproductName，providerNameおよびrefreshDateForAppを追加した。

1.3.3

ホスト（Hostsリソース）のメンバーにdeviceClassificationLabelを追加した。

1.3.13

アプリケーション（Applicationsリソース）のメンバーについて，次のとおり追加または削除した。

applicationDetailTypeおよびapplicationHostsを追加した。

resourceIDおよびresourceTypeを削除した。

1.3.18

アプリケーションのリソース情報（ApplicationHostリソース）のメンバーについての説明を追加した。

1.3.19

列挙型一覧にCUSTOMおよびAPPLICATION_CUSTOMを追加した。

1.6

次に示すAPIのIPAddrRange (Type: IPAddrRange)オブジェクトにdeviceClassificationLabel属性を追加した。

探索範囲の一覧の取得

探索範囲の情報取得

探索範囲の作成

探索範囲の更新

2.2.1，2.2.2，2.2.3，2.2.4

次に示すAPIのステータスコード400についての説明を変更した。

コレクターの作成

コレクターの更新

2.3.3，2.3.4

次に示すAPIにステータスコード400を追加した。

コレクターの削除

2.3.5

次に示すAPIのApplication (Type: Application)オブジェクトにapplicationDetailType属性を追加した。

アプリケーションの一覧の取得

2.7.1

次に示すAPIのHost (Type: Host)オブジェクトにdeviceClassificationLabel属性を追加した。

ホストの一覧の取得

2.10.1

単なる誤字・脱字などはお断りなく訂正しました。

はじめに

このマニュアルは，JP1/Operations AnalyticsのAPIについて説明したものです。

対象読者

このマニュアルは，次の方を対象としています。

JP1/Operations Analyticsを導入および運用するシステム管理者。

マニュアルの構成

このマニュアルは，次に示す章と付録から構成されています。

第1章　概要

APIの概要について説明しています。

第2章　API一覧

JP1/OAで提供するAPIを利用するために必要なAPIリファレンスについて説明しています。

付録A　各バージョンの変更内容

各バージョンの変更内容について説明しています。

マイクロソフト製品の表記

このマニュアルでは，マイクロソフト製品の名称を次のように表記しています。

表記

正式名称

Hyper-V

Microsoft(R) Windows Server(R) 2008 R2 Hyper-V(R)

Microsoft(R) Windows Server(R) 2012 Hyper-V(R)

Microsoft(R) Windows Server(R) 2012 R2 Hyper-V(R)

Microsoft(R) Windows Server(R) 2016 Hyper-V(R)

Windows Server 2008 R2

Microsoft(R) Windows Server(R) 2008 R2 Datacenter

Microsoft(R) Windows Server(R) 2008 R2 Enterprise

Microsoft(R) Windows Server(R) 2008 R2 Standard

Windows Server 2012

Microsoft(R) Windows Server(R) 2012 Datacenter

Microsoft(R) Windows Server(R) 2012 Standard

Windows Server 2012 R2

Microsoft(R) Windows Server(R) 2012 R2 Datacenter

Microsoft(R) Windows Server(R) 2012 R2 Standard

Windows Server 2016

Microsoft(R) Windows Server(R) 2016 Datacenter

Microsoft(R) Windows Server(R) 2016 Standard

Windows Server 2016，Windows Server 2012 R2，Windows Server 2012，およびWindows Server 2008 R2を総称してWindows と表記することがあります。

製品名の表記

このマニュアルでは，製品の名称を次のように表記しています。

このマニュアルでの表記

正式名称

ESX

VMware vSphere(R) ESXi(TM)

JP1/AJS3

JP1/Automatic Job Management System 3

JP1/IM

JP1/Integrated Management

JP1/OA

JP1/Operations Analytics

JP1/PFM

JP1/Performance Management

Linux

JP1/OAが監視をサポートしているCentOS，Oracle Linux(R)，Red Hat Enterprise Linux(R)およびSUSE Linux(R)の総称です。

UNIX

UNIX(R)

vCenter ServerまたはvCenter

VMware vCenter Server(R)

VMware

VMware(R)

英略語

このマニュアルで使用する英略語を次に示します。

英略語

正式名称

FC

Fibre Channel

SMI-S

Storage Management Initiative - Specification

SMTP

Simple Mail Transfer Protocol

SNMP

Simple Network Management Protocol

SSH

Secure Shell

SSL

Secure Sockets Layer

VM

Virtual Machine

WBEM

Web-Based Enterprise Management

WMI

Windows Management Instrumentation

KB（キロバイト）などの単位表記

1KB（キロバイト），1MB（メガバイト），1GB（ギガバイト），1TB（テラバイト）はそれぞれ1,024バイト，1,024²バイト，1,024³バイト，1,024⁴バイトです。

1　概要

この章では，JP1/OAが提供しているAPIについて，概要を説明します。

1.1　API の概要

JP1/OAが収集した監視対象の情報などを，APIを利用してhttp(s)経由で取得できます。

JP1/OAのAPIは，REST（Representational State Transfer）アーキテクチャスタイルに従います。

RESTアーキテクチャスタイルに従ったAPIには次のような利点があります。

プラットフォーム，および言語に依存しない。

HTTPの標準インターフェースに従う。（GET/PUT/POST/DELETEメソッドを利用可能）

HTTP向けのセキュリティ対策ツールを利用できる。

標準のHTTPのステータスコードが戻るのでエラー時の対処がしやすい。

リソースごとにURI（Uniform Resource Identifier）を持ち，リソースにアクセスしやすい。またリソース間の関連を理解しやすい。

1.2　APIの共通仕様

JP1/OAが提供しているAPIに共通する仕様を次に示します。

1.2.1　通信方式

APIが使用する通信プロトコルおよびポート番号について，次に示します。

通信プロトコル

APIでは，httpプロトコルおよびhttpsプロトコルをサポートしています。APIは，JP1/OAがWebブラウザーとの通信で使用するプロトコルを使用します。バージョンは，1.1をサポートしています。通信プロトコルの詳細な仕様については，次の規定を参照してください。

httpプロトコルの場合：

RFC2616

httpsプロトコルの場合：

RFC2818

ポート番号

ポート番号のデフォルトの設定は，通信プロトコルにより異なります。

通信プロトコルがhttpの場合：

22015

通信プロトコルがhttpsの場合：

22016

なお，ポート番号を変更したい場合は，マニュアル「JP1/Operations Analytics 構築・運用ガイド」のJP1/OAとWebブラウザー間のポート番号を変更する方法について説明している個所を参照してください。

1.2.2　セキュリティと認証

APIのリクエストを送信してレスポンスを取得するには，ユーザー認証を受ける必要があります。JP1/OAのAPIは，Basic認証（Basic Access Authentication）またはHSSOトークンによる認証を利用します。HSSOトークンは，シングルサインオンに必要なトークンです。HSSOトークンは，発行されて1,000秒でタイムアウトします。

ユーザー認証を受けるためには，使用する認証情報をリクエストヘッダーで指定してください。認証情報を指定する場合のリクエストヘッダーの指定例を次に示します。

Basic認証の例

Authorization: Basic△c3lzdGVtOm1hbmFnZXI=

（凡例）△：半角空白

Basic認証では，Authorizationヘッダーに，認証方式"Basic"に続けて，ユーザー名とパスワードを":" (ASCII:0x3A)で連結した文字列をBase64エンコードしたもの（basic tokenと呼びます）を指定します。

HSSOトークンによる認証の例

Authorization:HSSO△32bd25936120d68dceabcb49493079f8ef82a4_V0300

（凡例）△：半角空白

HSSOトークンによる認証では，Authorizationヘッダーに，認証方式"HSSO"に続けて，HSSOトークンを指定します。

JP1/OAサーバは，権限のないリクエストが発行された場合，レスポンスとして，ステータスコード「401」を返却します。

メモ

Basic認証またはHSSOトークンによる認証でJP1/OAサーバに接続した場合，レスポンスヘッダーとして「WWW-Authenticate: HSSO hsso token」が返却されます。再度，同じセッションでJP1/OAに接続してAPIを発行したい場合は，リクエストヘッダーを次のように指定してください。

Authorization:HSSO△hsso token

（凡例）△：半角空白

JP1/OAサーバは，権限のないリクエストが発行された場合，レスポンスとして，ステータスコード「401」を返却するとともに，ユーザー認証をリクエストします。

1.2.3　入出力形式

APIのリクエストおよびレスポンスのデータ形式として，JSON形式を利用できます。データ形式は，リクエストヘッダーで指定してください。入出力形式の文字コードは，UTF-8を使用します。

指定例

Accept:application/json
Content-Type:application/json

1.2.4　リクエスト形式

APIでJP1/OAが提供する機能を利用するためのリクエスト形式を次に示します。リクエスト形式はURI，メソッド，リクエストライン，リクエストヘッダーから構成されます。

(1)　URI

APIにリソースを指定するには，URIを使用します。次に示すURIの形式の<schema>から<version>までが基底URIとなり，<domain>以下が，相対URIとなります。リソースは<domain>以下の相対URIに指定します。

URIの形式

<scheme>//<host>:<port>/<application>/<version>/<domain>/<object-type>[?<query-string>]

または

<scheme>//<host>:<port>/<application>/<version>/<domain>/<object-type>/actions/[<action-identifier>[/invoke]]

URIの構成内容について，次の表で説明します。

表1‒1　URIの構成要素

項目

説明

参照先

<scheme>

プロトコルを指定します。HTTPの場合は「http」，HTTPSの場合は「https」を指定します。

−

<host>

APIクライアントからアクセスするJP1/OAのホスト名またはIPアドレスを指定します。

−

<port>

APIクライアントからアクセスするJP1/OAのポート番号を指定します。デフォルトではHTTPの場合は22015，HTTPSの場合は22016です。

−

<application>

APIを提供するアプリケーション名です。固定値として「Analytics」を指定します。

−

<version>

使用するAPIのバージョンを指定します。

各APIの「APIのバージョン」を参照してください。

<domain>

APIに指定するリソースのカテゴリを指定します。

「1.4　JP1/OAのAPIで操作できるリソース」

<object-type>

リソースまたはサービスの種類を表します。

<query-string>

クエリパラメータ。<object-type>を絞り込んだり，ソートする条件を指定したりします。リソースごとに指定できるクエリパラメータは異なります。クエリパラメータ同士の順序は問いません。

「1.2.9　HQL規格の使用」

<action-identifier>

リソースに対するアクションを表します。

−

（凡例）

−：該当しません。

URIの構成内容や詳細は，APIごとに異なるため，各APIの説明を参照してください。

(2)　サポートするHTTPメソッド

HTTPが定義する操作メソッドのうち，GETメソッド，POSTメソッド，PUTメソッドおよびDELETEメソッドをサポートしています。

扱うリソースによって，使用できるメソッドは異なります。使用できるメソッドについては，各APIの説明を参照してください。

(3)　リクエストライン

リクエストラインは次の項目から構成されます。

リクエストラインの形式

メソッド△リクエストパス(URI)△クエリ△HTTPバージョン

（凡例）△：半角空白

項目

説明

例

メソッド

リクエストのメソッド

GET

リクエストパス(URI)

リソースを示すパス

/Analytics/v1/objects/Credentials

クエリ

リクエストに含めるクエリパラメータ

?$query=instanceId+eq+50

HTTPバージョン

HTTPのバージョンを示す文字列

HTTP/1.1

なお，リクエストラインの最大長は8,190バイトです。最大長を超えてリクエストラインを指定した場合，ステータスコード414（Request-URI Too Long）が返されます。

(4)　リクエストヘッダー

リクエストヘッダーには，レスポンスのデータ形式およびレスポンスの言語コードなどを指定します。

表1‒2　指定可能なリクエストヘッダー

ヘッダー

説明

指定できる値

指定の要否

Host

ホストの情報として次の項目を指定します。

ホスト名またはIPアドレス：JP1/OAサーバのホスト名またはIPアドレスです。

ポート番号：APIがJP1/OAに接続する際に，利用するポート番号です。

ユーザーの環境を確認して指定する。

任意

Accept

レスポンスデータに指定したいデータ形式を指定します。

application/json

必須

Accept-Language

レスポンスに指定したい言語の言語形式を指定します。

GETメソッド，POSTメソッドまたはPUTメソッドを指定する場合に指定します。

ja:日本語

en:英語

必須

Content-Type

リクエストボディーの形式を指定します。

POSTメソッドまたはPUTメソッドを指定する場合に指定します。

application/json

必須

Authorization

認証情報を指定します。

Basic認証の場合

ユーザー情報

HSSOトークンの場合

hsso token

必須

Content-Length

リクエストボディーのサイズを10進数で指定します。

POSTメソッドまたはPUTメソッドを指定する場合に指定します。

リクエストボディーのサイズ(単位：バイト)

必須

1.2.5　レスポンス形式

リクエストに対するレスポンス形式は，ステータスライン，レスポンスヘッダー，レスポンスボディーで構成されます。

(1)　ステータスライン

ステータスラインを構成する要素を次の表に示します。

項目

説明

参照先

プロトコル

APIが利用する通信プロトコルが表示されます。

−

プロトコルのバージョン

APIが利用する通信プロトコルのバージョンが表示されます。

−

ステータスコード

リクエストの実行結果がステータスコードとして返却されます。

各APIの「ステータスコード」を参照してください。APIを実行する前にエラーとなった場合のステータスコードは「1.2.6　ステータスコード」を参照してください。

メッセージ

ステータスコードの内容が表示されます。

（凡例）−：該当しません。

(2)　レスポンスヘッダー

JP1/OAで制御可能なヘッダーを次の表に示します。

表1‒3　JP1/OAで制御可能なヘッダー

ヘッダー

説明

Cache-Control

GETメソッドを指定したAPIのレスポンス情報をキャッシュ制御します。

Content-Type

レスポンスデータのデータ形式です。

Language

レスポンスデータの言語コードです。

WWW-Authenticate

認証されたHSSOトークンを出力します。

Warning

APIは成功したがサーバの状態に問題がある場合に，その情報を英語で説明する(http標準仕様で英語のみ許可される)

(3)　レスポンスボディー

APIが呼び出された際に返却されるレスポンスデータが含まれます。レスポンスデータのデータ形式は，リクエストヘッダーに指定されたデータ形式に従います。レスポンスデータの形式はAPIごとに異なります。各APIの説明を参照してください。

1.2.6　ステータスコード

API実行によるレスポンスメッセージのステータスコードを次の表に示します。

表1‒4　ステータスコード

ステータスコード

名前

説明

200

OK

リクエストが適切に処理された場合。

201

Created

リソース作成処理が成功した場合，200の代わりにこちらを返却する。

204

No Content

リクエストは成功したが，返すべきレスポンスが存在しない場合，200の代わりにこちらを返却する。

303

See Other

要求を別のURIを用いて処理させる場合，200の代わりにこちらを返却する。

400

Bad Request

リクエストが不正であった場合に返却する。クエリパラメータの指定範囲不正を含む。

401

Unauthorized

リソースにアクセスするために認証が必要であることを通知する。認証方法はWWW-Authenticateヘッダーで通知する。既にAuthorizationヘッダーを含んだリクエストを行っている場合，認証がそれらのユーザー情報またはhsso tokenに対して拒否されたことを示す。認証が拒否される理由として，指定したユーザー情報(ユーザーIDまたはパスワード)やhsso tokenが不正以外にも，JP1/OAに対する操作権限がない場合が考えられます。

403

Forbidden

該当するオペレーションを実施する権限がない場合。

404

Not found

リソース及びオペレーションが存在しない場合。

405

Method Not Allowed

リソースに存在しないメソッドを呼び出した場合。存在するメソッド一覧を必ず返す。

406

Not Acceptable

サポート外のレスポンス形式が指定された場合。

409

Conflict

サーバに既に存在しているデータが競合しているため，リクエストを完了できない。

412

Precondition Failed

要求が前提条件を満たさないため受け付けられない場合。

414

Request-URI Too Long

リクエストラインが長過ぎる場合。

415

Unsupported Media Type

サポート外のリクエスト形式が指定された場合。

500

Server-Side Error

サーバでの処理エラーに対して返却する。

503

Service Unavailable

リポジトリーサーバでエラーが発生した場合。

4XX,5XX 系のステータスコードの場合，レスポンスボディーが「text/html」形式または「text/plain」形式で返却されることがあります。この場合レスポンスヘッダーに「Content-Type: text/html」または「Content-Type: text/plain」が指定されます。

4XX,500 系のステータスコードだけでは原因を特定しにくいものに関して，レスポンスにエラーのより詳細な内容を提供しています。

上記のステータスコードの使用有無はAPIごとに異なるため，各APIの説明を参照してください。

1.2.7　エラー情報

APIのリクエストがエラーになった場合，レスポンス情報として，次の表に示すスキーマが返却されます。なお，次の表に示すスキーマ以外のエラー情報については，マニュアル「JP1/Operations Analytics メッセージ」を参照してください。

表1‒5　エラー情報のスキーマ

メンバー名

データ型

説明

errorSource

string

エラーが発生したAPIです。

message

string

エラーのメッセージ内容です。

messageID

string

メッセージIDです。リクエストの際にjsonの記載を誤るなどの理由でエラーが発生した場合は，メッセージIDが"generic error"になります。

application

string

エラーが発生したAPIを提供するアプリケーション情報(Analytics)

1.2.8　クエリパラメータ

クエリパラメータでは，リクエストに検索条件を指定することで，レスポンスの出力内容をフィルタリングしたり，ソートしたりすることができます。

(1)　すべてのAPIで指定できるクエリパラメータ

次の表に示すパラメータは，すべてのAPIで指定できます。

表1‒6　すべてのAPIで指定できるクエリパラメータ

パラメータ

説明

指定できる値

デフォルト値

Alt

リクエストのContent-TypeヘッダーやAcceptヘッダーと同様に，入出力のデータ形式を指定できます。

json

−

（凡例）−：該当しません。

(2)　一部のAPIで指定できるクエリパラメータ

次の表に示すパラメータは，リソース(例：監視プロファイル，仮想マシンなど)の一覧を取得する際に指定できます。APIごとに使用可能なパラメータが異なる場合があります。詳細は各APIの説明を参照してください。

表1‒7　一部のAPIで指定できるクエリパラメータ

パラメータ

説明

指定できる値※

デフォルト値

$query

指定した条件でフィルタリングを行います。

「1.2.9　HQL規格の使用」を参照してください。

−

$order-by

指定されたメンバー名でソートします。

メンバー名 [{ASC| DESC}](, メンバー名 [{ASC| DESC}])

ASC:昇順

DESC:降順

ASC

$offset

情報を取得する先頭オブジェクトの位置を指定します。レスポンスに含めるオブジェクトの最大数は$countで指定します。$offsetよりもpageが優先されます。

0～2147483647

0

$count

$offsetに指定した先頭オブジェクトの位置を起点に，レスポンスに含めるオブジェクトの最大数を指定します。$countよりもpageSizeが優先されます。なお，$countと$offsetの合計が2,147,483,647を超える場合，$offsetに指定した値から2,147,483,647番目までのオブジェクトを取得します

1～2147483647

100

page

リソースを，ページ単位で分割する場合に，指定したページの情報を取得します。pageSizeを同時に指定する必要があります。$offsetよりもpageが優先されます。

1～2147483647

−

pageSize

1ページに表示するオブジェクトの最大数を指定します。$countよりもpageSizeが優先されます。

1～2147483647

−

（凡例）−：該当しません。

注※

URLとして表現できない文字列を値に指定したい場合は，UTF-8形式でURLエンコードしてください。

pageSizeには1ページに表示するオブジェクトの最大数を指定し，pageには分割されたページのうちの何ページ目を表示するかを指定します。pageおよびpageSizeを指定すると，Paginationオブジェクトに全リソース数とページ数が返却されます。この値によって次のページがあるかどうかを判断できます。

なお，pageおよびpageSizeは次の式のとおり，$offsetの値に変換されて利用されます。

$offset=pageSize*(page-1)

そのため，pageおよびpageSizeが$offsetの範囲を超えた場合，ステータスコードは400のBad Requestが返却されます。

1.2.9　HQL規格の使用

HQLは，$queryやサポートする演算子などのクエリパラメータを使用して，コレクション（データ）のフィルタリングができるクエリ言語です。

URLとして表現できない記号や文字は，UTF-8形式でURLエンコードしてください。

形式

リソースリクエストのコレクションを定義するには，次に示す式を使用してください。

expression ::= "(" expression ")" | binary-expression | expression junction expression
junction ::= ( "and" | "or" )

binary-expression ::= (compare-expression | tuple-expression)

compare-expression ::= name-expression compare-operation value-expression

name-expression ::= property-name | "[" property-name "]"
compare-operation ::= ( "eq" | "=" | "ne" | "<>" | "!=" | "gt" | ">" | "lt" | "<" | "ge" |">=" | "le" |"<=" | "starts" | "ends" )
value-expression ::= ( string-expression | number-expression | boolean-expression )

string-expression ::= "'" ([^'] | [']{2})* "'"
number-expression::= ( "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" )+
boolean-expression::= "true" | "false" |"TRUE" | "FALSE"

tuple-expression ::= name-expression tuple-operation tuple-value-expression

tuple-value-expression ::= "[" value-expression ("," value-expression)* "]"

tuple-operation ::= ( "in" | "not in" )

「property-name」は，リソースに定義されているメンバー名です。

「value-expression」は，その式が文字列表現，数値表現，真理値表現のどれであるかを表示します。また，これはリソースに定義されているメンバーの実際のデータ型とは異なります。例えば「ISO8601String」型の場合，ISO8601の文字列式として扱われるため，「string-expression」として表示されます。

データ型と表現形式との関係を次の表に示します。

表1‒8　データ型と表現形式との関係

型名

Expression

int/long/float

number-expression

enum

string-expression

String

string-expression

ISO8601String

string-expression

URLString

string-expression

boolean

boolean-expression

HQLでサポートする演算子を，優先される順に次の表に示します。

表1‒9　HQLでサポートする演算子

演算子

説明

指定可能な文法

優先度

eq

等しい。

number-expression,

string-expression(string,enum),

boolean-expression

1

ne

等しくない。

number-expression,

string-expression(string,enum),

boolean-expression

1

gt

より大きい。

number-expression,

string-expression(string,enum),

1

lt

より小さい。

number-expression,

string-expression(string,enum),

1

ge

以上。

number-expression,

string-expression(string,enum),

1

le

以下。

number-expression,

string-expression(string,enum),

1

starts※

開始値。

string-expression（ISO8601Stringを除くstring）

1

ends※

終了値。

string-expression（ISO8601Stringを除くstring）

1

likes※

含まれる。

string-expression（ISO8601Stringを除くstring）

1

in

含まれる。

number-expression,

string-expression(string,enum),

boolean-expression

1

not in

含まれない。

number-expression,

string-expression(string,enum),

boolean-expression

1

and

どちらもtrueである。

compare-expression, tuple-expression

2

or

どちらかがtrueである。

compare-expression, tuple-expression

3

注※　大文字と小文字は区別されません。

使用例

URLエンコード前

...?$query=instanceID in [1000,1001,1002] and status eq 'Warning'

URLエンコード後

...?$query=instanceID%20in%20%5b1000%2c1001%2c1002%5d%20and%20status%20eq%20%27Warning%27

1.2.10　ドメインオブジェクトの形式

ドメインとは，JP1/OAがサポートするリソースが格納されている場所を指します。ドメインオブジェクトとは，リソースのメンバーを指します。ここでは，ドメインオブジェクトのデータ形式について説明します。

サポートするデータ型

サポートされる基本データ型を次に示します。

表1‒10　基本データ型

型名

説明

boolean

true or false

float

浮動小数

int

32bit符号付き整数

long

64bit符号付き整数

string

テキストデータ

注　ISO8601String，URLString，およびenumはstring型の拡張表現です。

日付と時間

ドメインオブジェクトでの日付と時間の指定方法を説明します。

日付と時間は，ISO8601フォーマットを使用して指定してください。フォーマットでは，「年（yyyy）」以外のすべての情報を省略できます。日付または時間が省略された場合，指定可能な最小値が自動的に追加されます。タイムゾーンが省略された場合，デフォルトでは，JP1/OAサーバに設定されたタイムゾーンが設定されます。

ただし，$queryを使用して日付と時間を指定する場合，日付と時間は省略できません。また，JSON形式で時間情報を取得する場合，タイムゾーン情報の「:」が表記されていない時間（例：2014-12-09T18:50:30.500+0900）が出力されます。JSON形式で取得した時間情報を，そのままAPIの入力に指定する場合には，タイムゾーンに「:」を追加してください（例：2014-12-09T18:50:30.500+09:00）。「:」を追加しない場合，エラーになります。

また，リソースのメンバーのデータ型が「ISO8601String」である場合，年月日，時刻，タイムゾーンは，次の表の形式でレスポンスボディーに表示されます。

表1‒11　年月日，時刻，タイムゾーンの形式

フォーマット

指定例

JP1/OAで処理する時刻

yyyy-mm-ddThh:mm:ss.mmmTZD

2015-12-09T18:50:30.500+09:00

2015-12-09T18:50:30.500+09:00

yyyy-mm-ddThh:mm:ss.mmm

2015-12-09T18:50:30.500.000

2015-12-09T18:50:30.500.000[ホストサーバのタイムゾーン]

yyyy-mm-ddThh:mm:ssTZD

2015-12-09T18:50:30+09:00

2015-12-09T18:50:30.000+09:00

yyyy-mm-ddThh:mmTZD

2015-12-09T18:50+09:00

2015-12-09T18:50:00.000+09:00

yyyy-mm-ddThhTZD

2015-12-09T18+09:00

2015-12-09T18:00:00.000+09:00

yyyy-mm-dd

2015-12-09

2015-12-09T00:00:00.000[ホストサーバのタイムゾーン]

yyyy-mm

2015-12

2015-12-01T00:00:00.000[ホストサーバのタイムゾーン]

yyyy

2015

2015-01-01T00:00:00.000[ホストサーバのタイムゾーン]

1.3　リソースのメンバー

JP1/OAが提供する機能をリソースとして分類します。レスポンスボディーで，リソースの情報をメンバーとして取得できます。返却されるリソースのメンバー名，データ型，説明および$queryと$order-byに適応するかどうかを，機能ごとの表に示します。

ポイント

レスポンス取得時にメンバーの値が存在しない場合は，レスポンスボディー上，省略されることがあります。

JP1/OAでは，サポート対象外のメンバーが返却される場合があります。サポート対象については機能ごとの表を参照してください。

リソースの一覧を取得する場合は，各機能のメンバーがリストとして取得されます。リストの形式は「1.3.20　リソース一覧取得時のリストのメンバー」を参照してください。

年月日の指定方法について特に断り書きがない場合は，「1.2.10　ドメインオブジェクトの形式」を参照して指定してください。

1.3.1　探索範囲のメンバー

探索範囲（IPAddrRangeリソース）のメンバーについて説明します。

メンバー名
データ型
説明
変更可否
フィルター条件（$query）への適用
ソート条件（$order-by）への適用

instanceID
long

インスタンスを特定するID

×
×
×

name
string

探索範囲の名称

○
×
×

ipAddrRange
string[]

探索範囲。リストの0番目に探索開始IPアドレス，リストの1番目に探索終了IPアドレスを指定します。

○
×
×

usePing
boolean

探索実行時に，対象機器に対してpingを使用するかどうか。

true：pingを使用する。

false：pingを使用しない。

○
×
×

useAllCredential
boolean

すべてのCredentialを使用するかどうか。

true：すべてのCredentialを使用する。

false：すべてのCredentialを使用しない。

○
×
×

selectedCredentails
Credential[]

探索に使用する認証情報のリスト

○
×
×

deviceClassificationLabel
string
機器に割り当てられた分類ラベル
○
×
×

（凡例）○：適応します。　×：適応しません。

1.3.2　認証情報のメンバー

認証情報（Credentialsリソース）のメンバーについて説明します。

メンバー名
データ型
説明
変更可否
フィルター条件（$query）への適用
ソート条件（$order-by）への適用

instanceID
long
インスタンスを特定するID
×
○
○

name
string
認証情報の名称。
○
○
○

credentialType
enum
監視対象への接続に使用するプロトコル。指定できる値は，「1.6　列挙型一覧」のProtocolTypeの表を参照してください。
×
○（eq，ne，in，not inのみ）
×

userId
string
認証時に指定するユーザーID。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合，”username”メンバーの値が設定されます。
○
○
×

password
string
認証時に使用するパスワード。255byte以下の文字列をBase64にエンコードして指定します。
○
×
×

passwordNotRequired
boolean
認証時にパスワードを必要とするかどうか。

true：パスワードは必要ない。

false：パスワードが必要である。

省略時はfalseが指定されます。監視対象への接続に「WMI」を使用する場合のみ有効です。
○
×
×

portNumber
integer
ポート番号。監視対象への接続に使用するプロトコルが「ssh」，「SMI-S WBEM」，「SNMP」の場合のみ設定されます。
○
×
×

rootPassword
string
認証時に使用するrootパスワード。255byte以下の文字列をBase64にエンコードして指定します。監視対象への接続に「ssh」を使用する場合のみ有効です。
○
×
×

updatePassword
boolean
パスワード(password)を変更するかどうか。

true：パスワードの変更を行う。

false：パスワードの変更を行わない。

省略時はfalseが指定されます。
○
×
×

updateRootPassword
boolean
rootパスワード(rootPassword)を変更するかどうか。

true：パスワードの変更を行う。

false：パスワードの変更を行わない。

省略時はfalseが指定されます。監視対象への接続に「ssh」を使用する場合のみ有効です。
○
×
×

ssl
boolean
監視対象への接続時にSSL(https)を使用するかどうか。

true：SSLを使用する。

false：SSLを使用する。

省略時はfalseが指定されます。監視対象への接続に「SMI-S WBEM」を使用する場合のみ有効です。
○
×
×

domainname
string
ドメイン名。監視対象への接続に「WMI」を使用する場合のみ設定されます。
○
×
×

namespace
string
ネームスペース。監視対象への接続に「SMI-S WBEM」を使用する場合のみ設定されます。
○
×
×

community
string
コミュニティ名。監視対象への接続に「SNMP」を使用する場合のみ設定されます。
○
×
×

snmpVersion
enum
SNMPのバージョン。指定できる値は，「1.6　列挙型一覧」のSnmpVersionの表を参照してください。監視対象への接続に「SNMP」を使用する場合のみ設定されます。
○
×
×

username
string
認証時に使用するユーザー名。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。
○
×
×

authenticationEnabled
boolean
SMTP認証を行うかどうか。

true：認証を有効にする。

false：認証を無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。
○
×
×

authenticationPassphrase
string
認証パスフレーズ。255byte以下の文字列をBase64にエンコードして指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。
○
×
×

updateAuthenticationPassphrase
boolean
認証パスフレーズを変更するかどうか。

true：認証パスフレーズの変更を行う。

false：認証パスフレーズの変更を行わない。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。
○
×
×

authenticationProtocol
enum
認証用のプロトコル。指定できる値は，「1.6　列挙型一覧」のAuthenticationProtocolの表を参照してください。 監視対象への接続に「SNMP v3」を使用する場合のみ指定します。
○
×
×

privacyEnabled
boolean
プライバシーを有効にするかどうか。

true：プライバシーを有効にする。

false：プライバシーを無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。
○
×
×

privacyPassphrase
string
プライバシーのためのパスフレーズ。255byte以下の文字列をBase64にエンコードして指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。
○
×
×

updatePrivacyPassphrase
boolean
プライバシーのためのパスフレーズを変更するかどうか。

true：パスフレーズを変更する。

false：パスフレーズを変更しない。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。
○
×
×

privacyProtocol
string
プライバシー用のプロトコル。

DES：DESを使用する。

AES128：AES128を使用する。

監視対象への接続に「SNMP v3」を使用する場合のみ指定します。
○
×
×

numOfRelatedResources
integer
認証情報を用いて発見されたリソースの数
×
×
×

（凡例）○：適応します。　×：適応しません。

1.3.3　コレクターのメンバー

コレクター（Collectorsリソース）のメンバーについて説明します。

メンバー名
データ型
説明
変更可否
フィルター条件（$query）への適用
ソート条件（$order-by）への適用

instanceID
long
インスタンスを特定するID
×
○
○

name
string
コレクターの名称
○
○
○

collectorType
string
コレクターの種別

VCENTER：管理ソフトウェアがvCenterである。

AJS：管理ソフトウェアがJP1/AJS3 - Managerである。

IM：管理ソフトウェアがJP1/IM - Managerである。

PFM：管理ソフトウェアがJP1/PFM - Managerである。

CUSTOM：管理ソフトウェアが任意のアプリケーションである。

×
○（eq，ne，in，not inのみ）
×

osType
enum
コレクターのOS種別。コレクターの種別（collectorType）が「AJS」，「PFM」，「IM」の場合のみ指定します。指定できる値は，「1.6　列挙型一覧」のCollectorOsTypeの表を参照してください。
×
×
×

autoCollectionType
enum
コレクターの定期実行の設定。指定できる値は，「1.6　列挙型一覧」のConnectTypeの表を参照してください。
×
○（eq，ne，in，not inのみ）
×

connectResult
enum
コレクター の最新の実行結果。指定できる値は，「1.6　列挙型一覧」のConnectStatusTypeの表を参照してください。
×
○（eq，ne，in，not inのみ）
×

refreshStatus
enum
コレクター の実行状態。指定できる値は，「1.6　列挙型一覧」のConnectStatusTypeの表を参照してください。
×
×
×

message
string
コレクターの実行結果のメッセージ
×
×
×

lastRefreshed
ISO8601String
最終リフレッシュ日時
×
×
×

refreshDateForInventory
ISO8601String
構成情報のリフレッシュ日時
×
×
×

refreshDateForPerformance
ISO8601String
性能情報のリフレッシュ日時
×
×
×

numOfHypervisors
integer
コレクターにより発見されたハイパーバイザーの数
×
×
×

numOfVms
integer
コレクターにより発見された仮想マシンの数
×
×
×

numOfApplications
integer
コレクターにより発見されたアプリケーションの数
×
×
×

collectorCredentials
CollectorCredential[]
監視対象の接続に使用する認証情報。詳細は「1.3.4　コレクターで使用する認証情報のメンバー」を参照してください。
―
―
―

productName
string
収集対象製品名
×
○
○

providerName
string
コレクター作成者
×
○
○

refreshDateForApp
ISO8601String
定義反映日時
×
×
×

（凡例）○：適応します。　×：適応しません。 －：対象外です。

1.3.4　コレクターで使用する認証情報のメンバー

コレクターで使用する認証情報（CollectorCredentialリソース）のメンバーについて説明します。

メンバー名
データ型
説明
変更可否
フィルター条件（$query）への適用
ソート条件（$order-by）への適用

instanceID
long
インスタンスを特定するID。
×
×
×

ipAddress
string
管理ソフトウェアへの接続に使用するIPアドレスまたはホスト名。
×
×
×

userId
string
管理ソフトウェアへの接続に使用するユーザーID。255byte以下の文字列を指定します。
○
×
×

password
string
管理ソフトウェアへの接続に使用するパスワード。255byte以下の文字列をBase64でエンコードして指定します。
○
×
×

updatePassword
boolean
管理ソフトウェアへの接続に使用するパスワードを変更するかどうか。

true：パスワードの変更を行う。

false：パスワードの変更を行わない。

省略時はfalseが指定されます。
○
×
×

portNumber
string
管理ソフトウェアへの接続に使用するポート番号。
○
×
×

hypertextTransferProtocolType
enum
管理ソフトウェアへの接続時にSSL(https)を使用するかどうか。指定できる値は，「1.6　列挙型一覧」のHypertextTransferProtocolTypeの表を参照してください。
×
×
×

domainName
string
ドメイン名。アプリケーション連携でWindows選択時に使用。
○
×
×

rootPassword
string
rootパスワード。アプリケーション連携でUnix選択時に使用。
○
×
×

updateRootPassword
boolean
パスワードを変更する場合にtrueを設定する。更新時のみ使用。
○
×
×

useAdministrativeShares
boolean
管理共有を行う場合にtrueを設定する。
○
×
×

shareName
string
共有名
○
×
×

sharedFolder
string
共有フォルダのパス
○
×
×

logicalHostName
string
論理ホスト名
○
×
×

useLogicalHostName
boolean
論理ホスト名を使用する場合にtrueに設定する。
○
×
×

（凡例）○：適応します。　×：適応しません。

1.3.5　ユーザープロファイルのメンバー

ユーザープロファイル（UserThresholdProfilesリソース）のメンバーについて説明します。

メンバー名
データ型
説明
変更可否
フィルター条件（$query）への適用
ソート条件（$order-by）への適用

instanceID
long
インスタンスを特定するID。
×
○
○

profileName
string
ユーザープロファイルの名称。128文字以下の文字列を指定します。
○
○
○

description
string
ユーザープロファイルの説明。256文字以下の文字列を指定します。
○
○
○

resourceType
string
ユーザープロファイルが適用できるリソース種別。

VM：仮想マシン

VOLUME：ボリューム

WINDOWS：Windows

LINUX_UNIX：LinuxまたはUNIX

○（新規作成時のみ）
○（eqのみ）
×

profileType
string
ユーザープロファイルの変更種別

User：ユーザーが作成したプロファイル

Default：デフォルトで登録されているプロファイル

Preset：初期値が設定されたプロファイル

×（新規作成時はUserを指定する）
○（eq，ne，in，not inのみ）
×

thresholdValues
UserThresholdValue[]
ユーザープロファイルに設定されているしきい値の内容。詳細は「1.3.6　ユーザープロファイルのしきい値のメンバー」を参照してください。
―
―
―

numOfResources
integer
ユーザープロファイルが割り当たっているリソースの数。
×
×
×

autoAssignFilters
string[]
自動割り当てルールのルール名。
×
×
×

（凡例）○：適応します。　×：適応しません。 －：対象外です。

1.3.6　ユーザープロファイルのしきい値のメンバー

ユーザープロファイルのしきい値（UserThresholdValueリソース）のメンバーについて説明します。

メンバー名
データ型
説明
変更可否
フィルター条件（$query）への適用
ソート条件（$order-by）への適用

instanceID
long
インスタンスを特定するID。
×
×
×

monitoring
boolean
監視しているしきい値かどうか。

true：監視している。

false：監視していない。

省略時はfalseが設定されます。
○
×
×

metricType
string
しきい値の識別子。未サポートのメンバーです。
×
×
×

displayName
string
しきい値の表示名。
×
×
×

unit
string
しきい値の単位を表す文字列。
×
×
×

proportion
boolean
しきい値の方向。

true：測定値がしきい値を下回る場合に異常または警告となる。

false：測定値がしきい値を上回る場合に異常または警告になる。

×
×
×

thresholdValueOfWarning
float
警告を表すしきい値。しきい値は次の条件に合わせて指定する必要があります。

stepSizeの倍数

max以下

min以上

○
×
×

thresholdValueOfError
float
エラーを表すしきい値。しきい値は次の条件に合わせて指定する必要があります。

stepSizeの倍数

max以下

min以上

○
×
×

stepSize
float
しきい値の増加量。
×
×
×

max
float
しきい値がとりえる最大値。
×
×
×

min
float
しきい値がとりえる最小値。
×
×
×

（凡例）○：適応します。　×：適応しません。

1.3.7　システムプロファイルのメンバー

システムプロファイル（SystemThresholdProfilesリソース）のメンバーについて説明します。

メンバー名
データ型
説明
変更可否
フィルター条件（$query）への適用
ソート条件（$order-by）への適用

instanceID
long
インスタンスを特定するID。
×
○
○

profileName
string
システムプロファイルの名称。128文字以下の文字列を指定します。
○
○
○

description
string
システムプロファイルの説明。256文字以下の文字列を指定します。
○
○
○

resourceType
string
システムプロファイルが適用できるリソース種別。

ESX：ESXサーバ

HYPERV：Hyper-Vサーバ

IPSWITCH：IPスイッチ

FCSWITCH：FCスイッチ

○（新規作成時のみ）
○（eqのみ）
×

profileType
string
システムプロファイルの変更種別。

User：ユーザーが作成したプロファイル

Default：デフォルトで登録されているプロファイル

Preset：初期値が設定されたプロファイル

×（新規作成時はUserを指定する）
○（eq，ne，in，not inのみ）
×

thresholdValues
SystemThresholdValue[]
システムプロファイルに設定されているしきい値の内容。詳細は「1.3.8　システムプロファイルのしきい値のメンバー」を参照してください。
―
―
―

numOfResources
integer
システムプロファイルが割り当たっているリソースの数。
×
×
×

（凡例）○：適応します。　×：適応しません。 －：対象外です。

1.3.8　システムプロファイルのしきい値のメンバー

システムプロファイルのしきい値（SystemThresholdValueリソース）のメンバーについて説明します。

メンバー名
データ型
説明
変更可否
フィルター条件（$query）への適用
ソート条件（$order-by）への適用

instanceID
long
インスタンスを特定するID。
×
×
×

monitoring
boolean
監視しているしきい値かどうか。

true：監視している。

false：監視していない。

省略時はfalseが設定されます。
○
×
×

metricType
string
しきい値の識別子。未サポートのメンバーです。
×
×
×

displayName
string
しきい値の表示名。
×
×
×

unit
string
しきい値の単位を表す文字列。
×
×
×

proportion
boolean
しきい値の方向。

true：測定値がしきい値を下回る場合に異常または警告となる。

false：測定値がしきい値を上回る場合に異常または警告になる。

×
×
×

thresholdValueOfWarning
float
警告を表すしきい値。しきい値は次の条件に合わせて指定する必要があります。

stepSizeの倍数

max以下

min以上

○
×
×

thresholdValueOfError
float
エラーを表すしきい値。しきい値は次の条件に合わせて指定する必要があります。

stepSizeの倍数

max以下

min以上

○
×
×

stepSize
float
しきい値の増加量。
×
×
×

max
float
しきい値がとりえる最大値。
×
×
×

min
float
しきい値がとりえる最小値。
×
×
×

（凡例）○：適応します。　×：適応しません。

1.3.9　コンシューマーのメンバー

コンシューマー（Groupsリソース）のメンバーについて説明します。

メンバー名 | データ型 | 説明 | 変更可否 | フィルター条件（$query）への適用 | ソート条件（$order-by）への適用
instanceID | long | インスタンスを特定するID。 | × | ○ | ○
name | string | コンシューマーの名称。128文字以下の文字列を指定します。 | ○ | ○ | ○
status | enum | コンシューマーの状態。指定できる値は，「1.6　列挙型一覧」のNodeStatusTypeの表を参照してください。 | × | × | ×
gradeKey | string | グレードを識別するID。 | ○ | ○ | ○
gradeName | string | グレードの名称。 | × | × | ×
gradeDisplayOrder | integer | グレードの優先順位 | × | × | ×
description | string | コンシューマーの説明。1000文字以下の文字列を指定します。 | ○ | ○ | ○
templateCreatorType | enum | コンシューマーの変更種別。指定できる値は，「1.6　列挙型一覧」のTemplateCreatorTypeの表を参照してください。 | ○（新規作成時のみ） | ○（eq，ne，in，not inのみ） | ×
numOfVolumes | integer | コンシューマーが割り当てられているボリュームの数。 | × | × | ×
numOfVMs | integer | コンシューマーが割り当てられている仮想マシンの数。 | × | × | ×
numOfHosts | integer | コンシューマーが割り当てられているホストの数。 | × | × | ×
numOfHypervisors | integer | コンシューマーが割り当てられているハイパーバイザーの数。 | × | × | ×
numOfApplications | integer | コンシューマーが割り当てられているアプリケーションの数。 | × | × | ×
vmAutoAssignFilters | string[] | 仮想サーバに設定されている自動割り当てルールのルール名。 | × | × | ×
hostAutoAssignFilters | string[] | ホストに設定されている自動割り当てルールのルール名。 | × | × | ×

（凡例）○：適応します。　×：適応しません。

1.3.10　グレードのメンバー

グレード（Gradesリソース）のメンバーについて説明します。

メンバー名 | データ型 | 説明 | 変更可否 | フィルター条件（$query）への適用 | ソート条件（$order-by）への適用
gradeKey | string | グレードを識別するID。 | × | ○ | ○
name | string | グレードの名称。 | × | ○ | ○
displayOrder | string | グレードの優先順位。 | × | ○ | ○

（凡例）○：適応します。　×：適応しません。

1.3.11　仮想マシンのメンバー

仮想マシン（VirtualMachinesリソース）のメンバーについて説明します。

メンバー名 | データ型 | 説明 | 変更可否 | フィルター条件（$query）への適用 | ソート条件（$order-by）への適用
instanceID | long | インスタンスを特定するID。 | × | ○ | ○
name | string | 仮想マシン名。 | × | ○ | ○
ipAddress | string | 仮想マシンのIPアドレス。 | × | × | ×
status | enum | 仮想マシンの状態。指定できる値は，「1.6　列挙型一覧」のNodeStatusTypeの表を参照してください。 | × | ○（eq，ne，in，not inのみ） | ×
monitorStatus | enum | 仮想マシンの監視状態。指定できる値は，「1.6　列挙型一覧」のComponentMonitorTypeの表を参照してください。 | × | ○（eq，ne，in，not inのみ） | ×
description | string | 仮想マシンの詳細情報。 | × | ○ | ○
collectorID | Long | 発見に使用されたコレクターを特定するID。 | × | × | ×
collectorName | string | 発見に使用されたコレクターの名称。 | × | × | ×
autoCollectionType | enum | コレクターの定期実行の設定。指定できる値は，「1.6　列挙型一覧」のConnectTypeの表を参照してください。 | × | × | ×
clusterName | string | 仮想マシンが登録されているクラスタ環境。 | × | ○ | ○
hypervisorType | enum | 仮想マシンが属するハイパーバイザーの種別。指定できる値は，「1.6　列挙型一覧」のArgusNodeTypeの表を参照してください。 | × | ○（eq，ne，in，not inのみ） | ×
hypervisorID | long | 仮想マシンが属するハイパーバイザーを特定するID。 | × | ○ | ○
hypervisorName | string | 仮想マシンが属するハイパーバイザーの名称。 | × | ○ | ○
hypervisorMonitorStatus | enum | ハイパーバイザーの監視状態。指定できる値は，「1.6　列挙型一覧」のManagementLevelTypeの表を参照してください。 | × | ○（eq，ne，in，not inのみ） | ×
hostName | string | 仮想マシン上で動作するホストのホスト名。 | × | ○ | ○
thresholdProfileID | long | 割り当てられているプロファイルを特定するID。 | × | × | ×
thresholdProfileName | string | 割り当てられているプロファイルの名称。 | × | × | ×
groupIDs | long[] | 割り当てられているコンシューマーを特定するID。 | × | × | ×
groupNames | String[] | 割り当てられているコンシューマーの名称。 | × | × | ×
usedCredentialID | long | 発見時に使用された認証情報を特定するID。 | × | × | ×
usedCredentials | string | 発見時に使用された認証情報の名称。 | × | × | ×
accessPointType | enum | 発見時に使用された認証情報のプロトコルまたはコレクターの種別。指定できる値は，「1.6　列挙型一覧」のProtocolTypeの表を参照してください。 | × | × | ×
accessPointIpAddress | string | 監視対象または管理ソフトウェアへの接続に使用したIPアドレスまたはホスト名。 | × | × | ×
accessPointUser | string | 監視対象または管理ソフトウェアへの接続に使用したユーザーID。 | × | × | ×

（凡例）○：適応します。　×：適応しません。

1.3.12　ハイパーバイザーのメンバー

ハイパーバイザー（Hypervisorsリソース）のメンバーについて説明します。

メンバー名
データ型
説明
変更可否
フィルター条件（$query）への適用
ソート条件（$order-by）への適用

instanceID
long
インスタンスを特定するID。
×
○
○

name
string
ハイパーバイザーの名称。
×
○
○

ipAddress
string
ハイパーバイザーのIPアドレス。
×
×
×

status
enum
ハイパーバイザーの状態。指定できる値は，「1.6　列挙型一覧」のNodeStatusTypeの表を参照してください。
×
○（eq，ne，in，not inのみ）
×

monitorStatus
enum
ハイパーバイザーの監視状態。指定できる値は，「1.6　列挙型一覧」のManagementLevelTypeの表を参照してください。
×
○（eq，ne，in，not inのみ）
×

description
string
ハイパーバイザーの詳細情報。
×
○
○

collectorID
long
発見に使用されたコレクターを特定するID。
×
×
×

collectorName
string
発見に使用されたコレクターの名称。
×
×
×

autoCollectionType
enum
コレクターの定期実行の設定。指定できる値は，「1.6　列挙型一覧」のConnectTypeの表を参照してください。
×
×
×

clusterName
string
ハイパーバイザーが登録されているクラスタの名称。
×
○
○

usedCredentialID
long
発見時に使用された認証情報を特定するID。
×
×
×

usedCredentials
string
発見時に使用された認証情報の名称。
×
×
×

hypervisorType
string
ハイパーバイザーの種別。

SERVER_ESX：ESXサーバ

SERVER_HYPERV：Hyper-Vサーバ

×
○（eq，ne，in，not inのみ）
×

thresholdProfileID
long
割り当てられているプロファイルを特定するID。
×
×
×

thresholdProfileName
string
割り当てられているプロファイルの名称。
×
×
×

accessPointType
enum
発見時に使用された認証情報のプロトコルまたはコレクターの種別。指定できる値は，「1.6　列挙型一覧」のProtocolTypeの表を参照してください。
×
×
×

accessPointIpAddress
string
監視対象または管理ソフトウェアへの接続に使用したIPアドレスまたはホスト名。
×
×
×

accessPointUser
string
監視対象または管理ソフトウェアへの接続に使用したユーザーID。
×
×
×

groupIDs
long[]
ハイパーバイザーが割り当たっているコンシューマーを特定するID。
×
×
×

groupNames
string[]
ハイパーバイザーが割り当たっているコンシューマーの名称。
×
×
×

gradeNames
string[]
ハイパーバイザーが割り当たっているコンシューマーのグレード。
×
×
×

gradeOrders
integer[]
ハイパーバイザーが割り当たっているコンシューマーのグレードの優先度。
×
×
×

凡例）○：適応します。　×：適応しません。

1.3.13　ホストのメンバー

ホスト（Hostsリソース）のメンバーについて説明します。

メンバー名
データ型
説明
変更可否
フィルター条件（$query）への適用
ソート条件（$order-by）への適用

instanceID
long
インスタンスを特定するID
×
○
○

name
string
ホストの名称
×
○
○

ipAddress
string
ホストのIPアドレス
×
×
×

osType
string
ホストのOS種別

SERVER_WINDOWS：OSがWindowsである。

SERVER_LINUX：OSがLinuxである。

SERVER_SOL：OSがSolarisである。

SERVER_HPUX：OSがHP-UXである。

SERVER_AIX：OSがAIXである。

×
○（eq，ne，in，not inのみ）
×

status
enum
ホストの状態。指定できる値は，「1.6　列挙型一覧」のNodeStatusTypeの表を参照してください。
×
○（eq，ne，in，not inのみ）
×

monitorStatus
enum
ホストの監視状態。指定できる値は，「1.6　列挙型一覧」のManagementLevelTypeの表を参照してください。
×
○（eq，ne，in，not inのみ）
×

description
string
ホストの詳細情報
×
○
○

vmName
string
ホストが仮想マシン上で動作している場合の仮想マシン名
×
○
○

usedCredentialID
long
発見時に使用された認証情報を特定するID
×
×
×

usedCredentials
string
発見時に使用された認証情報の名称
×
×
×

thresholdProfileID
long
割り当てられているプロファイルを特定するID
×
×
×

thresholdProfileName
string
割り当てられているプロファイルの名称
×
×
×

groupIDs
long[]
割り当てられているコンシューマーを特定するID
×
×
×

groupNames
string[]
割り当てられているコンシューマーの名称
×
×
×

deviceClassificationLabel
string
ホストに割り当てられた分類ラベル
×
×
×

accessPointType
enum
発見時に使用された認証情報の種別。指定できる値は，「1.6　列挙型一覧」のProtocolTypeの表を参照してください。
×
×
×

accessPointIpAddress
string
監視対象への接続に使用したIPアドレス
×
×
×

accessPointUser
string
監視対象への接続に使用したユーザーID
×
×
×

（凡例）○：適応します。　×：適応しません。

1.3.14　IPスイッチのメンバー

IPスイッチ（IPSwitchesリソース）のメンバーについて説明します。

メンバー名 | データ型 | 説明 | 変更可否 | フィルター条件（$query）への適用 | ソート条件($order-by)への適用
instanceID | long | インスタンスを特定するID。 | × | ○ | ○
name | string | IPスイッチの名称。 | × | ○ | ○
ipAddress | string | IPスイッチのIPアドレス。 | × | × | ×
status | enum | IPスイッチの状態。指定できる値は，「1.6　列挙型一覧」のNodeStatusTypeの表を参照してください。 | × | ○（eq，ne，in，not inのみ） | ×
monitorStatus | enum | IPスイッチの監視状態。指定できる値は，「1.6　列挙型一覧」のManagementLevelTypeの表を参照してください。 | × | ○（eq，ne，in，not inのみ） | ×
description | string | IPスイッチの詳細情報。 | × | ○ | ○
usedCredentialID | long | 発見時に使用された認証情報を特定するID。 | × | × | ×
usedCredentials | string | 発見時に使用された認証情報の名称。 | × | × | ×
thresholdProfileID | long | 割り当てられているプロファイルを特定するID。 | × | × | ×
thresholdProfileName | string | 割り当てられているプロファイルの名称。 | × | × | ×
accessPointType | enum | 発見時に使用された認証情報の種別。指定できる値は，「1.6　列挙型一覧」のProtocolTypeの表を参照してください。 | × | × | ×
accessPointSnmpVersion | enum | 発見時に使用されたSNMPのバージョン。指定できる値は，「1.6　列挙型一覧」のSnmpVersionの表を参照してください。 | × | × | ×
accessPointIpAddress | string | 監視対象への接続に使用したIPアドレス。 | × | × | ×
accessPointUser | string | 監視対象への接続に使用したユーザーID。 | × | × | ×

（凡例）○：適応します。　×：適応しません。

1.3.15　FCスイッチのメンバー

FCスイッチ（FCSwitchesリソース）のメンバーについて説明します。

メンバー名 | データ型 | 説明 | 変更可否 | フィルター（$query）条件への適用 | ソート条件（$order-by）への適用
instanceID | long | インスタンスを特定するID。 | × | ○ | ○
name | string | FCスイッチの名称。 | × | ○ | ○
ipAddress | string | FCスイッチのIPアドレス。 | × | × | ×
status | enum | FCスイッチの状態。指定できる値は，「1.6　列挙型一覧」のNodeStatusTypeの表を参照してください。 | × | ○（eq，ne，in，not inのみ） | ×
monitorStatus | enum | FCスイッチの監視状態。指定できる値は，「1.6　列挙型一覧」のManagementLevelTypeの表を参照してください。 | × | ○（eq，ne，in，not inのみ） | ×
description | string | FCスイッチの詳細情報。 | × | ○ | ○
usedCredentialID | long | 発見時に使用された認証情報を特定するID。 | × | × | ×
usedCredentials | string | 発見時に使用された認証情報の名称。 | × | × | ×
wwn | string | FCスイッチに割り当てられたWWN。 | × | ○ | ○
thresholdProfileID | long | 割り当てられているプロファイルを特定するID。 | × | × | ×
thresholdProfileName | string | 割り当てられているプロファイルの名称。 | × | × | ×
accessPointType | enum | 発見時に使用された認証情報の種別。指定できる値は，「1.6　列挙型一覧」のProtocolTypeの表を参照してください。 | × | × | ×
accessPointIpAddress | string | 監視対象への接続に使用したIPアドレス。 | × | × | ×
accessPointUser | string | 監視対象への接続に使用したユーザーID。 | × | × | ×

（凡例）○：適応します。　×：適応しません。

1.3.16　ストレージシステムのメンバー

ストレージシステム（StorageSystemsリソース）のメンバーについて説明します。

メンバー名 | データ型 | 説明 | 変更可否 | フィルター条件（$query）への適用 | ソート条件（$order-by）への適用
instanceID | long | インスタンスを特定するID。 | × | ○ | ○
name | string | ストレージシステムの名称。 | × | ○ | ○
ipAddress | string | ストレージシステムのIPアドレス。 | × | × | ×
status | enum | ストレージシステムの状態。指定できる値は，「1.6　列挙型一覧」のNodeStatusTypeの表を参照してください。 | × | ○（eq，ne，in，not inのみ） | ×
monitorStatus | enum | ストレージシステムの監視状態。指定できる値は，「1.6　列挙型一覧」のManagementLevelTypeの表を参照してください。 | × | ○（eq，ne，in，not inのみ） | ×
description | string | ストレージシステムの詳細情報。 | × | ○ | ○
usedCredentialID | string | 発見時に使用された認証情報の名称。 | × | × | ×
usedCredentials | long | 割り当てられているプロファイルを特定するID。 | × | × | ×
thresholdProfileID | long | 割り当てられているプロファイルを特定するID。 | × | × | ×
thresholdProfileName | string | 割り当てられているプロファイルの名称。 | × | × | ×
accessPointType | enum | 発見時に使用された認証情報の種別。指定できる値は，「1.6　列挙型一覧」のProtocolTypeの表を参照してください。 | × | × | ×
accessPointIpAddress | string | 監視対象への接続に使用したIPアドレス。 | × | × | ×
accessPointUser | string | 監視対象への接続に使用したユーザーID。 | × | × | ×

（凡例）○：適応します。　×：適応しません。

1.3.17　ボリュームのメンバー

ボリューム（Volumesリソース）のメンバーについて説明します。

メンバー名 | データ型 | 説明 | 変更可否 | フィルター条件（$query）への適用 | ソート条件（$order-by）への適用
instanceID | long | インスタンスを特定するID。 | × | ○ | ○
status | enum | ボリュームの状態。指定できる値は，「1.6　列挙型一覧」のNodeStatusTypeの表を参照してください。 | × | ○（eq，ne，in，not inのみ） | ×
ldev | string | ボリュームのLDEV名。 | × | ○ | ○
storageSubsystemID | long | ボリュームが属するストレージシステムを特定するID。 | × | × | ×
storageSubsystem | string | ボリュームが属するストレージシステムの名称。 | × | × | ×
storageSubsystemMonitorStatus | enum | ボリュームが属するストレージシステムの監視状態。指定できる値は，「1.6　列挙型一覧」のManagementLevelTypeの表を参照してください。 | × | ○（eq，ne，in，not inのみ） | ×
parityGroup | string | ボリュームが属するパリティグループの名称。 | × | × | ×
storagePool | string | ボリュームが属するストレージプールの名称。 | × | × | ×
thresholdProfileID | long | 割り当てられているプロファイルを特定するID。 | × | × | ×
thresholdProfileName | string | 割り当てられているプロファイルの名称。 | × | × | ×
groupIDs | long[] | 割り当てられているコンシューマーを特定するID。 | × | × | ×
groupNames | string[] | 割り当てられているコンシューマーの名称。 | × | × | ×

（凡例）○：適応します。　×：適応しません。

1.3.18　アプリケーションのメンバー

アプリケーション（Applicationsリソース）のメンバーについて説明します。

メンバー名 | データ型 | 説明 | 変更可否 | フィルター条件（$query）への適用 | ソート条件（$order-by）への適用
instanceID | long | インスタンスを特定するID | × | × | ×
name | string | 発見されたリソース名 | × | × | ×
applicationType | enum | アプリケーションの種別。指定できる値は，「1.6　列挙型一覧」のApplicationTypeの表を参照してください。 | × | × | ×
applicationDetailType | string | 任意のアプリケーションの種別 | × | × | ×
ipAddress | string | アプリケーションのIPアドレス | × | × | ×
description | string | アプリケーションの詳細情報 | × | × | ×
collectorID | long | 発見に使用されたコレクターを特定するID | × | × | ×
collectorName | string | 発見に使用されたコレクターの名称 | × | × | ×
applicationHosts | ApplicationHost[] | アプリケーションが属するリソースの情報 | × | × | ×
autoCollectionType | enum | コレクターの定期実行設定。指定できる値は，「1.6　列挙型一覧」のConnectTypeの表を参照してください。 | × | × | ×
groupIDs | long[] | アプリケーションが割り当たっているコンシューマーを特定するID | × | × | ×
groupNames | string[] | アプリケーションが割り当たっているコンシューマーの名称 | × | × | ×
gradeNames | string[] | アプリケーションが割り当たっているコンシューマーのグレード | × | × | ×
gradeOrders | int[] | アプリケーションが割り当たっているコンシューマーのグレードの優先度 | × | × | ×
usedCredentialID | int[] | 発見時に使用された認証情報を特定するID | × | × | ×
usedCredentials | string | 発見時に使用された認証情報 | × | × | ×
accessPointType | enum | 認証情報の種別。指定できる値は，「1.6　列挙型一覧」のProtocolTypeの表を参照してください。 | × | × | ×
accessPointIpAddress | string | 認証情報のIPアドレスまたはホスト名 | × | × | ×
accessPointUser | string | 監視対象または管理ソフトウェアへの接続に使用したユーザーID | × | × | ×

（凡例）○：適応します。　×：適応しません。

1.3.19　アプリケーションのリソース情報のメンバー

アプリケーションのリソース情報（ApplicationHostリソース）のメンバーについて説明します。

メンバー名 | データ型 | 説明 | 変更可否 | フィルター条件（$query）への適用 | ソート条件（$order-by）への適用
resourceID | long | アプリケーションが属するリソースのID。 | × | × | ×
resourceType | enum | アプリケーションが属するリソースの種別。指定できる値は，「1.6　列挙型一覧」のApplicationResourceTypeの表を参照してください。 | × | × | ×

（凡例）○：適応します。　×：適応しません。

1.3.20　リソース一覧取得時のリストのメンバー

リソース一覧取得時のリストのメンバーについて説明します。

メンバー名 | データ型 | 説明 | 変更可否 | フィルター条件（$query）への適用 | ソート条件（$order-by）への適用
data | object[] | 取得したリソースの一覧が設定されます。 | × | × | ×
page | integer | リクエストで指定したpage（ページ番号）。 | × | × | ×
pageSize | integer | リクエストで指定したpageSize（ページに含まれるオブジェクトの最大数）。 | × | × | ×
numPages | integer | page（ページ番号）の総数。 | × | × | ×
totalCount | integer | 返却されるリソースの総数。 | × | × | ×
count | integer | クエリパラメータの条件に合致したデータの個数。 | × | × | ×

（凡例）○：適応します。　×：適応しません。

1.4　JP1/OAのAPIで操作できるリソース

JP1/OAのAPIを使って操作できるリソースの一覧を次に示します。

リソース

ドメイン

Applications

objects

Collectors

objects

Credentials

objects

E2EView

services

Events

services

FCSwitches

objects

FCSwitches

services

Grades

objects

Groups

objects

Hosts

objects

Hosts

services

Hypervisors

objects

Hypervisors

services

IPSwitches

objects

IPSwitches

services

IpAddrRanges

objects

PerfComponents

services

StorageSystems

objects

StorageSystems

services

SystemThresholdProfiles

objects

UserThresholdProfiles

objects

VirtualMachines

objects

VirtualMachines

services

Volumes

objects

version

configuration

1.5　JP1/OAのAPIを使って発行できるリクエスト

JP1/OAのAPIを使って発行できるリクエストの一覧をリソースごとに示します。

Applications(Domain : objects)

リクエスト

メソッド

URI

権限

アプリケーションの一覧の取得

GET

/v1/objects/Applications

Admin, Modify

Collectors(Domain : objects)

リクエスト

メソッド

URI

権限

コレクターの一覧の取得

GET

/v1/objects/Collectors

Admin, Modify

コレクターの作成

POST

/v1/objects/Collectors

Admin

コレクターの情報取得

GET

/v1/objects/Collectors/{id}

Admin, Modify

コレクターの更新

PUT

/v1/objects/Collectors/{id}

Admin

コレクターの削除

DELETE

/v1/objects/Collectors/{id}

Admin

Credentials(Domain : objects)

リクエスト

メソッド

URI

権限

認証情報の一覧の取得

GET

/v1/objects/Credentials

Admin

認証情報の作成

POST

/v1/objects/Credentials

Admin

認証情報の情報取得

GET

/v1/objects/Credentials/{id}

Admin

認証情報の更新

PUT

/v1/objects/Credentials/{id}

Admin

認証情報の削除

DELETE

/v1/objects/Credentials/{id}

Admin

E2EView(Domain : services)

リクエスト

メソッド

URI

権限

指定したリソースの情報や関連するリソース一覧をCSVで取得するために必要な情報の取得

GET

/v1/services/E2EView/actions/getNodesDataCSV

Admin, Modify

指定したリソースの情報や関連するリソース一覧をCSVで取得

POST

/v1/services/E2EView/actions/getNodesDataCSV/invoke

Admin, Modify

Events(Domain : services)

リクエスト

メソッド

URI

権限

イベントの一覧をCSVで取得するために必要な情報の取得

GET

/v1/services/Events/actions/getEventDataCSV

Admin, Modify

イベントの一覧をCSVで取得

POST

/v1/services/Events/actions/getEventDataCSV/invoke

Admin, Modify

FCSwitches(Domain : objects)

リクエスト

メソッド

URI

権限

FCスイッチの一覧の取得

GET

/v1/objects/FCSwitches

Admin, Modify

FCSwitches(Domain : services)

リクエスト

メソッド

URI

権限

FCスイッチに対する操作一覧の取得

GET

/v1/services/FCSwitches/actions

Admin, Modify

FCスイッチの監視状態変更に必要な情報の取得

GET

/v1/services/FCSwitches/actions/changeManagedType

Admin, Modify

FCスイッチの監視状態の変更

POST

/v1/services/FCSwitches/actions/changeManagedType/invoke

Admin, Modify

Grades(Domain : objects)

リクエスト

メソッド

URI

権限

グレードの一覧の取得

GET

/v1/objects/Grades

Admin, Modify

Groups(Domain : objects)

リクエスト

メソッド

URI

権限

コンシューマーの一覧の取得

GET

/v1/objects/Groups

Admin, Modify

コンシューマーの作成

POST

/v1/objects/Groups

Admin, Modify

コンシューマーの情報取得

GET

/v1/objects/Groups/{id}

Admin, Modify

コンシューマーの更新

PUT

/v1/objects/Groups/{id}

Admin, Modify

コンシューマーの削除

DELETE

/v1/objects/Groups/{id}

Admin, Modify

コンシューマーに対する操作一覧の取得

GET

/v1/objects/Groups/{id}/actions

Admin, Modify

コンシューマーの割り当てに必要な情報の取得

GET

/v1/objects/Groups/{id}/actions/updateTargetResource

Admin, Modify

コンシューマーの割り当て

POST

/v1/objects/Groups/{id}/actions/updateTargetResource/invoke

Admin, Modify

リソースの割り当て方を指定したコンシューマーの割り当てに必要な情報の取得

GET

/v1/objects/Groups/{id}/actions/updateTargetResourceWithAssignmentType

Admin, Modify

リソースの割り当て方を指定したコンシューマーの割り当て

POST

/v1/objects/Groups/{id}/actions/updateTargetResourceWithAssignmentType/invoke

Admin, Modify

Hosts(Domain : objects)

リクエスト

メソッド

URI

権限

ホストの一覧の取得

GET

/v1/objects/Hosts

Admin, Modify

Hosts(Domain : services)

リクエスト

メソッド

URI

権限

ホストに対する操作一覧の取得

GET

/v1/services/Hosts/actions

Admin, Modify

ホストの監視状態変更に必要な情報の取得

GET

/v1/services/Hosts/actions/changeManagedType

Admin, Modify

ホストの監視状態の変更

POST

/v1/services/Hosts/actions/changeManagedType/invoke

Admin, Modify

Hypervisors(Domain : objects)

リクエスト

メソッド

URI

権限

ハイパーバイザーの一覧の取得

GET

/v1/objects/Hypervisors

Admin, Modify

Hypervisors(Domain : services)

リクエスト

メソッド

URI

権限

ハイパーバイザーに対する操作一覧の取得

GET

/v1/services/Hypervisors/actions

Admin, Modify

ハイパーバイザーの監視状態変更に必要な情報の取得

GET

/v1/services/Hypervisors/actions/changeManagedType

Admin, Modify

ハイパーバイザーの監視状態の変更

POST

/v1/services/Hypervisors/actions/changeManagedType/invoke

Admin, Modify

IPSwitches(Domain : objects)

リクエスト

メソッド

URI

権限

IPスイッチの一覧の取得

GET

/v1/objects/IPSwitches

Admin, Modify

IPSwitches(Domain : services)

リクエスト

メソッド

URI

権限

IPスイッチに対する操作一覧の取得

GET

/v1/services/IPSwitches/actions

Admin, Modify

IPスイッチの監視状態変更に必要な情報の取得

GET

/v1/services/IPSwitches/actions/changeManagedType

Admin, Modify

IPスイッチの監視状態の変更

POST

/v1/services/IPSwitches/actions/changeManagedType/invoke

Admin, Modify

IpAddrRanges(Domain : objects)

リクエスト

メソッド

URI

権限

探索範囲の一覧の取得

GET

/v1/objects/IpAddrRanges

Admin

探索範囲の作成

POST

/v1/objects/IpAddrRanges

Admin

探索範囲の情報取得

GET

/v1/objects/IpAddrRanges/{id}

Admin

探索範囲の更新

PUT

/v1/objects/IpAddrRanges/{id}

Admin

探索範囲の削除

DELETE

/v1/objects/IpAddrRanges/{id}

Admin

PerfComponents(Domain : services)

リクエスト

メソッド

URI

権限

指定した性能情報の時系列での性能値をCSVで取得するために必要な情報の取得

GET

/v1/services/PerfComponents/actions/getGraphDataCSV

Admin, Modify

指定した性能情報の時系列での性能値をCSVで取得

POST

/v1/services/PerfComponents/actions/getGraphDataCSV/invoke

Admin, Modify

指定したリソースが持つ性能情報の最新値をCSVで取得するために必要な情報の取得

GET

/v1/services/PerfComponents/actions/getNodesGraphDataCSV

Admin, Modify

指定したリソースが持つ性能情報の最新値をCSVで取得

POST

/v1/services/PerfComponents/actions/getNodesGraphDataCSV/invoke

Admin, Modify

StorageSystems(Domain : objects)

リクエスト

メソッド

URI

権限

ストレージシステムの一覧の取得

GET

/v1/objects/StorageSystems

Admin, Modify

StorageSystems(Domain : services)

リクエスト

メソッド

URI

権限

ストレージシステムに対する操作一覧の取得

GET

/v1/services/StorageSystems/actions

Admin, Modify

ストレージシステムの監視状態変更に必要な情報の取得

GET

/v1/services/StorageSystems/actions/changeManagedType

Admin, Modify

ストレージシステムの監視状態の変更

POST

/v1/services/StorageSystems/actions/changeManagedType/invoke

Admin, Modify

SystemThresholdProfiles(Domain : objects)

リクエスト

メソッド

URI

権限

システムプロファイルの一覧の取得

GET

/v1/objects/SystemThresholdProfiles

Admin, Modify

システムプロファイルの作成

POST

/v1/objects/SystemThresholdProfiles

Admin, Modify

システムプロファイルの情報取得

GET

/v1/objects/SystemThresholdProfiles/{id}

Admin, Modify

システムプロファイルの更新

PUT

/v1/objects/SystemThresholdProfiles/{id}

Admin, Modify

システムプロファイルの削除

DELETE

/v1/objects/SystemThresholdProfiles/{id}

Admin, Modify

システムプロファイルに対する操作一覧の取得

GET

/v1/objects/SystemThresholdProfiles/{id}/actions

Admin, Modify

システムプロファイルの割り当てに必要な情報の取得

GET

/v1/objects/SystemThresholdProfiles/{id}/actions/updateTargetResource

Admin, Modify

システムプロファイルの割り当て

POST

/v1/objects/SystemThresholdProfiles/{id}/actions/updateTargetResource/invoke

Admin, Modify

UserThresholdProfiles(Domain : objects)

リクエスト

メソッド

URI

権限

ユーザープロファイルの一覧の取得

GET

/v1/objects/UserThresholdProfiles

Admin, Modify

ユーザープロファイルの作成

POST

/v1/objects/UserThresholdProfiles

Admin, Modify

ユーザープロファイルの情報取得

GET

/v1/objects/UserThresholdProfiles/{id}

Admin, Modify

ユーザープロファイルの更新

PUT

/v1/objects/UserThresholdProfiles/{id}

Admin, Modify

ユーザープロファイルの削除

DELETE

/v1/objects/UserThresholdProfiles/{id}

Admin, Modify

ユーザープロファイルに対する操作一覧の取得

GET

/v1/objects/UserThresholdProfiles/{id}/actions

Admin, Modify

ユーザープロファイルの割り当てに必要な情報の取得

GET

/v1/objects/UserThresholdProfiles/{id}/actions/updateTargetResource

Admin, Modify

ユーザープロファイルの割り当て

POST

/v1/objects/UserThresholdProfiles/{id}/actions/updateTargetResource/invoke

Admin, Modify

VirtualMachines(Domain : objects)

リクエスト

メソッド

URI

権限

仮想マシンの一覧の取得

GET

/v1/objects/VirtualMachines

Admin, Modify

VirtualMachines(Domain : services)

リクエスト

メソッド

URI

権限

仮想マシンに対する操作一覧の取得

GET

/v1/services/VirtualMachines/actions

Admin, Modify

仮想マシンの監視状態変更に必要な情報の取得

GET

/v1/services/VirtualMachines/actions/changeManagedType

Admin, Modify

仮想マシンの監視状態の変更

POST

/v1/services/VirtualMachines/actions/changeManagedType/invoke

Admin, Modify

Volumes(Domain : objects)

リクエスト

メソッド

URI

権限

ボリュームの一覧の取得

GET

/v1/objects/Volumes

Admin, Modify

version(Domain : configuration)

リクエスト

メソッド

URI

権限

バージョン情報の取得

GET

/v1/configuration/version

Admin, Modify

1.6　列挙型一覧

APIで指定可能な列挙型一覧を次の表に示します。

ProtocolType

enumerator

説明

WMI

WMIを使用

SSH

sshを使用

WBEM

SMI-S WBEMを使用

SNMP

SNMPを使用

VCENTER

管理ソフトウェアがvCenter

AJS

管理ソフトウェアがJP1/AJS3 - Manager

PFM

管理ソフトウェアがJP1/PFM - Manager

IM

管理ソフトウェアがJP1/IM - Manager

CUSTOM

管理ソフトウェアが任意のアプリケーション

ArgusNodeType

enumerator

説明

NA

無効値

UNKNOWN

不明

ANY

全て

SERVER_WINDOWS

Windowsサーバ

SERVER_LINUX

Linuxサーバ

SERVER_ESX

ESXサーバ

SWITCH_FC

FCスイッチ

SWITCH_IP

IPスイッチ

STORAGE_HITACHI

日立製ストレージ

STORAGE_OTHER

他社製ストレージ

SERVER_SOLARIS

Solarisサーバ

SERVER_HYPERV

Hyer-Vサーバ

SERVER_HPUX

HP-UXサーバ

SERVER_VCENTER

vCenter Serverサーバ

SERVER_AIX

AIXサーバ

ManagementLevelType

enumerator

説明

New

新規発見された

Manage

監視されている

ignore

監視しない

MonitorOff

一時的に監視停止

MonitoringOperationType

enumerator

説明

Monitor

監視します

Ignore

監視を一時停止します

ComponentMonitorType

enumerator

説明

InUse

監視している

NotMonitored

監視していない

ConnectStatusType

enumerator

説明

NoConnect

未接続

Waiting

処理待ち

InProgress

処理中

Succeeded

成功

Failed

失敗

SnmpVersion

enumerator

説明

V1_V2C

SNMP v1またはv2

V3

SNMP v3

AuthenticationProtocol

enumerator

説明

MD5

MD5を使用

SHA1

SHA1を使用

PrivacyProtocol

enumerator

説明

DES

DESを使用

AES128

AES128を使用

ConnectType

enumerator

説明

AutoConnect

即接続実行かつ定期接続あり

NotAutoConnect

接続せず

HypertextTransferProtocolType

enumerator

説明

HTTP

HTTPを使用する

HTTPS

HTTPSを使用する

TemplateCreatorType

enumerator

説明

User

ユーザ定義

Default

デフォルト

NodeStatusType

enumerator

説明

Normal

正常

Warning

警告

Error

エラー

Unreachable

応答なし

Unknown

不明

NotMonitored

状態を判定しない

E2ENodeType

enumerator

説明

TAG

コンシューマー

CLUSTER

クラスター

HYPERVISOR

ハイパーバイザ

VM_HOST

仮想マシン/ホスト

VIRTUAL_MACHINE

仮想マシン

CPU

CPU

MEMORY

メモリ

NIC

NIC

HBA

HBA

DISK

ディスク

HOST

ホスト

SWITCH

スイッチ

FC_ZONE

Zone

FC_SWITCH

FCスイッチ

IP_SWITCH

IPスイッチ

STORAGE

ストレージ

STORAGE_VOLUME

ボリューム(ストレージ)

STORAGE_PORT

ポート

STORAGE_MP

プロセッサ

STORAGE_CACHE

キャッシュ

STORAGE_POOL

プール

STORAGE_PG

パリティグループ

APPLICATION

アプリケーション

APPLICATION_AJS_MANAGER

AJS-Mamanger

APPLICATION_AJS_AGENT

AJS-Agent

APPLICATION_PFM

PFM

APPLICATION_OS

OS

APPLICATION_CUSTOM

任意のアプリケーション

CollectorOsType

enumerator

説明

Windows

OSタイプはWindows

Unix

OSタイプはUnix

AssignmentType

enumerator

説明

Occupy

占有

Share

共有

NoChange

変更なし

ApplicationType

enumerator

説明

AJS_MANAGER

AJS(Manager)

AJS_AGENT

AJS(Agent)

PFM_SERVICERESPONSE

PFM(ServiceResponse)

PFM_AJS3

PFM(AJS3)

PFM_DOMINO

PFM(Domino)

PFM_EXCHANGE

PFM(Exchange)

PFM_SAPSYSTEM

PFM(SAP System)

PFM_IBMWEBSPHEREMQ

PFM(IBMWebSphereMQ)

PFM_OPENTP1

PFM(OpenTP1)

PFM_COSMINEXUS

PFM(Cosminexus)

PFM_IIS

PFM(IIS)

PFM_WEBLOGICSERVER

PFM(WebLogic Server)

PFM_WEBSPHEREAPPLICATIONSERVER

PFM(WebSphere Application Server)

PFM_DB2

PFM(DB2)

PFM_HIRDB

PFM(HiRDB)

PFM_SQL

PFM(SQL)

PFM_RMSQLSERVER

PFM(RM SQLServer)

PFM_ORACLE

PFM(Oracle)

PFM_RMORACLE

PFM(RM Oracle)

PFM_RMPLATFORM

PFM(RM Platform)

PFM_UNIX

PFM(UNIX)

PFM_WINDOWS

PFM(Windows)

IM_OS

IM(OS)

PFM_RMVIRTUALMACHINE

PFM(RM VirtualMachine)

PFM_VIRTUALMACHINE

PFM(VirtualMachine)

CUSTOM

Custom

ApplicationResourceType

enumerator

説明

VirtualMachine

仮想マシンを示します

Host

ホストを示します

NodeInformationType

enumerator

説明

AllInformation

取得対象ノードの関連情報と基本情報を取得

BasicInformation

取得対象ノードの基本情報を取得し、関連リソースの情報を取得

1.7　APIの記述形式

各APIで説明する項目を次に示します。ただし，APIによっては説明のない項目もあります。

機能

APIの機能について説明します。

権限

APIを実行できる権限およびロールを示します。

APIのバージョン

APIのバージョンを示します。

リクエスト形式

APIを使用する際のリクエスト形式について説明しています。

ステータスコード

httpプロトコルまたはhttpsプロトコルを使用してAPIを実行したあとのステータスコードについて説明します。APIを実行する前にエラーになった場合のステータスコードについては，「1.2.6　ステータスコード」を参照してください。

レスポンスのスキーマ

APIが正常終了したときに返却するレスポンスのスキーマ情報について説明します。

使用例

APIを使用するためのリクエスト例およびレスポンス例について説明します。

ただし，ここでは，httpプロトコルを使用している場合の例を記載します。httpsプロトコルを使用する場合は，「HTTP」を「HTTPS」に読み替えてください。

1.8　APIによるJP1/OAの操作

APIを使ってJP1/OAを操作する手順について説明します。ただし，APIによっては説明のない項目もあります。

1.8.1　認証情報を作成する

認証情報を作成するために使用するリクエストの形式と，リクエストボディーの作成方法について説明します。

操作手順

作成したい認証情報のプロトコル（WMI，SSHなど）を決めます。

テンプレートとするため，作成したい認証情報と同じプロトコルを使用している認証情報を取得します。次の形式でリクエストを発行します。

GET http://host:port/Analytics/version/objects/Credentials

手順2で取得した認証情報（Credentialリソース）を次に示すとおり編集します。

表1‒12　Credentialリソースの変更個所

変更するメンバー

変更要否

変更内容

name

必須

作成する認証情報の名称に変更します。

名称は，すでに登録されている認証情報に存在しない値を指定する必要があります。

userId

必須

認証時に指定するユーザーID。「SNMP v3」プロトコルを使用する場合，userNameに指定した値が設定されます。

password

必須

認証時に使用するパスワード。

passwordNotRequired

任意

認証時にパスワードが必要ない場合，trueを指定します。「WMI」プロトコルを使用する場合だけ有効です。

portNumber

任意

認証時に使用するポート番号。管理対象への接続に使用するプロトコルが「SSH」「SMIS WBEM」「SNMP」の場合だけ有効です。

rootPassword

必須

認証時に使用するrootパスワード。「SSH」プロトコルを使用する場合だけ有効です。

ssl

任意

監視対象への接続時にSSL(https)を使用するかどうか。「SMI-S WBEM」を使用する場合だけ有効です。

domainname

任意

認証時に使用するドメイン名。「WMI」を使用する場合だけ有効です。

namespace

任意

認証時に使用するネームスペース。「SMI-S WBEM」を使用する場合だけ有効です。

community

任意

認証時に使用するコミュニティ名。「SNMP」を使用する場合だけ有効です。

snmpVersion

任意

SNMPのバージョン。「SNMP」を使用する場合だけ有効です。

userName

任意

認証時に使用するユーザー名。「SNMP v3」を使用する場合だけ有効です。

authenticationEnabled

任意

SMTP認証を行う場合はtrueを指定します。「SNMP v3」を使用する場合だけ有効です。

authenticationPassphrase

任意

認証時に使用するパスフレーズ。「SNMP v3」を使用する場合だけ有効です。

authenticationProtocol

任意

認証時に使用するプロトコル。「SNMP v3」を使用する場合だけ有効です。

privacyEnabled

任意

認証時にプライバシーを有効にする場合はtrueを指定します。「SNMP v3」を使用する場合だけ有効です。

privacyPassphrase

任意

認証時にプライバシーを使用する場合に指定するパスフレーズ。「SNMP v3」を使用する場合だけ有効です。

privacyProtocol

任意

「SNMP v3」を使用する場合だけ有効です。

次の形式でリクエストを発行します。リクエストボディーには，手順3で編集した認証情報を指定します。

POST http://host:port/Analytics/version/objects/Credentials

関連項目

2.1.2　認証情報の情報取得

2.1.3　認証情報の作成

1.8.2　探索範囲を作成する

探索範囲を作成するために使用するリクエストの形式と，リクエストボディーの作成方法について説明します。

操作手順

テンプレートとするため，任意の探索範囲を取得します。次の形式でリクエストを発行します。

GET http://host:port/Analytics/version/objects/IpAddrRanges

手順1で取得した探索範囲（IpAddrRangeリソース）を次に示すとおり編集します。

表1‒13　IpAddrRangeリソースの変更個所

変更するメンバー

変更要否

変更内容

name

必須

作成する探索範囲の名称に変更します。

名称は，すでに登録されている探索範囲に存在しない値を指定する必要があります。

ipAddrRange

必須

探索する範囲のIPアドレスを指定します。既に登録されている探索範囲に存在しない範囲を指定する必要があります。

usePing

任意

探索時にPingを使用する場合はtrueを指定します。

useAllCredential

任意

探索時に全ての認証情報を使用する場合はtrueを指定します。

selectCredentials

任意

使用する認証情報を指定します。認証情報の指定方法は「1.8.1　認証情報を作成する」を参照してください。

deviceClassificationLabel

任意

機器に割り当てられた分類ラベルを指定します。

次の形式でリクエストを発行します。リクエストボディーには，手順2で編集した探索範囲を指定します。

POST http://host:port/Analytics/version/objects/IpAddrRanges

関連項目

2.2.3　探索範囲の作成

2.2.2　探索範囲の情報取得

1.8.3　コレクターを作成する

コレクターを作成するために使用するリクエストの形式と，リクエストボディーの作成方法について説明します。

操作手順

作成したいコレクター種別（VCENTER，AJSなど）を決めます。

テンプレートとするため，作成したいコレクターと同じ種別を使用しているコレクターを取得します。次の形式でリクエストを発行します。

GET http://host:port/Analytics/version/objects/Collectors

手順2で取得したコレクター（Collectorsリソース，CollectorCredentialリソース）を次に示すとおり編集します。

表1‒14　Collectorリソースの変更個所

変更するメンバー

変更要否

変更内容

name

必須

作成するコレクターの名称に変更します。

名称は，すでに登録されているコレクターに存在しない値を指定する必要があります。

osType

任意

監視対象のOSの種別を指定します。

collectorCredentials

任意

監視対象に接続に使用する認証情報を指定します。変更個所は以下の表を参照してください。

表1‒15　CollectorCredentialリソースの変更個所

変更するメンバー

変更要否

変更内容

ipAddress

任意

管理ソフトウェアへの接続に使用するIPアドレスまたはホスト名を設定します。

userId

任意

管理ソフトウェアへの接続に使用するユーザーIDを設定します。

password

任意

管理ソフトウェアへの接続に使用するパスワードを設定します。

portNumber

任意

管理ソフトウェアへの接続に使用するポート番号を設定します。

hypertextTransferProtocolType

任意

Collector種別がVCENTERの場合だけ，設定可能です。HTTPSを指定します。

domainName

任意

コレクター種別がAJS，PFM，IMであり，osTypeがWindowsの場合だけ，設定可能です。ドメイン名を指定します。

rootPassword

任意

コレクター種別がAJS，PFM， IMであり，osTypeがUnixの場合だけ，設定可能です。rootのパスワードを指定します。

useAdministrativeShares

任意

コレクター種別がAJS， PFM， IMであり，osTypeがWindowsの場合だけ，設定可能です。管理共有を行う場合にtrueを指定します。trueを指定する場合，shareNameとsharedFolderの指定は不要です。

shareName

任意

コレクター種別がAJS， PFM， IMであり，osTypeがWindowsの場合だけ，設定可能です。共有名を指定します。useAdministrativeSharesがfalseの場合に有効です。

sharedFolder

任意

コレクター種別がAJS， PFM， IMであり，osTypeがWindowsの場合だけ，設定可能です。共有フォルダのパスを指定します。useAdministrativeSharesがfalseの場合に有効です。

次の形式でリクエストを発行します。リクエストボディーには，手順3で編集したコレクターを指定します。

POST http://host:port/Analytics/version/objects/Collectors

関連項目

2.3.2　コレクターの情報取得

2.3.3　コレクターの作成

1.8.4　ユーザープロファイルを作成する

ユーザープロファイルを作成するために使用するリクエストの形式と，リクエストボディーの作成方法について説明します。

操作手順

作成したいリソース種別（VM，VOLUMEなど）を決めます。

テンプレートとするため，作成したいユーザープロファイルと同じ種別を使用しているユーザープロファイルを取得します。次の形式でリクエストを発行します。

GET http://host:port/Analytics/version/objects/UserThresholdProfiles

手順2で取得したユーザープロファイル（UserThresholdProfilesリソース，UserThresholdValueリソース）を次に示すとおり編集します。

表1‒16　UserThresholdProfilesリソースの変更個所

変更するメンバー

変更要否

変更内容

name

必須

作成するユーザープロファイルの名称に変更します。

名称は，すでに登録されているユーザープロファイルまたはシステムプロファイルに存在しない値を指定する必要があります。

description

任意

作成するユーザープロファイルの説明を記述します。

profileType

必須

Userを指定します。

thresholdValues

任意

しきい値や監視状態を変更します。なお，ユーザープロファイルの作成には，変更がない場合でもすべてのUserThresholdValueの設定が必要なため，取得できた値は削除しないでください。変更個所は以下の表を参照してください。

表1‒17　UserThresholdValueリソースの変更個所

変更するメンバー

変更要否

変更内容

monitoring

必須

監視するかどうかを指定します。

thresholdValueOfWarning

任意

警告のしきい値を設定します。maxメンバー以下，minメンバー以上の値を指定する必要があります。またstepSizeメンバーの倍数である必要があります。

thresholdValueOfError

任意

エラーのしきい値を設定します。maxメンバー以下，minメンバー以上の値を指定する必要があります。またstepSizeメンバーの倍数である必要があります。

次の形式でリクエストを発行します。リクエストボディーには，手順3で編集したコレクターを指定します。

POST http://host:port/Analytics/version/objects/UserThresholdProfiles

関連項目

2.4.2　ユーザープロファイルの情報取得

2.4.3　ユーザープロファイルの作成

1.8.5　システムプロファイルを作成する

システムプロファイルを作成するために使用するリクエストの形式と，リクエストボディーの作成方法について説明します。

操作手順

作成したいリソース種別（ESX，IPSWITCHなど）を決めます。

テンプレートとするため，作成したいシステムプロファイルと同じリソース種別を使用しているシステムプロファイルを取得します。次の形式でリクエストを発行します。

GET http://host:port/Analytics/version/objects/SystemThresholdProfiles

手順2で取得したシステムプロファイル（SystemhresholdProfilesリソース，SystemThresholdValueリソース）を次に示すとおり編集します。

表1‒18　SystemhresholdProfilesリソースの変更個所

変更するメンバー

変更要否

変更内容

name

必須

作成するシステムプロファイルの名称に変更します。

名称は，すでに登録されているユーザープロファイルまたはシステムプロファイルに存在しない値を指定する必要があります。

description

任意

作成するシステムプロファイルの説明を記述します。

profileType

必須

Userを指定します。

thresholdValues

任意

しきい値や監視状態を変更します。なお，システムプロファイルの作成には，変更がない場合でもすべてのSystemThresholdValueの設定が必要なため，取得できた値は削除しないでください。変更個所は以下の表を参照してください。

表1‒19　SystemThresholdValueリソースの変更個所

変更するメンバー

変更要否

変更内容

monitoring

必須

監視するかどうかを指定します。

thresholdValueOfWarning

任意

警告のしきい値を設定します。maxメンバー以下，minメンバー以上の値を指定する必要があります。またstepSizeメンバーの倍数である必要があります。

thresholdValueOfError

任意

エラーのしきい値を設定します。maxメンバー以下，minメンバー以上の値を指定する必要があります。またstepSizeメンバーの倍数である必要があります。

次の形式でリクエストを発行します。リクエストボディーには，手順3で編集したコレクターを指定します。

POST http://host:port/Analytics/version/objects/SystemThresholdProfiles

関連項目

2.5.2　システムプロファイルの情報取得

2.5.3　システムプロファイルの作成

1.8.6　コンシューマーを作成する

コンシューマーを作成するために使用するリクエストの形式と，リクエストボディーの作成方法について説明します。

操作手順

テンプレートとするため，任意のコンシューマーを取得します。次の形式でリクエストを発行します。

GET http://host:port/Analytics/version/objects/Groups

手順1で取得したコンシューマー（Groupsリソース）を次に示すとおり編集します。

表1‒20　Groupsリソースの変更個所

変更するメンバー

変更要否

変更内容

name

必須

作成するコンシューマーの名称に変更します。

名称は，登録されていない名称を指定する必要があります。

description

任意

コンシューマーの説明を記載します。

templateCreatorType

必須

Userを指定します。

gradeKey

必須

グレードを識別するIDを指定します。グレードを識別するIDの取得は「2.6.3　グレードの一覧の取得」を参照してください。

urls

任意

コンシューマーに設定できるURLです。

vmAutoAssignment

任意

ハイパーバイザーがコンシューマーに割り当てられた場合にハイパーバイザー配下の仮想マシンも自動的にコンシューマーに割り当てるかを指定します。割り当てる場合はtrueを指定します。指定しない場合，falseが設定されます。

applicationAssignFollow

任意

仮想マシン/ホストがコンシューマーに割り当てられた場合に仮想マシン/ホスト配下のアプリケーションも自動的にコンシューマーに割り当てるかを指定します。割り当てる場合はtrueを指定します。指定しない場合，falseが設定されます。

次の形式でリクエストを発行します。リクエストボディーには，手順2で編集したコンシューマーを指定します。

POST http://host:port/Analytics/version/objects/Groups

関連項目

2.6.2　コンシューマーの情報取得

2.6.4　コンシューマーの作成

1.8.7　ユーザープロファイルを割り当てる

リソース（仮想マシン，ホスト，ボリューム）をユーザープロファイルに割り当てるために使用するリクエストの形式と，リクエストボディーに指定する内容について説明します。

操作手順

次の形式でリクエストを発行します。

POST http://host:port/Analytics/version/objects/UserThresholdProfiles/id/actions/ updateTargetResource

リクエストボディーの中で「parameters」のメンバーとして指定するオブジェクトは次のとおりです。

メンバー

変更要否

説明

instanceID

必須

ユーザープロファイルを割り当てる監視対象のIDをリストとして設定します。すでに割り当て済みの監視対象のIDも含め，設定する必要があります。

instanceID=50の監視対象だけにユーザープロファイルを適用する場合の指定例：

"parameters" : [ { "instanceID" : 50 } ]

すでにinstanceID=50の監視対象に割り当てられているユーザープロファイルにinstanceID=51の監視対象を追加する場合の指定例(割り当てる対象となるIDすべてを連結して指定)：

"parameters" : [ { "instanceID" : 50 } , { "instanceID" : 51 } ]

すべての監視対象から割り当てを解除する場合の指定例(parametersに設定する値を空欄に指定)：

"parameters" : [ ]

「parameters」のメンバーに指定できる監視対象のIDは，以下の参照先に示すAPIから取得できます。

ユーザープロファイルのリソース種別

参照先

VM

2.8.1　仮想マシンの一覧の取得

WINDOWSまたはLINUX_UNIX

2.10.1　ホストの一覧の取得

VOLUME

2.14.1　ボリュームの一覧の取得

関連項目

2.4.7　ユーザープロファイルの割り当てに必要な情報の取得

2.4.8　ユーザープロファイルの割り当て

1.8.8　システムプロファイルを割り当てる

リソース（ハイパーバイザー，IPスイッチ，FCスイッチ）をシステムプロファイルに割り当てるために使用するリクエストの形式と，リクエストボディーに指定する内容について説明します。

操作手順

次の形式でリクエストを発行します。

POST http://host:port/Analytics/version/objects/SystemThresholdProfiles/id/actions/updateTargetResource

リクエストボディーの中で「parameters」のメンバーとして指定するオブジェクトは次のとおりです。

メンバー

指定可否

説明

instanceID

必須

システムプロファイルを割り当てる監視対象のIDをリストとして設定します。すでに割り当て済みの監視対象のIDも設定に含める必要があります。

instanceID=50の監視対象だけにシステムプロファイルを適用する場合の指定例：

"parameters" : [ { "instanceID" : 50 } ]

すでにinstanceID=50の監視対象に割り当てられているシステムプロファイルにinstanceID=51の監視対象を追加する場合の指定例（割り当てる対象となるIDすべてを連結して指定）：

"parameters" : [ { "instanceID" : 50 } , { "instanceID" : 51 } ]

すべての監視対象から割り当てを解除する場合の指定例（parametersの値を空欄に指定）：

"parameters" : [ ]

「parameters」のメンバーに指定できる監視対象のIDは以下の参照先に示すAPIから取得できます。

ユーザープロファイルのリソース種別

参照先

ESXまたはHYPERV

2.9.1　ハイパーバイザーの一覧の取得

IPSWITCH

2.11.1　IPスイッチの一覧の取得

FCSWITCH

2.12.1　FCスイッチの一覧の取得

関連項目

2.5.7　システムプロファイルの割り当てに必要な情報の取得

2.5.8　システムプロファイルの割り当て

1.8.9　イベント情報をCSV形式で取得する

イベント情報をCSV出力するために使用する各リクエストの形式と，リクエストボディーで指定する内容について説明します。

操作手順

次の形式でリクエストを発行します。

POST http://host:port/Analytics/version/services/Events/actions/getEventDataCSV/invoke

リクエストボディーの中で「parameters」のメンバーとして指定するオブジェクトは次のとおりです。

表1‒21　イベント情報のCSV取得時に指定できるメンバー

変更するメンバー

変更要否

変更内容

hqlFilter

任意

取得するイベントを絞り込みたい場合に式を指定します。式はパラメータ+演算子+値の順に記載します。式に指定できる値を以下の表に示します。式をandやorで結合することも可能です。

fqlSort

任意

取得するイベントをソートしたい場合に指定します。

page

任意

取得するページ数を指定します。

pageSize

任意

1ページあたりの取得件数を指定します。

表1‒22　hqlFilterに指定できるパラメータ

パラメータ

演算子

値

status

eq， ne

NOTACK，ACK

level

eq， ne

INFO，WARNING， CRITICAL

category

eq， ne

PERFORMANCE，STATUS，EVENT，SETTING，CANGE

deviceName

eq， ne， starts， ends， contains

任意の文字列

deviceType

eq， ne

Server，Storage，NetworkDevice，Collector

componentName

eq， ne， starts， ends， contains

任意の文字列

componentType

eq， ne

CPU，MEMORY，LAN_PORT，FC_HBA_PORT，[DISK_DRIVE，SCSI_DISK_DRIVE]，[STORAGE_CONTROLLER，STORAGE_MPB]，STORAGE_FC_PORT，STORAGE_POOL，SOTRAGE_volume，STORAGE_CACHE，VIRTUAL_MACHINE，HYPERVISOR_CLUSTER，STORAGE_DP_POOL

userName

eq， ne， starts， ends， contains

任意の文字列

関連項目

2.15.2　イベントの一覧をCSVで取得

1.8.10　リソースの基本情報および性能情報をCSV形式で取得する

「対象リソースの基本情報」「対象リソースが持つ，各メトリックの性能情報（最新値）」および「対象リソースが持つ，特定のメトリックの性能情報（時系列）」をCSV出力するために使用する各リクエストの形式と，リクエストボディーで指定する内容について説明します。

背景

リソースの基本情報および性能情報は，段階的に取得します。取得の流れは以下のとおりです。

リソースの一覧を取得するAPIを使用して，リソースのIDを取得します。

リソース情報をCSV形式で取得するAPIを使用して，リソース情報を取得します。リクエストボディーには，手順1で取得したリソースのIDを指定します。

リソースの性能情報（最新値）をCSV形式で取得するAPIを使用して，リソースの性能情報（最新値）を取得します。リクエストボディーには，手順1または手順2で取得したリソースのIDを指定します。

メトリックの性能情報（時系列）をCSV形式で取得するAPIを使用して，メトリックの性能情報（時系列）を取得します。リクエストボディーには，手順3で取得したメトリックのIDを指定します。

ここでは，ハイパーバイザー01のリソースであるCPU01の使用率を取得する例を使って手順を説明します。

操作手順

ハイパーバイザーの一覧を取得して，CPU01を持つハイパーバイザー01のIDを取得します。次の形式でリクエストを発行します。

GET http://host:port/Analytics/version/objects/Hypervisors

次のとおり出力されたレスポンスボディーの中から，ハイパーバイザー01のIDが「4」であることを確認します。

{
  "data" : [ {
    "instanceID" : 4,
    "name" : "hyperV",
    ...,
  }, ...
}

ハイパーバイザー01のIDをリクエストボディーに指定して，ハイパーバイザー01の情報を取得します。次の形式でリクエストを発行します。

POST http://host:port/Analytics/version/services/E2EView/actions/getNodesDataCSV/invoke

リクエストボディーの中で「parameters」のメンバーとして指定するオブジェクトは次のとおりです。

表1‒23　リソースの基本情報の取得時に指定するメンバー

メンバー

指定可否

説明

basePointNodes

必須

nodeIDには手順1で取得したID「4」を，nodeTypeにはノードの種別を指定します。ノード種別として指定できる値は，「1.6　列挙型一覧」のE2ENodeTypeの表を参照してください。

getType

必須

基本情報だけを取得する場合はBasicInformationを，関連情報も取得する場合はAllInformationを指定します。CPUやメモリ，NICなど各コンポーネントを取得したい場合はAllInformationを指定します。

次のとおり出力されたレスポンスボディーの中から，CPU01のIDが「4」であることを確認します。

{
  "instanceID" : "0052a2e2-713c-4cfb-892c-e9aaefb32b50",
  "created" : "2016-11-22T11:53:42.188+09:00",
  "updated" : "2016-11-22T11:53:42.354+09:00",
  "completed" : "2016-11-22T11:53:42.354+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ {
    "data": ""#JP1/Operations Analytics","111000","UTF-8 (BOM)"¥n"#Resource Information"¥n...",...,ResourceID,ResourceName,ResourceType,...,cpu4,CPU01,CPU,...,vm1,VM001,VM,...
  } ]
}

CPU01のIDをリクエストボディーに指定して，リソースの性能情報（最新値）を取得します。次の形式でリクエストを発行します。

POST http://host:port/Analytics/version/services/PerfComponents/actions/getNodesGraphDataCSV/invoke

リクエストボディーの中で「parameters」のメンバーとして指定するオブジェクトは次のとおりです。

表1‒24　リソースの性能情報（最新値）の取得時に指定するメンバー

メンバー

指定可否

説明

basePointNodes

必須

nodeIDには，手順2で取得したID「4」を，nodeTypeにはノードの種別を指定します。ノード種別として指定できる値は，「1.6　列挙型一覧」のE2ENodeTypeの表を参照してください。

baseTime

任意

性能情報を取得する基点の時刻。省略した場合は，APIを実行した時刻が基点として使用されます。

次のとおり出力されたレスポンスボディーの中から，CPUの使用率を示すIDが「2」であることを確認します。

{
  "instanceID" : "0052a2e2-713c-4cfb-892c-e9aaefb32b50",
  "created" : "2016-11-22T11:53:42.188+09:00",
  "updated" : "2016-11-22T11:53:42.354+09:00",
  "completed" : "2016-11-22T11:53:42.354+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ {
    "data": ""#JP1/Operations Analytics","111000","UTF-8 (BOM)"¥n"#Latest PerformanceInformation"¥n...",...,Performance ID,...,1,...,2,...,3,...
  } ]
}

CPUの使用率を示すIDをリクエストボディーに指定して，リソースの性能情報（時系列）を取得します。次の形式でリクエストを発行します。

POST http://host:port/Analytics/version/services/PerfComponents/actions/getNodesGraphDataCSV/invoke

リクエストボディーの中で「parameters」のメンバーとして指定するオブジェクトは次のとおりです。

表1‒25　リソースの性能情報（時系列）の取得時に指定するメンバー

メンバー

指定可否

説明

perfComponentIDs

必須

perfComponentIDsには手順3で取得したID「2」を指定します。

baseTime

任意

性能情報を取得する基点の時刻。省略した場合は，APIを実行した時刻が基点として使用されます。

pointTimeRange

必須

性能情報を取得する期間（ミリ秒）を指定します。

操作結果

手順2で「対象リソースの基本情報」，手順3で「対象リソースが持つ，各メトリックの性能情報（最新値）」，手順4で「対象リソースが持つ，特定のメトリックの性能情報（時系列）」がCSV形式で取得できます。

関連項目

2.9.1　ハイパーバイザーの一覧の取得

2.16.2　指定したリソースの情報や関連するリソース一覧をCSVで取得

2.17.4　指定したリソースが持つ性能情報の最新値をCSVで取得

2.17.2　指定した性能情報の時系列での性能値をCSVで取得

2　API一覧

この章では，JP1/OA が提供している各API について説明します。

2.1　認証情報に関するAPI一覧

JP1/OAが監視対象のリソースへの接続に使用する認証情報の操作を説明します。

2.1.1　認証情報の一覧の取得

JP1/OAが監視対象のリソースへの接続に使用する認証情報の一覧を取得します。

権限

Admin

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/Credentials

リクエストボディー

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

レスポンスボディー

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

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性

データ型

説明

data

anyType[]

Credential のコレクション。 Credential の詳細は以下の表を参照ください。

pagination

Pagination

ページ情報。リソースが存在しない場合、このパラメータは表示されません。

count

int

条件に合致したデータの個数

pagination (Type: Pagination)

属性

データ型

説明

page

integer

ページ

pageSize

integer

ページサイズ

numPages

integer

ページの数

totalCount

integer

オブジェクトの数

Credential

{
        "instanceID":"...",
        "name":"...",
        "credentialType":"...",
        "userId":"...",
        "passwordNotRequired":"...",
        "portNumber":"...",
        "ssl":"...",
        "domainname":"...",
        "namespace":"...",
        "community":"...",
        "snmpVersion":"...",
        "userName":"...",
        "authenticationEnabled":"...",
        "authenticationProtocol":"...",
        "privacyEnabled":"...",
        "privacyProtocol":"...",
        "numOfRelatedResources":"..."
}

Credential (Type: Credential)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

name

string

認証情報の名称

credentialType

enum

監視対象への接続に使用するプロトコル。

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

WMI

SSH

WBEM

SNMP

userId

string

認証時に指定するユーザーID。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合，”username”メンバーの値が設定されます。

passwordNotRequired

boolean

認証時にパスワードを必要とするかどうか。省略時はfalseが指定されます。監視対象への接続に「WMI」を使用する場合のみ有効です。

・true:パスワードは必要ない。

・false:パスワードが必要である。

portNumber

int

ポート番号。監視対象への接続に使用するプロトコルが「ssh」，「SMI-S WBEM」，「SNMP」の場合のみ設定されます。

ssl

boolean

監視対象への接続時にSSL(https)を使用するかどうか。

・true:SSLを使用する。

・false:SSLを使用する。

省略時はfalseが指定されます。監視対象への接続に「SMI-S WBEM」を使用する場合のみ有効です。

domainname

string

ドメイン名。監視対象への接続に「WMI」を使用する場合のみ設定されます。

namespace

string

ネームスペース。監視対象への接続に「SMI-S WBEM」を使用する場合のみ設定されます。

community

string

コミュニティ名。監視対象への接続に「SNMP」を使用する場合のみ設定されます。

snmpVersion

enum

SNMPのバージョン。監視対象への接続に「SNMP」を使用する場合のみ設定されます。

(指定可能な値は「列挙型一覧」のSnmpVersionの表を参照してください。)

以下に示す値のみ指定可能です。

V1_V2C

V3

userName

string

認証時に使用するユーザー名。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationEnabled

boolean

SMTP認証を行うかどうか。

・true:認証を有効にする。

・false:認証を無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationProtocol

enum

認証用のプロトコル。 監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

(指定可能な値は「列挙型一覧」のAuthenticationProtocolの表を参照してください。)

以下に示す値のみ指定可能です。

MD5

SHA1

privacyEnabled

boolean

プライバシーを有効にするかどうか。

・true:プライバシーを有効にする。

・false:プライバシーを無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

privacyProtocol

enum

プライバシー用のプロトコル。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

(指定可能な値は「列挙型一覧」のPrivacyProtocolの表を参照してください。)

以下に示す値のみ指定可能です。

DES

AES128

numOfRelatedResources

int

認証情報を用いて発見されたリソースの数。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/Credentials HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 05:21:49 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 1d392a3baad40eab4e3a05ad6e71e3a1fcd577_Vlo8Y30Idn8EY0BdB3IEfwgabiA=_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "instanceID" : 5,
    "name" : "smis",
    "credentialType" : "WBEM",
    "userId" : "smis",
    "portNumber" : 5989,
    "ssl" : true,
    "namespace" : "root/smis/current",
    "numOfRelatedResources" : 0
  }, {
    "instanceID" : 4,
    "name" : "snmpv3",
    "credentialType" : "SNMP",
    "userId" : "snmp",
    "portNumber" : 161,
    "community" : "",
    "snmpVersion" : "V3",
    "userName" : "snmp",
    "authenticationEnabled" : true,
    "authenticationProtocol" : "MD5",
    "privacyEnabled" : true,
    "privacyProtocol" : "DES",
    "numOfRelatedResources" : 0
  }, {
    "instanceID" : 3,
    "name" : "snmpv1",
    "credentialType" : "SNMP",
    "portNumber" : 161,
    "community" : "public",
    "snmpVersion" : "V1_V2C",
    "numOfRelatedResources" : 0
  }, {
    "instanceID" : 2,
    "name" : "ssh",
    "credentialType" : "SSH",
    "userId" : "ssh",
    "portNumber" : 22,
    "numOfRelatedResources" : 0
  }, {
    "instanceID" : 1,
    "name" : "wmi",
    "credentialType" : "WMI",
    "userId" : "wmi",
    "domainname" : "workspace",
    "numOfRelatedResources" : 0
  } ],
  "count" : 5
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.1.2　認証情報の情報取得

指定した認証情報を取得します。

権限

Admin

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/Credentials/{id}

リクエストボディー

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

レスポンスボディー

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

Credential

{
        "instanceID":"...",
        "name":"...",
        "credentialType":"...",
        "userId":"...",
        "passwordNotRequired":"...",
        "portNumber":"...",
        "ssl":"...",
        "domainname":"...",
        "namespace":"...",
        "community":"...",
        "snmpVersion":"...",
        "userName":"...",
        "authenticationEnabled":"...",
        "authenticationProtocol":"...",
        "privacyEnabled":"...",
        "privacyProtocol":"...",
        "numOfRelatedResources":"..."
}

Credential (Type: Credential)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

name

string

認証情報の名称

credentialType

enum

監視対象への接続に使用するプロトコル。

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

WMI

SSH

WBEM

SNMP

userId

string

認証時に指定するユーザーID。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合，”username”メンバーの値が設定されます。

passwordNotRequired

boolean

認証時にパスワードを必要とするかどうか。省略時はfalseが指定されます。監視対象への接続に「WMI」を使用する場合のみ有効です。

・true:パスワードは必要ない。

・false:パスワードが必要である。

portNumber

int

ポート番号。監視対象への接続に使用するプロトコルが「ssh」，「SMI-S WBEM」，「SNMP」の場合のみ設定されます。

ssl

boolean

監視対象への接続時にSSL(https)を使用するかどうか。

・true:SSLを使用する。

・false:SSLを使用する。

省略時はfalseが指定されます。監視対象への接続に「SMI-S WBEM」を使用する場合のみ有効です。

domainname

string

ドメイン名。監視対象への接続に「WMI」を使用する場合のみ設定されます。

namespace

string

ネームスペース。監視対象への接続に「SMI-S WBEM」を使用する場合のみ設定されます。

community

string

コミュニティ名。監視対象への接続に「SNMP」を使用する場合のみ設定されます。

snmpVersion

enum

SNMPのバージョン。監視対象への接続に「SNMP」を使用する場合のみ設定されます。

(指定可能な値は「列挙型一覧」のSnmpVersionの表を参照してください。)

以下に示す値のみ指定可能です。

V1_V2C

V3

userName

string

認証時に使用するユーザー名。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationEnabled

boolean

SMTP認証を行うかどうか。

・true:認証を有効にする。

・false:認証を無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationProtocol

enum

認証用のプロトコル。 監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

(指定可能な値は「列挙型一覧」のAuthenticationProtocolの表を参照してください。)

以下に示す値のみ指定可能です。

MD5

SHA1

privacyEnabled

boolean

プライバシーを有効にするかどうか。

・true:プライバシーを有効にする。

・false:プライバシーを無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

privacyProtocol

enum

プライバシー用のプロトコル。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

(指定可能な値は「列挙型一覧」のPrivacyProtocolの表を参照してください。)

以下に示す値のみ指定可能です。

DES

AES128

numOfRelatedResources

int

認証情報を用いて発見されたリソースの数。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/Credentials/1 HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 07:19:44 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO c0e8bc66dc88c9cd2bc76bb834cbc281e5358_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : 1,
  "name" : "aaa",
  "credentialType" : "WMI",
  "userId" : "aaaa",
  "domainname" : "hogehoge",
  "numOfRelatedResources" : 0
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.1.3　認証情報の作成

認証情報を新規に作成します。

権限

Admin

APIのバージョン

v1

リクエスト形式

POST http[s]://host:port/Analytics/version/objects/Credentials

リクエストボディー

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

Credential

{
        "name":"...",
        "credentialType":"...",
        "userId":"...",
        "password":"...",
        "passwordNotRequired":"...",
        "portNumber":"...",
        "rootPassword":"...",
        "updatePassword":"...",
        "updateRootPassword":"...",
        "ssl":"...",
        "domainname":"...",
        "namespace":"...",
        "community":"...",
        "snmpVersion":"...",
        "userName":"...",
        "authenticationEnabled":"...",
        "authenticationPassphrase":"...",
        "updateAuthenticationPassphrase":"...",
        "authenticationProtocol":"...",
        "privacyEnabled":"...",
        "privacyPassphrase":"...",
        "updatePrivacyPassphrase":"...",
        "privacyProtocol":"..."
}

Credential (Type: Credential)

属性

データ型

説明

name

string

認証情報の名称

credentialType

enum

監視対象への接続に使用するプロトコル。

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

WMI

SSH

WBEM

SNMP

userId

string

認証時に指定するユーザーID。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合，”username”メンバーの値が設定されます。

password

string

認証時に使用するパスワード。255byte以下の文字列をBase64にエンコードして指定します。更新する場合は、updatePasswordにtrueを指定します。

passwordNotRequired

boolean

認証時にパスワードを必要とするかどうか。省略時はfalseが指定されます。監視対象への接続に「WMI」を使用する場合のみ有効です。

・true:パスワードは必要ない。

・false:パスワードが必要である。

portNumber

int

ポート番号。監視対象への接続に使用するプロトコルが「ssh」，「SMI-S WBEM」，「SNMP」の場合のみ設定されます。

rootPassword

string

認証時に使用するrootパスワード。255byte以下の文字列をBase64にエンコードして指定します。

監視対象への接続に「ssh」を使用する場合のみ有効です。更新する場合は、updateRootPasswordにtrueを指定します。

updatePassword

boolean

パスワード(password)を変更するかどうか。

・true:パスワードの変更を行う。

・false:パスワードの変更を行わない。

省略時はfalseが指定されます。

updateRootPassword

boolean

rootパスワード(rootPassword)を変更するかどうか。

・true:パスワードの変更を行う。

・false:パスワードの変更を行わない。

省略時はfalseが指定されます。

監視対象への接続に「ssh」を使用する場合のみ有効です。

ssl

boolean

監視対象への接続時にSSL(https)を使用するかどうか。

・true:SSLを使用する。

・false:SSLを使用する。

省略時はfalseが指定されます。監視対象への接続に「SMI-S WBEM」を使用する場合のみ有効です。

domainname

string

ドメイン名。監視対象への接続に「WMI」を使用する場合のみ設定されます。

namespace

string

ネームスペース。監視対象への接続に「SMI-S WBEM」を使用する場合のみ設定されます。

community

string

コミュニティ名。監視対象への接続に「SNMP」を使用する場合のみ設定されます。

snmpVersion

enum

SNMPのバージョン。監視対象への接続に「SNMP」を使用する場合のみ設定されます。

(指定可能な値は「列挙型一覧」のSnmpVersionの表を参照してください。)

以下に示す値のみ指定可能です。

V1_V2C

V3

userName

string

認証時に使用するユーザー名。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationEnabled

boolean

SMTP認証を行うかどうか。

・true:認証を有効にする。

・false:認証を無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationPassphrase

string

認証パスフレーズ。255byte以下の文字列をBase64にエンコードして指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。更新する場合は、updateAuthenticationPassphraseにtrueを指定します。

updateAuthenticationPassphrase

boolean

認証パスフレーズを変更するかどうか。

・true:認証パスフレーズの変更を行う。

・false:認証パスフレーズの変更を行わない。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationProtocol

enum

認証用のプロトコル。 監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

(指定可能な値は「列挙型一覧」のAuthenticationProtocolの表を参照してください。)

以下に示す値のみ指定可能です。

MD5

SHA1

privacyEnabled

boolean

プライバシーを有効にするかどうか。

・true:プライバシーを有効にする。

・false:プライバシーを無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

privacyPassphrase

string

プライバシーのためのパスフレーズ。255byte以下の文字列をBase64にエンコードして指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。更新する場合は、updatePrivacyPassphraseにtrueを指定します。

updatePrivacyPassphrase

boolean

プライバシーのためのパスフレーズを変更するかどうか。

・true:パスフレーズを変更する。

・false:パスフレーズを変更しない。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

privacyProtocol

enum

プライバシー用のプロトコル。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

(指定可能な値は「列挙型一覧」のPrivacyProtocolの表を参照してください。)

以下に示す値のみ指定可能です。

DES

AES128

レスポンスボディー

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

Credential

{
        "instanceID":"...",
        "name":"...",
        "credentialType":"...",
        "userId":"...",
        "passwordNotRequired":"...",
        "portNumber":"...",
        "ssl":"...",
        "domainname":"...",
        "namespace":"...",
        "community":"...",
        "snmpVersion":"...",
        "userName":"...",
        "authenticationEnabled":"...",
        "authenticationProtocol":"...",
        "privacyEnabled":"...",
        "privacyProtocol":"...",
        "numOfRelatedResources":"..."
}

Credential (Type: Credential)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

name

string

認証情報の名称

credentialType

enum

監視対象への接続に使用するプロトコル。

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

WMI

SSH

WBEM

SNMP

userId

string

認証時に指定するユーザーID。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合，”username”メンバーの値が設定されます。

passwordNotRequired

boolean

認証時にパスワードを必要とするかどうか。省略時はfalseが指定されます。監視対象への接続に「WMI」を使用する場合のみ有効です。

・true:パスワードは必要ない。

・false:パスワードが必要である。

portNumber

int

ポート番号。監視対象への接続に使用するプロトコルが「ssh」，「SMI-S WBEM」，「SNMP」の場合のみ設定されます。

ssl

boolean

監視対象への接続時にSSL(https)を使用するかどうか。

・true:SSLを使用する。

・false:SSLを使用する。

省略時はfalseが指定されます。監視対象への接続に「SMI-S WBEM」を使用する場合のみ有効です。

domainname

string

ドメイン名。監視対象への接続に「WMI」を使用する場合のみ設定されます。

namespace

string

ネームスペース。監視対象への接続に「SMI-S WBEM」を使用する場合のみ設定されます。

community

string

コミュニティ名。監視対象への接続に「SNMP」を使用する場合のみ設定されます。

snmpVersion

enum

SNMPのバージョン。監視対象への接続に「SNMP」を使用する場合のみ設定されます。

(指定可能な値は「列挙型一覧」のSnmpVersionの表を参照してください。)

以下に示す値のみ指定可能です。

V1_V2C

V3

userName

string

認証時に使用するユーザー名。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationEnabled

boolean

SMTP認証を行うかどうか。

・true:認証を有効にする。

・false:認証を無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationProtocol

enum

認証用のプロトコル。 監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

(指定可能な値は「列挙型一覧」のAuthenticationProtocolの表を参照してください。)

以下に示す値のみ指定可能です。

MD5

SHA1

privacyEnabled

boolean

プライバシーを有効にするかどうか。

・true:プライバシーを有効にする。

・false:プライバシーを無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

privacyProtocol

enum

プライバシー用のプロトコル。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

(指定可能な値は「列挙型一覧」のPrivacyProtocolの表を参照してください。)

以下に示す値のみ指定可能です。

DES

AES128

numOfRelatedResources

int

認証情報を用いて発見されたリソースの数。

ステータスコード

HTTPステータスコード

Reason phrase

説明

201

Created

正常終了

400

Bad Request

リクエストボディ形式不正

401

Unauthorized

ログイン権限がない

403

Forbidden

作成権限がない

409

Conflict

nameが一致するリソースが存在する

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
POST http://localhost:22015/Analytics/v1/objects/Credentials HTTP/1.1
Host: localhost:22015
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Request Body]
{
  "name": "windows-001",
   "credentialType": "WMI",
   "userId": "admin",
   "password": "cGFzc3dvcmQ=",
   "passwordNotRequired": "false",
   "domainname": ""
}

[Response Header]
HTTP/1.1 201 Created
Date: Wed, 07 Dec 2016 10:25:35 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 492298acc985fe9bf3099a9ca1e52548c6c8cdb_Vlo8Y30Idn8EY0BdB3IEfwgabiA=_V0810
Location: http://localhost:22015/Analytics/v1/objects/Credentials/7
X-Frame-Options: SAMEORIGIN
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Type: application/json

[Response Body]
{
  "instanceID" : 7,
  "name" : "windows-001",
  "credentialType" : "WMI",
  "userId" : "admin",
  "passwordNotRequired" : false,
  "domainname" : "",
  "numOfRelatedResources" : 0
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.1.4　認証情報の更新

指定した認証情報に含まれるユーザーIDとパスワードの更新を行います。

権限

Admin

APIのバージョン

v1

リクエスト形式

PUT http[s]://host:port/Analytics/version/objects/Credentials/{id}

リクエストボディー

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

Credential

{
        "name":"...",
        "credentialType":"...",
        "userId":"...",
        "password":"...",
        "passwordNotRequired":"...",
        "portNumber":"...",
        "rootPassword":"...",
        "updatePassword":"...",
        "updateRootPassword":"...",
        "ssl":"...",
        "domainname":"...",
        "namespace":"...",
        "community":"...",
        "snmpVersion":"...",
        "userName":"...",
        "authenticationEnabled":"...",
        "authenticationPassphrase":"...",
        "updateAuthenticationPassphrase":"...",
        "authenticationProtocol":"...",
        "privacyEnabled":"...",
        "privacyPassphrase":"...",
        "updatePrivacyPassphrase":"...",
        "privacyProtocol":"..."
}

Credential (Type: Credential)

属性

データ型

説明

name

string

認証情報の名称

credentialType

enum

監視対象への接続に使用するプロトコル。

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

WMI

SSH

WBEM

SNMP

userId

string

認証時に指定するユーザーID。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合，”username”メンバーの値が設定されます。

password

string

認証時に使用するパスワード。255byte以下の文字列をBase64にエンコードして指定します。更新する場合は、updatePasswordにtrueを指定します。

passwordNotRequired

boolean

認証時にパスワードを必要とするかどうか。省略時はfalseが指定されます。監視対象への接続に「WMI」を使用する場合のみ有効です。

・true:パスワードは必要ない。

・false:パスワードが必要である。

portNumber

int

ポート番号。監視対象への接続に使用するプロトコルが「ssh」，「SMI-S WBEM」，「SNMP」の場合のみ設定されます。

rootPassword

string

認証時に使用するrootパスワード。255byte以下の文字列をBase64にエンコードして指定します。

監視対象への接続に「ssh」を使用する場合のみ有効です。更新する場合は、updateRootPasswordにtrueを指定します。

updatePassword

boolean

パスワード(password)を変更するかどうか。

・true:パスワードの変更を行う。

・false:パスワードの変更を行わない。

省略時はfalseが指定されます。

updateRootPassword

boolean

rootパスワード(rootPassword)を変更するかどうか。

・true:パスワードの変更を行う。

・false:パスワードの変更を行わない。

省略時はfalseが指定されます。

監視対象への接続に「ssh」を使用する場合のみ有効です。

ssl

boolean

監視対象への接続時にSSL(https)を使用するかどうか。

・true:SSLを使用する。

・false:SSLを使用する。

省略時はfalseが指定されます。監視対象への接続に「SMI-S WBEM」を使用する場合のみ有効です。

domainname

string

ドメイン名。監視対象への接続に「WMI」を使用する場合のみ設定されます。

namespace

string

ネームスペース。監視対象への接続に「SMI-S WBEM」を使用する場合のみ設定されます。

community

string

コミュニティ名。監視対象への接続に「SNMP」を使用する場合のみ設定されます。

snmpVersion

enum

SNMPのバージョン。監視対象への接続に「SNMP」を使用する場合のみ設定されます。

(指定可能な値は「列挙型一覧」のSnmpVersionの表を参照してください。)

以下に示す値のみ指定可能です。

V1_V2C

V3

userName

string

認証時に使用するユーザー名。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationEnabled

boolean

SMTP認証を行うかどうか。

・true:認証を有効にする。

・false:認証を無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationPassphrase

string

認証パスフレーズ。255byte以下の文字列をBase64にエンコードして指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。更新する場合は、updateAuthenticationPassphraseにtrueを指定します。

updateAuthenticationPassphrase

boolean

認証パスフレーズを変更するかどうか。

・true:認証パスフレーズの変更を行う。

・false:認証パスフレーズの変更を行わない。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationProtocol

enum

認証用のプロトコル。 監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

(指定可能な値は「列挙型一覧」のAuthenticationProtocolの表を参照してください。)

以下に示す値のみ指定可能です。

MD5

SHA1

privacyEnabled

boolean

プライバシーを有効にするかどうか。

・true:プライバシーを有効にする。

・false:プライバシーを無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

privacyPassphrase

string

プライバシーのためのパスフレーズ。255byte以下の文字列をBase64にエンコードして指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。更新する場合は、updatePrivacyPassphraseにtrueを指定します。

updatePrivacyPassphrase

boolean

プライバシーのためのパスフレーズを変更するかどうか。

・true:パスフレーズを変更する。

・false:パスフレーズを変更しない。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

privacyProtocol

enum

プライバシー用のプロトコル。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

(指定可能な値は「列挙型一覧」のPrivacyProtocolの表を参照してください。)

以下に示す値のみ指定可能です。

DES

AES128

レスポンスボディー

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

Credential

{
        "instanceID":"...",
        "name":"...",
        "credentialType":"...",
        "userId":"...",
        "passwordNotRequired":"...",
        "portNumber":"...",
        "ssl":"...",
        "domainname":"...",
        "namespace":"...",
        "community":"...",
        "snmpVersion":"...",
        "userName":"...",
        "authenticationEnabled":"...",
        "authenticationProtocol":"...",
        "privacyEnabled":"...",
        "privacyProtocol":"...",
        "numOfRelatedResources":"..."
}

Credential (Type: Credential)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

name

string

認証情報の名称

credentialType

enum

監視対象への接続に使用するプロトコル。

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

WMI

SSH

WBEM

SNMP

userId

string

認証時に指定するユーザーID。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合，”username”メンバーの値が設定されます。

passwordNotRequired

boolean

認証時にパスワードを必要とするかどうか。省略時はfalseが指定されます。監視対象への接続に「WMI」を使用する場合のみ有効です。

・true:パスワードは必要ない。

・false:パスワードが必要である。

portNumber

int

ポート番号。監視対象への接続に使用するプロトコルが「ssh」，「SMI-S WBEM」，「SNMP」の場合のみ設定されます。

ssl

boolean

監視対象への接続時にSSL(https)を使用するかどうか。

・true:SSLを使用する。

・false:SSLを使用する。

省略時はfalseが指定されます。監視対象への接続に「SMI-S WBEM」を使用する場合のみ有効です。

domainname

string

ドメイン名。監視対象への接続に「WMI」を使用する場合のみ設定されます。

namespace

string

ネームスペース。監視対象への接続に「SMI-S WBEM」を使用する場合のみ設定されます。

community

string

コミュニティ名。監視対象への接続に「SNMP」を使用する場合のみ設定されます。

snmpVersion

enum

SNMPのバージョン。監視対象への接続に「SNMP」を使用する場合のみ設定されます。

(指定可能な値は「列挙型一覧」のSnmpVersionの表を参照してください。)

以下に示す値のみ指定可能です。

V1_V2C

V3

userName

string

認証時に使用するユーザー名。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationEnabled

boolean

SMTP認証を行うかどうか。

・true:認証を有効にする。

・false:認証を無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationProtocol

enum

認証用のプロトコル。 監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

(指定可能な値は「列挙型一覧」のAuthenticationProtocolの表を参照してください。)

以下に示す値のみ指定可能です。

MD5

SHA1

privacyEnabled

boolean

プライバシーを有効にするかどうか。

・true:プライバシーを有効にする。

・false:プライバシーを無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

privacyProtocol

enum

プライバシー用のプロトコル。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

(指定可能な値は「列挙型一覧」のPrivacyProtocolの表を参照してください。)

以下に示す値のみ指定可能です。

DES

AES128

numOfRelatedResources

int

認証情報を用いて発見されたリソースの数。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

400

Bad Request

リクエストボディ形式不正

401

Unauthorized

ログイン権限がない

403

Forbidden

更新権限がない

404

Not Found

リソースが存在しない

409

Conflict

nameが一致するリソースが存在する

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
PUT /Analytics/v1/objects/Credentials/13 HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 256

[Request Body]
{
  "instanceID" : 13,
  "name" : "WindowsMonitoring",
  "credentialType" : "WMI",
  "userId" : "Administrator",
  "passwordNotRequired" : false,
  "updatePassword" : true,
  "password" : "c3lzdGVtOm1hbmFnZXI=",
  "domainname" : "domain",
  "numOfRelatedResources" : 0
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 08:42:45 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 4afe674fe8a4e569aa824d8786b0ac5b53e4a_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : 13,
  "name" : "WindowsMonitoring",
  "credentialType" : "WMI",
  "userId" : "Administrator",
  "passwordNotRequired" : false,
  "domainname" : "domain",
  "numOfRelatedResources" : 0
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.1.5　認証情報の削除

指定した認証情報を削除します。

権限

Admin

APIのバージョン

v1

リクエスト形式

DELETE http[s]://host:port/Analytics/version/objects/Credentials/{id}

リクエストボディー

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

レスポンスボディー

レスポンスボディーは出力されません。

ステータスコード

HTTPステータスコード

Reason phrase

説明

204

No Content

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

削除権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
DELETE http://localhost:22015/Analytics/v1/objects/Credentials/7 HTTP/1.1
Host: localhost:22015
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Response Header]
HTTP/1.1 204 No Content
Date: Wed, 07 Dec 2016 10:26:30 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 7d842f5055c8b12c777296e3cd4f756ace9b528_Vlo8Y30Idn8EY0BdB3IEfwgabiA=_V0810
X-Frame-Options: SAMEORIGIN
Content-Length: 0
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Type: application/json

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.2　管理対象探索に関するAPI一覧

管理対象探索設定の操作を説明します。

2.2.1　探索範囲の一覧の取得

JP1/OAが監視対象の探索で使用する探索範囲の一覧を取得します。

権限

Admin

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/IpAddrRanges

リクエストボディー

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

レスポンスボディー

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

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性

データ型

説明

data

anyType[]

IPAddrRange のコレクション。 IPAddrRange の詳細は以下の表を参照ください。

pagination

Pagination

ページ情報。リソースが存在しない場合、このパラメータは表示されません。

count

int

条件に合致したデータの個数

pagination (Type: Pagination)

属性

データ型

説明

page

integer

ページ

pageSize

integer

ページサイズ

numPages

integer

ページの数

totalCount

integer

オブジェクトの数

IPAddrRange

{
        "instanceID":"...",
        "name":"...",
        "ipAddrRange":["...", ...],
        "usePing":"...",
        "useAllCredential":"...",
        "selectedCredentials":[{
            "instanceID":"...",
            "name":"...",
            "credentialType":"...",
            "userId":"...",
            "passwordNotRequired":"...",
            "portNumber":"...",
            "ssl":"...",
            "domainname":"...",
            "namespace":"...",
            "community":"...",
            "snmpVersion":"...",
            "userName":"...",
            "authenticationEnabled":"...",
            "authenticationProtocol":"...",
            "privacyEnabled":"...",
            "privacyProtocol":"...",
            "numOfRelatedResources":"..."
        },
        :
        ],
        "deviceClassificationLabel":"..."
}

IPAddrRange (Type: IPAddrRange)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

name

string

探索範囲の名称

ipAddrRange

string[]

探索範囲を指定します。リストの0番目に探索開始IPアドレス、リストの1番目に探索終了IPアドレスが設定されます。

usePing

boolean

探索実行時に、対象機器に対してpingを実施するかどうかを指定します。

・true: pingを使用します。

・false: pingを使用しません

useAllCredential

boolean

すべての Credential を使用するかどうかのフラグ。"すべて"の Credential を使用する場合はtrueを指定します。

selectedCredentials

Credential[]

探索に使用する認証情報のリスト

deviceClassificationLabel

string

機器に割り当てられた分類ラベル

selectedCredentials (Type: Credential)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

name

string

認証情報の名称

credentialType

enum

監視対象への接続に使用するプロトコル。

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

WMI

SSH

WBEM

SNMP

userId

string

認証時に指定するユーザーID。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合，”username”メンバーの値が設定されます。

passwordNotRequired

boolean

認証時にパスワードを必要とするかどうか。省略時はfalseが指定されます。監視対象への接続に「WMI」を使用する場合のみ有効です。

・true:パスワードは必要ない。

・false:パスワードが必要である。

portNumber

int

ポート番号。監視対象への接続に使用するプロトコルが「ssh」，「SMI-S WBEM」，「SNMP」の場合のみ設定されます。

ssl

boolean

監視対象への接続時にSSL(https)を使用するかどうか。

・true:SSLを使用する。

・false:SSLを使用する。

省略時はfalseが指定されます。監視対象への接続に「SMI-S WBEM」を使用する場合のみ有効です。

domainname

string

ドメイン名。監視対象への接続に「WMI」を使用する場合のみ設定されます。

namespace

string

ネームスペース。監視対象への接続に「SMI-S WBEM」を使用する場合のみ設定されます。

community

string

コミュニティ名。監視対象への接続に「SNMP」を使用する場合のみ設定されます。

snmpVersion

enum

SNMPのバージョン。監視対象への接続に「SNMP」を使用する場合のみ設定されます。

(指定可能な値は「列挙型一覧」のSnmpVersionの表を参照してください。)

以下に示す値のみ指定可能です。

V1_V2C

V3

userName

string

認証時に使用するユーザー名。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationEnabled

boolean

SMTP認証を行うかどうか。

・true:認証を有効にする。

・false:認証を無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationProtocol

enum

認証用のプロトコル。 監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

(指定可能な値は「列挙型一覧」のAuthenticationProtocolの表を参照してください。)

以下に示す値のみ指定可能です。

MD5

SHA1

privacyEnabled

boolean

プライバシーを有効にするかどうか。

・true:プライバシーを有効にする。

・false:プライバシーを無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

privacyProtocol

enum

プライバシー用のプロトコル。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

(指定可能な値は「列挙型一覧」のPrivacyProtocolの表を参照してください。)

以下に示す値のみ指定可能です。

DES

AES128

numOfRelatedResources

int

認証情報を用いて発見されたリソースの数。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET http://localhost:22015/Analytics/v1/objects/IpAddrRanges/ HTTP/1.1
Host: localhost:22015
User-Agent: curl/7.33.0
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Response Header]
HTTP/1.1 200 OK
Date: Wed, 07 Dec 2016 09:58:26 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 2d4c182d7464f34a4e9bc256db5f543f66efac9e_Vlo8Y30Idn8EY0BdB3IEfwgabiA=_V0810
X-Frame-Options: SAMEORIGIN
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Type: application/json
Content-Length: 242

[Response Body]
{
  "data" : [ {
    "instanceID" : 0,
    "name" : "IP Range-0",
    "ipAddrRange" : [ "255.255.255.0", "255.255.255.0" ],
    "usePing" : true,
    "useAllCredential" : false,
    "selectedCredentials" : [ ]
  } ,
  {
    "instanceID" : 1,
    "name" : "IP Range-1",
    "ipAddrRange" : [ "192.168.1.0", "192.168.1.254" ],
    "usePing" : true,
    "useAllCredential" : false,
    "selectedCredentials" : [
        {
            "instanceID": 3,
            "name": "WMI2_Cloud",
            "credentialType": "WMI",
            "userId": "Administrator",
            "passwordNotRequired": false,
            "domainname": "",
            "numOfRelatedResources": 3
        }
    ],
    "deviceClassificationLabel": "Cloud Env"
  }],
  "count" : 2
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.2.2　探索範囲の情報取得

指定した探索範囲を取得します。

権限

Admin

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/IpAddrRanges/{id}

リクエストボディー

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

レスポンスボディー

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

IPAddrRange

{
        "instanceID":"...",
        "name":"...",
        "ipAddrRange":["...", ...],
        "usePing":"...",
        "useAllCredential":"...",
        "selectedCredentials":[{
            "instanceID":"...",
            "name":"...",
            "credentialType":"...",
            "userId":"...",
            "passwordNotRequired":"...",
            "portNumber":"...",
            "ssl":"...",
            "domainname":"...",
            "namespace":"...",
            "community":"...",
            "snmpVersion":"...",
            "userName":"...",
            "authenticationEnabled":"...",
            "authenticationProtocol":"...",
            "privacyEnabled":"...",
            "privacyProtocol":"...",
            "numOfRelatedResources":"..."
        },
        :
        ],
        "deviceClassificationLabel":"..."
}

IPAddrRange (Type: IPAddrRange)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

name

string

探索範囲の名称

ipAddrRange

string[]

探索範囲を指定します。リストの0番目に探索開始IPアドレス、リストの1番目に探索終了IPアドレスが設定されます。

usePing

boolean

探索実行時に、対象機器に対してpingを実施するかどうかを指定します。

・true: pingを使用します。

・false: pingを使用しません

useAllCredential

boolean

すべての Credential を使用するかどうかのフラグ。"すべて"の Credential を使用する場合はtrueを指定します。

selectedCredentials

Credential[]

探索に使用する認証情報のリスト

deviceClassificationLabel

string

機器に割り当てられた分類ラベル

selectedCredentials (Type: Credential)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

name

string

認証情報の名称

credentialType

enum

監視対象への接続に使用するプロトコル。

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

WMI

SSH

WBEM

SNMP

userId

string

認証時に指定するユーザーID。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合，”username”メンバーの値が設定されます。

passwordNotRequired

boolean

認証時にパスワードを必要とするかどうか。省略時はfalseが指定されます。監視対象への接続に「WMI」を使用する場合のみ有効です。

・true:パスワードは必要ない。

・false:パスワードが必要である。

portNumber

int

ポート番号。監視対象への接続に使用するプロトコルが「ssh」，「SMI-S WBEM」，「SNMP」の場合のみ設定されます。

ssl

boolean

監視対象への接続時にSSL(https)を使用するかどうか。

・true:SSLを使用する。

・false:SSLを使用する。

省略時はfalseが指定されます。監視対象への接続に「SMI-S WBEM」を使用する場合のみ有効です。

domainname

string

ドメイン名。監視対象への接続に「WMI」を使用する場合のみ設定されます。

namespace

string

ネームスペース。監視対象への接続に「SMI-S WBEM」を使用する場合のみ設定されます。

community

string

コミュニティ名。監視対象への接続に「SNMP」を使用する場合のみ設定されます。

snmpVersion

enum

SNMPのバージョン。監視対象への接続に「SNMP」を使用する場合のみ設定されます。

(指定可能な値は「列挙型一覧」のSnmpVersionの表を参照してください。)

以下に示す値のみ指定可能です。

V1_V2C

V3

userName

string

認証時に使用するユーザー名。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationEnabled

boolean

SMTP認証を行うかどうか。

・true:認証を有効にする。

・false:認証を無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationProtocol

enum

認証用のプロトコル。 監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

(指定可能な値は「列挙型一覧」のAuthenticationProtocolの表を参照してください。)

以下に示す値のみ指定可能です。

MD5

SHA1

privacyEnabled

boolean

プライバシーを有効にするかどうか。

・true:プライバシーを有効にする。

・false:プライバシーを無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

privacyProtocol

enum

プライバシー用のプロトコル。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

(指定可能な値は「列挙型一覧」のPrivacyProtocolの表を参照してください。)

以下に示す値のみ指定可能です。

DES

AES128

numOfRelatedResources

int

認証情報を用いて発見されたリソースの数。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET http://localhost:22015/Analytics/v1/objects/IpAddrRanges/50 HTTP/1.1
Host: localhost:22015
User-Agent: curl/7.33.0
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Response Header]
HTTP/1.1 200 OK
Date: Wed, 07 Dec 2016 10:02:50 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 684796b49f478df4995ed24766979cff90f05ea9_Vlo8Y30Idn8EY0BdB3IEfwgabiA=_V0810
X-Frame-Options: SAMEORIGIN
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Type: application/json

[Response Body]
{
  "instanceID" : 50,
  "name" : "IP Addr Range 01",
  "ipAddrRange" : [ "192.168.0.110", "192.168.0.118" ],
  "usePing" : true,
  "useAllCredential" : false,
  "selectedCredentials" : [ ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.2.3　探索範囲の作成

探索範囲を新規に作成します。

権限

Admin

APIのバージョン

v1

リクエスト形式

POST http[s]://host:port/Analytics/version/objects/IpAddrRanges

リクエストボディー

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

IPAddrRange

{
        "name":"...",
        "ipAddrRange":["...", ...],
        "usePing":"...",
        "useAllCredential":"...",
        "selectedCredentials":[{
            "name":"...",
            "credentialType":"...",
            "userId":"...",
            "password":"...",
            "passwordNotRequired":"...",
            "portNumber":"...",
            "rootPassword":"...",
            "updatePassword":"...",
            "updateRootPassword":"...",
            "ssl":"...",
            "domainname":"...",
            "namespace":"...",
            "community":"...",
            "snmpVersion":"...",
            "userName":"...",
            "authenticationEnabled":"...",
            "authenticationPassphrase":"...",
            "updateAuthenticationPassphrase":"...",
            "authenticationProtocol":"...",
            "privacyEnabled":"...",
            "privacyPassphrase":"...",
            "updatePrivacyPassphrase":"...",
            "privacyProtocol":"..."
        },
        :
        ],
        "deviceClassificationLabel":"..."
}

IPAddrRange (Type: IPAddrRange)

属性

データ型

説明

name

string

探索範囲の名称

ipAddrRange

string[]

探索範囲を指定します。リストの0番目に探索開始IPアドレス、リストの1番目に探索終了IPアドレスが設定されます。

usePing

boolean

探索実行時に、対象機器に対してpingを実施するかどうかを指定します。

・true: pingを使用します。

・false: pingを使用しません

useAllCredential

boolean

すべての Credential を使用するかどうかのフラグ。"すべて"の Credential を使用する場合はtrueを指定します。

selectedCredentials

Credential[]

探索に使用する認証情報のリスト

deviceClassificationLabel

string

機器に割り当てられた分類ラベル

selectedCredentials (Type: Credential)

属性

データ型

説明

name

string

認証情報の名称

credentialType

enum

監視対象への接続に使用するプロトコル。

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

WMI

SSH

WBEM

SNMP

userId

string

認証時に指定するユーザーID。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合，”username”メンバーの値が設定されます。

password

string

認証時に使用するパスワード。255byte以下の文字列をBase64にエンコードして指定します。更新する場合は、updatePasswordにtrueを指定します。

passwordNotRequired

boolean

認証時にパスワードを必要とするかどうか。省略時はfalseが指定されます。監視対象への接続に「WMI」を使用する場合のみ有効です。

・true:パスワードは必要ない。

・false:パスワードが必要である。

portNumber

int

ポート番号。監視対象への接続に使用するプロトコルが「ssh」，「SMI-S WBEM」，「SNMP」の場合のみ設定されます。

rootPassword

string

認証時に使用するrootパスワード。255byte以下の文字列をBase64にエンコードして指定します。

監視対象への接続に「ssh」を使用する場合のみ有効です。更新する場合は、updateRootPasswordにtrueを指定します。

updatePassword

boolean

パスワード(password)を変更するかどうか。

・true:パスワードの変更を行う。

・false:パスワードの変更を行わない。

省略時はfalseが指定されます。

updateRootPassword

boolean

rootパスワード(rootPassword)を変更するかどうか。

・true:パスワードの変更を行う。

・false:パスワードの変更を行わない。

省略時はfalseが指定されます。

監視対象への接続に「ssh」を使用する場合のみ有効です。

ssl

boolean

監視対象への接続時にSSL(https)を使用するかどうか。

・true:SSLを使用する。

・false:SSLを使用する。

省略時はfalseが指定されます。監視対象への接続に「SMI-S WBEM」を使用する場合のみ有効です。

domainname

string

ドメイン名。監視対象への接続に「WMI」を使用する場合のみ設定されます。

namespace

string

ネームスペース。監視対象への接続に「SMI-S WBEM」を使用する場合のみ設定されます。

community

string

コミュニティ名。監視対象への接続に「SNMP」を使用する場合のみ設定されます。

snmpVersion

enum

SNMPのバージョン。監視対象への接続に「SNMP」を使用する場合のみ設定されます。

(指定可能な値は「列挙型一覧」のSnmpVersionの表を参照してください。)

以下に示す値のみ指定可能です。

V1_V2C

V3

userName

string

認証時に使用するユーザー名。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationEnabled

boolean

SMTP認証を行うかどうか。

・true:認証を有効にする。

・false:認証を無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationPassphrase

string

認証パスフレーズ。255byte以下の文字列をBase64にエンコードして指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。更新する場合は、updateAuthenticationPassphraseにtrueを指定します。

updateAuthenticationPassphrase

boolean

認証パスフレーズを変更するかどうか。

・true:認証パスフレーズの変更を行う。

・false:認証パスフレーズの変更を行わない。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationProtocol

enum

認証用のプロトコル。 監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

(指定可能な値は「列挙型一覧」のAuthenticationProtocolの表を参照してください。)

以下に示す値のみ指定可能です。

MD5

SHA1

privacyEnabled

boolean

プライバシーを有効にするかどうか。

・true:プライバシーを有効にする。

・false:プライバシーを無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

privacyPassphrase

string

プライバシーのためのパスフレーズ。255byte以下の文字列をBase64にエンコードして指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。更新する場合は、updatePrivacyPassphraseにtrueを指定します。

updatePrivacyPassphrase

boolean

プライバシーのためのパスフレーズを変更するかどうか。

・true:パスフレーズを変更する。

・false:パスフレーズを変更しない。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

privacyProtocol

enum

プライバシー用のプロトコル。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

(指定可能な値は「列挙型一覧」のPrivacyProtocolの表を参照してください。)

以下に示す値のみ指定可能です。

DES

AES128

レスポンスボディー

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

IPAddrRange

{
        "instanceID":"...",
        "name":"...",
        "ipAddrRange":["...", ...],
        "usePing":"...",
        "useAllCredential":"...",
        "selectedCredentials":[{
            "instanceID":"...",
            "name":"...",
            "credentialType":"...",
            "userId":"...",
            "passwordNotRequired":"...",
            "portNumber":"...",
            "ssl":"...",
            "domainname":"...",
            "namespace":"...",
            "community":"...",
            "snmpVersion":"...",
            "userName":"...",
            "authenticationEnabled":"...",
            "authenticationProtocol":"...",
            "privacyEnabled":"...",
            "privacyProtocol":"...",
            "numOfRelatedResources":"..."
        },
        :
        ],
        "deviceClassificationLabel":"..."
}

IPAddrRange (Type: IPAddrRange)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

name

string

探索範囲の名称

ipAddrRange

string[]

探索範囲を指定します。リストの0番目に探索開始IPアドレス、リストの1番目に探索終了IPアドレスが設定されます。

usePing

boolean

探索実行時に、対象機器に対してpingを実施するかどうかを指定します。

・true: pingを使用します。

・false: pingを使用しません

useAllCredential

boolean

すべての Credential を使用するかどうかのフラグ。"すべて"の Credential を使用する場合はtrueを指定します。

selectedCredentials

Credential[]

探索に使用する認証情報のリスト

deviceClassificationLabel

string

機器に割り当てられた分類ラベル

selectedCredentials (Type: Credential)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

name

string

認証情報の名称

credentialType

enum

監視対象への接続に使用するプロトコル。

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

WMI

SSH

WBEM

SNMP

userId

string

認証時に指定するユーザーID。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合，”username”メンバーの値が設定されます。

passwordNotRequired

boolean

認証時にパスワードを必要とするかどうか。省略時はfalseが指定されます。監視対象への接続に「WMI」を使用する場合のみ有効です。

・true:パスワードは必要ない。

・false:パスワードが必要である。

portNumber

int

ポート番号。監視対象への接続に使用するプロトコルが「ssh」，「SMI-S WBEM」，「SNMP」の場合のみ設定されます。

ssl

boolean

監視対象への接続時にSSL(https)を使用するかどうか。

・true:SSLを使用する。

・false:SSLを使用する。

省略時はfalseが指定されます。監視対象への接続に「SMI-S WBEM」を使用する場合のみ有効です。

domainname

string

ドメイン名。監視対象への接続に「WMI」を使用する場合のみ設定されます。

namespace

string

ネームスペース。監視対象への接続に「SMI-S WBEM」を使用する場合のみ設定されます。

community

string

コミュニティ名。監視対象への接続に「SNMP」を使用する場合のみ設定されます。

snmpVersion

enum

SNMPのバージョン。監視対象への接続に「SNMP」を使用する場合のみ設定されます。

(指定可能な値は「列挙型一覧」のSnmpVersionの表を参照してください。)

以下に示す値のみ指定可能です。

V1_V2C

V3

userName

string

認証時に使用するユーザー名。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationEnabled

boolean

SMTP認証を行うかどうか。

・true:認証を有効にする。

・false:認証を無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationProtocol

enum

認証用のプロトコル。 監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

(指定可能な値は「列挙型一覧」のAuthenticationProtocolの表を参照してください。)

以下に示す値のみ指定可能です。

MD5

SHA1

privacyEnabled

boolean

プライバシーを有効にするかどうか。

・true:プライバシーを有効にする。

・false:プライバシーを無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

privacyProtocol

enum

プライバシー用のプロトコル。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

(指定可能な値は「列挙型一覧」のPrivacyProtocolの表を参照してください。)

以下に示す値のみ指定可能です。

DES

AES128

numOfRelatedResources

int

認証情報を用いて発見されたリソースの数。

ステータスコード

HTTPステータスコード

Reason phrase

説明

201

Created

正常終了

400

Bad Request

リクエストボディ形式不正

401

Unauthorized

ログイン権限がない

403

Forbidden

更新権限がない

409

Conflict

nameが一致するリソースが存在する

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
POST http://localhost:22015/Analytics/v1/objects/IpAddrRanges/ HTTP/1.1
Host: localhost:22015
User-Agent: curl/7.33.0
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Request Body]
{
  "name":"IP Addr Range 03",
  "ipAddrRange":["192.168.1.0","192.168.1.110"],
  "usePing":false,
  "useAllCredential":false,
  "selectedCredentials":[
    {"instanceID":14,"name":"ssh_dev_env"}
  ],
  "deviceClassificationLabel":"Linux Development Env"
}

[Response Header]
HTTP/1.1 201 Created
Date: Wed, 07 Dec 2016 10:01:12 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 6e512042356e389d5b981969d46d963c5ef24a_Vlo8Y30Idn8EY0BdB3IEfwgabiA=_V0810
Location: http://localhost:22015/Analytics/v1/objects/IpAddrRanges//50
X-Frame-Options: SAMEORIGIN
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Type: application/json

[Response Body]
{
  "instanceID" : 3,
  "name" : "IP Addr Range 03",
  "ipAddrRange" : [ "192.168.1.0", "192.168.1.110" ],
  "usePing" : false,
  "useAllCredential" : false,
  "selectedCredentials" : [ {
    "instanceID" : 14,
    "name" : "ssh_dev_env",
    "credentialType" : "SSH",
    "userId" : "root",
    "portNumber" : 22,
    "numOfRelatedResources" : 2
  } ],
  "deviceClassificationLabel" : "LInux Development Env"
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.2.4　探索範囲の更新

指定した探索範囲の更新を行います。

権限

Admin

APIのバージョン

v1

リクエスト形式

PUT http[s]://host:port/Analytics/version/objects/IpAddrRanges/{id}

リクエストボディー

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

IPAddrRange

{
        "name":"...",
        "ipAddrRange":["...", ...],
        "usePing":"...",
        "useAllCredential":"...",
        "selectedCredentials":[{
            "name":"...",
            "credentialType":"...",
            "userId":"...",
            "password":"...",
            "passwordNotRequired":"...",
            "portNumber":"...",
            "rootPassword":"...",
            "updatePassword":"...",
            "updateRootPassword":"...",
            "ssl":"...",
            "domainname":"...",
            "namespace":"...",
            "community":"...",
            "snmpVersion":"...",
            "userName":"...",
            "authenticationEnabled":"...",
            "authenticationPassphrase":"...",
            "updateAuthenticationPassphrase":"...",
            "authenticationProtocol":"...",
            "privacyEnabled":"...",
            "privacyPassphrase":"...",
            "updatePrivacyPassphrase":"...",
            "privacyProtocol":"..."
        },
        :
        ],
        "deviceClassificationLabel":"..."
}

IPAddrRange (Type: IPAddrRange)

属性

データ型

説明

name

string

探索範囲の名称

ipAddrRange

string[]

探索範囲を指定します。リストの0番目に探索開始IPアドレス、リストの1番目に探索終了IPアドレスが設定されます。

usePing

boolean

探索実行時に、対象機器に対してpingを実施するかどうかを指定します。

・true: pingを使用します。

・false: pingを使用しません

useAllCredential

boolean

すべての Credential を使用するかどうかのフラグ。"すべて"の Credential を使用する場合はtrueを指定します。

selectedCredentials

Credential[]

探索に使用する認証情報のリスト

deviceClassificationLabel

string

機器に割り当てられた分類ラベル

selectedCredentials (Type: Credential)

属性

データ型

説明

name

string

認証情報の名称

credentialType

enum

監視対象への接続に使用するプロトコル。

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

WMI

SSH

WBEM

SNMP

userId

string

認証時に指定するユーザーID。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合，”username”メンバーの値が設定されます。

password

string

認証時に使用するパスワード。255byte以下の文字列をBase64にエンコードして指定します。更新する場合は、updatePasswordにtrueを指定します。

passwordNotRequired

boolean

認証時にパスワードを必要とするかどうか。省略時はfalseが指定されます。監視対象への接続に「WMI」を使用する場合のみ有効です。

・true:パスワードは必要ない。

・false:パスワードが必要である。

portNumber

int

ポート番号。監視対象への接続に使用するプロトコルが「ssh」，「SMI-S WBEM」，「SNMP」の場合のみ設定されます。

rootPassword

string

認証時に使用するrootパスワード。255byte以下の文字列をBase64にエンコードして指定します。

監視対象への接続に「ssh」を使用する場合のみ有効です。更新する場合は、updateRootPasswordにtrueを指定します。

updatePassword

boolean

パスワード(password)を変更するかどうか。

・true:パスワードの変更を行う。

・false:パスワードの変更を行わない。

省略時はfalseが指定されます。

updateRootPassword

boolean

rootパスワード(rootPassword)を変更するかどうか。

・true:パスワードの変更を行う。

・false:パスワードの変更を行わない。

省略時はfalseが指定されます。

監視対象への接続に「ssh」を使用する場合のみ有効です。

ssl

boolean

監視対象への接続時にSSL(https)を使用するかどうか。

・true:SSLを使用する。

・false:SSLを使用する。

省略時はfalseが指定されます。監視対象への接続に「SMI-S WBEM」を使用する場合のみ有効です。

domainname

string

ドメイン名。監視対象への接続に「WMI」を使用する場合のみ設定されます。

namespace

string

ネームスペース。監視対象への接続に「SMI-S WBEM」を使用する場合のみ設定されます。

community

string

コミュニティ名。監視対象への接続に「SNMP」を使用する場合のみ設定されます。

snmpVersion

enum

SNMPのバージョン。監視対象への接続に「SNMP」を使用する場合のみ設定されます。

(指定可能な値は「列挙型一覧」のSnmpVersionの表を参照してください。)

以下に示す値のみ指定可能です。

V1_V2C

V3

userName

string

認証時に使用するユーザー名。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationEnabled

boolean

SMTP認証を行うかどうか。

・true:認証を有効にする。

・false:認証を無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationPassphrase

string

認証パスフレーズ。255byte以下の文字列をBase64にエンコードして指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。更新する場合は、updateAuthenticationPassphraseにtrueを指定します。

updateAuthenticationPassphrase

boolean

認証パスフレーズを変更するかどうか。

・true:認証パスフレーズの変更を行う。

・false:認証パスフレーズの変更を行わない。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationProtocol

enum

認証用のプロトコル。 監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

(指定可能な値は「列挙型一覧」のAuthenticationProtocolの表を参照してください。)

以下に示す値のみ指定可能です。

MD5

SHA1

privacyEnabled

boolean

プライバシーを有効にするかどうか。

・true:プライバシーを有効にする。

・false:プライバシーを無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

privacyPassphrase

string

プライバシーのためのパスフレーズ。255byte以下の文字列をBase64にエンコードして指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。更新する場合は、updatePrivacyPassphraseにtrueを指定します。

updatePrivacyPassphrase

boolean

プライバシーのためのパスフレーズを変更するかどうか。

・true:パスフレーズを変更する。

・false:パスフレーズを変更しない。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

privacyProtocol

enum

プライバシー用のプロトコル。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

(指定可能な値は「列挙型一覧」のPrivacyProtocolの表を参照してください。)

以下に示す値のみ指定可能です。

DES

AES128

レスポンスボディー

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

IPAddrRange

{
        "instanceID":"...",
        "name":"...",
        "ipAddrRange":["...", ...],
        "usePing":"...",
        "useAllCredential":"...",
        "selectedCredentials":[{
            "instanceID":"...",
            "name":"...",
            "credentialType":"...",
            "userId":"...",
            "passwordNotRequired":"...",
            "portNumber":"...",
            "ssl":"...",
            "domainname":"...",
            "namespace":"...",
            "community":"...",
            "snmpVersion":"...",
            "userName":"...",
            "authenticationEnabled":"...",
            "authenticationProtocol":"...",
            "privacyEnabled":"...",
            "privacyProtocol":"...",
            "numOfRelatedResources":"..."
        },
        :
        ],
        "deviceClassificationLabel":"..."
}

IPAddrRange (Type: IPAddrRange)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

name

string

探索範囲の名称

ipAddrRange

string[]

探索範囲を指定します。リストの0番目に探索開始IPアドレス、リストの1番目に探索終了IPアドレスが設定されます。

usePing

boolean

探索実行時に、対象機器に対してpingを実施するかどうかを指定します。

・true: pingを使用します。

・false: pingを使用しません

useAllCredential

boolean

すべての Credential を使用するかどうかのフラグ。"すべて"の Credential を使用する場合はtrueを指定します。

selectedCredentials

Credential[]

探索に使用する認証情報のリスト

deviceClassificationLabel

string

機器に割り当てられた分類ラベル

selectedCredentials (Type: Credential)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

name

string

認証情報の名称

credentialType

enum

監視対象への接続に使用するプロトコル。

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

WMI

SSH

WBEM

SNMP

userId

string

認証時に指定するユーザーID。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合，”username”メンバーの値が設定されます。

passwordNotRequired

boolean

認証時にパスワードを必要とするかどうか。省略時はfalseが指定されます。監視対象への接続に「WMI」を使用する場合のみ有効です。

・true:パスワードは必要ない。

・false:パスワードが必要である。

portNumber

int

ポート番号。監視対象への接続に使用するプロトコルが「ssh」，「SMI-S WBEM」，「SNMP」の場合のみ設定されます。

ssl

boolean

監視対象への接続時にSSL(https)を使用するかどうか。

・true:SSLを使用する。

・false:SSLを使用する。

省略時はfalseが指定されます。監視対象への接続に「SMI-S WBEM」を使用する場合のみ有効です。

domainname

string

ドメイン名。監視対象への接続に「WMI」を使用する場合のみ設定されます。

namespace

string

ネームスペース。監視対象への接続に「SMI-S WBEM」を使用する場合のみ設定されます。

community

string

コミュニティ名。監視対象への接続に「SNMP」を使用する場合のみ設定されます。

snmpVersion

enum

SNMPのバージョン。監視対象への接続に「SNMP」を使用する場合のみ設定されます。

(指定可能な値は「列挙型一覧」のSnmpVersionの表を参照してください。)

以下に示す値のみ指定可能です。

V1_V2C

V3

userName

string

認証時に使用するユーザー名。64文字以下の文字列を指定します。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationEnabled

boolean

SMTP認証を行うかどうか。

・true:認証を有効にする。

・false:認証を無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

authenticationProtocol

enum

認証用のプロトコル。 監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

(指定可能な値は「列挙型一覧」のAuthenticationProtocolの表を参照してください。)

以下に示す値のみ指定可能です。

MD5

SHA1

privacyEnabled

boolean

プライバシーを有効にするかどうか。

・true:プライバシーを有効にする。

・false:プライバシーを無効にする。

省略時はfalseが指定されます。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

privacyProtocol

enum

プライバシー用のプロトコル。監視対象への接続に「SNMP v3」を使用する場合のみ指定します。

(指定可能な値は「列挙型一覧」のPrivacyProtocolの表を参照してください。)

以下に示す値のみ指定可能です。

DES

AES128

numOfRelatedResources

int

認証情報を用いて発見されたリソースの数。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

400

Bad Request

リクエストボディ形式不正

401

Unauthorized

ログイン権限がない

403

Forbidden

更新権限がない

404

Not Found

リソースが存在しない

409

Conflict

nameが一致するリソースが存在する

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
PUT http://localhost:22015/Analytics/v1/objects/IpAddrRanges/50 HTTP/1.1
Host: localhost:22015
User-Agent: curl/7.33.0
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Request Body]
{
    "name" : "IP Addr Range 01",
    "ipAddrRange" : [ "192.168.0.110", "192.168.0.210" ],
    "usePing" : false,
    "useAllCredential" : true,
    "selectedCredentials" : [ ],
    "deviceClassificationLabel":"Hitachi Cloud"
}

[Response Header]
HTTP/1.1 200 OK
Date: Wed, 07 Dec 2016 10:03:58 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 1d392a3baad40eab4e3a05ad6e71e3a1fcd577_Vlo8Y30Idn8EY0BdB3IEfwgabiA=_V0810
X-Frame-Options: SAMEORIGIN
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Type: application/json

[Response Body]
{
  "instanceID" : 50,
  "name" : "IP Addr Range 01",
  "ipAddrRange" : [ "192.168.0.110", "192.168.0.210" ],
  "usePing" : false,
  "useAllCredential" : true
  "deviceClassificationLabel":"Hitachi Cloud"
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.2.5　探索範囲の削除

指定した探索範囲を削除します。

権限

Admin

APIのバージョン

v1

リクエスト形式

DELETE http[s]://host:port/Analytics/version/objects/IpAddrRanges/{id}

リクエストボディー

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

レスポンスボディー

レスポンスボディーは出力されません。

ステータスコード

HTTPステータスコード

Reason phrase

説明

204

No Content

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

削除権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
DELETE http://localhost:22015/Analytics/v1/objects/IpAddrRanges/50 HTTP/1.1
Host: localhost:22015
User-Agent: curl/7.33.0
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Response Header]
HTTP/1.1 204 No Content
Date: Wed, 07 Dec 2016 10:13:58 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO f1f0fb1a6ac21a0695f6536ba8950b641c263a4_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Content-Length: 0
Content-Type: application/json

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.3　コレクターに関するAPI一覧

JP1/OAが管理ソフトウェアの接続に使用するコレクターの操作を説明します。

2.3.1　コレクターの一覧の取得

JP1/OAが管理ソフトウェアの接続に使用するコレクターの一覧を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/Collectors

リクエストボディー

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

レスポンスボディー

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

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性

データ型

説明

data

anyType[]

Collector のコレクション。 Collector の詳細は以下の表を参照ください。

pagination

Pagination

ページ情報。リソースが存在しない場合、このパラメータは表示されません。

count

int

条件に合致したデータの個数

pagination (Type: Pagination)

属性

データ型

説明

page

integer

ページ

pageSize

integer

ページサイズ

numPages

integer

ページの数

totalCount

integer

オブジェクトの数

Collector

{
        "instanceID":"...",
        "name":"...",
        "collectorType":"...",
        "osType":"...",
        "autoCollectionType":"...",
        "connectResult":"...",
        "refreshStatus":"...",
        "message":"...",
        "lastRefreshed":"...",
        "refreshDateForInventory":"...",
        "refreshDateForPerformance":"...",
        "numOfHypervisors":"...",
        "numOfVms":"...",
        "numOfApplications":"...",
        "collectorCredentials":[{
            "ipAddress":"...",
            "userId":"...",
            "portNumber":"...",
            "hypertextTransferProtocolType":"...",
            "domainName":"...",
            "useAdministrativeShares":"...",
            "shareName":"...",
            "sharedFolder":"...",
            "logicalHostName":"...",
            "useLogicalHostName":"..."
        },
        :
        ],
        "productName":"...",
        "providerName":"...",
        "refreshDateForApp":"..."
}

Collector (Type: Collector)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

name

string

コレクターの名称

collectorType

enum

コレクターの種別

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

VCENTER

AJS

PFM

IM

osType

enum

コレクターのOS種別。コレクターの種別(collectorType)が「AJS」，「PFM」，「IM」の場合のみ指定します

(指定可能な値は「列挙型一覧」のCollectorOsTypeの表を参照してください。)

autoCollectionType

enum

コレクターの定期実行の設定

(指定可能な値は「列挙型一覧」のConnectTypeの表を参照してください。)

以下に示す値のみ指定可能です。

AutoConnect

NotAutoConnect

connectResult

enum

コレクター の最新の実行結果

(指定可能な値は「列挙型一覧」のConnectStatusTypeの表を参照してください。)

以下に示す値のみ指定可能です。

NoConnect

Succeeded

Failed

refreshStatus

enum

コレクター の実行状態

(指定可能な値は「列挙型一覧」のConnectStatusTypeの表を参照してください。)

以下に示す値のみ指定可能です。

NoConnect

InProgress

message

string

コレクターの実行結果のメッセージ

lastRefreshed

dateTime

最終リフレッシュ日時

refreshDateForInventory

dateTime

構成情報のリフレッシュ日時

refreshDateForPerformance

dateTime

性能情報のリフレッシュ日時

numOfHypervisors

int

コレクターにより発見されたハイパーバイザーの数

numOfVms

int

コレクターにより発見された仮想マシンの数

numOfApplications

int

コレクターにより発見されたアプリケーションの数

collectorCredentials

CollectorCredential[]

監視対象の接続に使用する認証情報

productName

string

収集対象製品名

providerName

string

コレクター作成者

refreshDateForApp

dateTime

定義反映日時

collectorCredentials (Type: CollectorCredential)

属性

データ型

説明

ipAddress

string

管理ソフトウェアへの接続に使用するIPアドレスまたはホスト名

userId

string

管理ソフトウェアへの接続に使用するユーザーID。255byte以下の文字列を指定します。

portNumber

int

管理ソフトウェアへの接続に使用するポート番号。

hypertextTransferProtocolType

enum

管理ソフトウェアへの接続時にSSL(https)を使用するかどうか。

(指定可能な値は「列挙型一覧」のHypertextTransferProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

HTTP

HTTPS

domainName

string

ドメイン名。アプリケーション連携でWindows選択時に使用。

useAdministrativeShares

boolean

管理共有を行う場合にtrueを設定する

shareName

string

共有名

sharedFolder

string

共有フォルダのパス

logicalHostName

string

論理ホスト名

useLogicalHostName

boolean

論理ホスト名を使用する場合にtrueに設定する

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/Collectors HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 05:21:49 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO b9719717b548c1da1798ed5a2b2c22dbda7f40cd_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "instanceID" : 0,
    "name" : "192.168.0.115",
    "collectorType" : "VCENTER",
    "autoCollectionType" : "AutoConnect",
    "connectResult" : "Succeeded",
    "refreshStatus" : "NoConnect",
    "lastRefreshed" : "2015-11-27T14:17:09.160+09:00",
    "refreshDateForInventory" : "2015-11-27T13:25:03.943+09:00",
    "refreshDateForPerformance" : "2015-11-27T14:17:09.160+09:00",
    "numOfHypervisors" : 2,
    "numOfVms" : 27,
    "numOfStorages" : 0,
    "collectorCredentials" : [ {
      "ipAddress" : "192.168.0.115",
      "userId" : "Administrator",
      "portNumber" : 443,
      "hypertextTransferProtocolType" : "HTTPS"
    } ]
  },
  {
      "instanceID": 1,
      "name": "jp1ajs_v11",
      "collectorType": "AJS",
      "osType": "Windows",
      "autoCollectionType": "AutoConnect",
      "connectResult": "Succeeded",
      "refreshStatus": "NoConnect",
      "lastRefreshed": "2017-09-26T00:46:59.296+09:00",
      "refreshDateForInventory": "2017-09-26T00:46:59.296+09:00",
      "numOfHypervisors": 0,
      "numOfVms": 0,
      "numOfStorages": 0,
      "numOfApplications": 12,
      "collectorCredentials":
      [
          {
              "ipAddress": "192.168.1.118",
              "userId": "administrator",
              "domainName": "",
              "useAdministrativeShares": true,
              "useLogicalHostName": false
          }
      ]
  },
  {
      "instanceID": 3,
      "name": "customCollector",
      "collectorType": "CUSTOM_APP",
      "autoCollectionType": "AutoConnect",
      "connectResult": "Succeeded",
      "refreshStatus": "NoConnect",
      "lastRefreshed": "2017-09-26T10:15:26.991+09:00",
      "refreshDateForInventory": "2017-09-26T10:15:26.991+09:00",
      "numOfHypervisors": 0,
      "numOfVms": 0,
      "numOfStorages": 0,
      "numOfApplications": 10,
      "productName": "User Product",
      "providerName": "XXYY System",
      "refreshDateForApp": "2017-08-04T12:10:00.775+09:00"
  }
],
  "count" : 3
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.3.2　コレクターの情報取得

指定したコレクターの情報を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/Collectors/{id}

リクエストボディー

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

レスポンスボディー

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

Collector

{
        "instanceID":"...",
        "name":"...",
        "collectorType":"...",
        "osType":"...",
        "autoCollectionType":"...",
        "connectResult":"...",
        "refreshStatus":"...",
        "message":"...",
        "lastRefreshed":"...",
        "refreshDateForInventory":"...",
        "refreshDateForPerformance":"...",
        "numOfHypervisors":"...",
        "numOfVms":"...",
        "numOfApplications":"...",
        "collectorCredentials":[{
            "ipAddress":"...",
            "userId":"...",
            "portNumber":"...",
            "hypertextTransferProtocolType":"...",
            "domainName":"...",
            "useAdministrativeShares":"...",
            "shareName":"...",
            "sharedFolder":"...",
            "logicalHostName":"...",
            "useLogicalHostName":"..."
        },
        :
        ],
        "productName":"...",
        "providerName":"...",
        "refreshDateForApp":"..."
}

Collector (Type: Collector)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

name

string

コレクターの名称

collectorType

enum

コレクターの種別

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

VCENTER

AJS

PFM

IM

osType

enum

コレクターのOS種別。コレクターの種別(collectorType)が「AJS」，「PFM」，「IM」の場合のみ指定します

(指定可能な値は「列挙型一覧」のCollectorOsTypeの表を参照してください。)

autoCollectionType

enum

コレクターの定期実行の設定

(指定可能な値は「列挙型一覧」のConnectTypeの表を参照してください。)

以下に示す値のみ指定可能です。

AutoConnect

NotAutoConnect

connectResult

enum

コレクター の最新の実行結果

(指定可能な値は「列挙型一覧」のConnectStatusTypeの表を参照してください。)

以下に示す値のみ指定可能です。

NoConnect

Succeeded

Failed

refreshStatus

enum

コレクター の実行状態

(指定可能な値は「列挙型一覧」のConnectStatusTypeの表を参照してください。)

以下に示す値のみ指定可能です。

NoConnect

InProgress

message

string

コレクターの実行結果のメッセージ

lastRefreshed

dateTime

最終リフレッシュ日時

refreshDateForInventory

dateTime

構成情報のリフレッシュ日時

refreshDateForPerformance

dateTime

性能情報のリフレッシュ日時

numOfHypervisors

int

コレクターにより発見されたハイパーバイザーの数

numOfVms

int

コレクターにより発見された仮想マシンの数

numOfApplications

int

コレクターにより発見されたアプリケーションの数

collectorCredentials

CollectorCredential[]

監視対象の接続に使用する認証情報

productName

string

収集対象製品名

providerName

string

コレクター作成者

refreshDateForApp

dateTime

定義反映日時

collectorCredentials (Type: CollectorCredential)

属性

データ型

説明

ipAddress

string

管理ソフトウェアへの接続に使用するIPアドレスまたはホスト名

userId

string

管理ソフトウェアへの接続に使用するユーザーID。255byte以下の文字列を指定します。

portNumber

int

管理ソフトウェアへの接続に使用するポート番号。

hypertextTransferProtocolType

enum

管理ソフトウェアへの接続時にSSL(https)を使用するかどうか。

(指定可能な値は「列挙型一覧」のHypertextTransferProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

HTTP

HTTPS

domainName

string

ドメイン名。アプリケーション連携でWindows選択時に使用。

useAdministrativeShares

boolean

管理共有を行う場合にtrueを設定する

shareName

string

共有名

sharedFolder

string

共有フォルダのパス

logicalHostName

string

論理ホスト名

useLogicalHostName

boolean

論理ホスト名を使用する場合にtrueに設定する

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/Collectors/0 HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 07:19:44 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO d81476c07bc464b6d3c785f80b0b87eb0549f62_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : 0,
  "name" : "172.17.17.115",
  "collectorType" : "VCENTER",
  "autoCollectionType" : "AutoConnect",
  "connectResult" : "Succeeded",
  "refreshStatus" : "NoConnect",
  "lastRefreshed" : "2015-11-27T16:18:41.710+09:00",
  "refreshDateForInventory" : "2015-11-27T15:25:04.098+09:00",
  "refreshDateForPerformance" : "2015-11-27T16:18:41.710+09:00",
  "numOfHypervisors" : 2,
  "numOfVms" : 27,
  "numOfStorages" : 0,
  "collectorCredentials" : [ {
    "ipAddress" : "172.17.17.115",
    "userId" : "Administrator",
    "portNumber" : 443,
    "hypertextTransferProtocolType" : "HTTPS"
  } ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.3.3　コレクターの作成

コレクターを新規に作成します。ただし、任意のアプリケーションのコレクターは作成できません。

権限

Admin

APIのバージョン

v1

リクエスト形式

POST http[s]://host:port/Analytics/version/objects/Collectors

リクエストボディー

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

Collector

{
        "name":"...",
        "collectorType":"...",
        "osType":"...",
        "autoCollectionType":"...",
        "collectorCredentials":[{
            "ipAddress":"...",
            "userId":"...",
            "password":"...",
            "updatePassword":"...",
            "portNumber":"...",
            "hypertextTransferProtocolType":"...",
            "domainName":"...",
            "rootPassword":"...",
            "updateRootPassword":"...",
            "useAdministrativeShares":"...",
            "shareName":"...",
            "sharedFolder":"...",
            "logicalHostName":"...",
            "useLogicalHostName":"..."
        },
        :
        ]
}

Collector (Type: Collector)

属性

データ型

説明

name

string

コレクターの名称

collectorType

enum

コレクターの種別

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

VCENTER

AJS

PFM

IM

osType

enum

コレクターのOS種別。コレクターの種別(collectorType)が「AJS」，「PFM」，「IM」の場合のみ指定します

(指定可能な値は「列挙型一覧」のCollectorOsTypeの表を参照してください。)

autoCollectionType

enum

コレクターの定期実行の設定

(指定可能な値は「列挙型一覧」のConnectTypeの表を参照してください。)

以下に示す値のみ指定可能です。

AutoConnect

NotAutoConnect

collectorCredentials

CollectorCredential[]

監視対象の接続に使用する認証情報

collectorCredentials (Type: CollectorCredential)

属性

データ型

説明

ipAddress

string

管理ソフトウェアへの接続に使用するIPアドレスまたはホスト名

userId

string

管理ソフトウェアへの接続に使用するユーザーID。255byte以下の文字列を指定します。

password

string

管理ソフトウェアへの接続に使用するパスワード。255byte以下の文字列をBase64でエンコードして指定します。

updatePassword

boolean

管理ソフトウェアへの接続に使用するパスワードを変更するかどうか。

・true:パスワードの変更を行う。

・false:パスワードの変更を行わない。

省略時はfalseが指定されます。

portNumber

int

管理ソフトウェアへの接続に使用するポート番号。

hypertextTransferProtocolType

enum

管理ソフトウェアへの接続時にSSL(https)を使用するかどうか。

(指定可能な値は「列挙型一覧」のHypertextTransferProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

HTTP

HTTPS

domainName

string

ドメイン名。アプリケーション連携でWindows選択時に使用。

rootPassword

string

rootパスワード。アプリケーション連携でUnix選択時に使用。

updateRootPassword

boolean

パスワードを変更する場合にtrueを設定する。更新時のみ使用。

useAdministrativeShares

boolean

管理共有を行う場合にtrueを設定する

shareName

string

共有名

sharedFolder

string

共有フォルダのパス

logicalHostName

string

論理ホスト名

useLogicalHostName

boolean

論理ホスト名を使用する場合にtrueに設定する

レスポンスボディー

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

Collector

{
        "instanceID":"...",
        "name":"...",
        "collectorType":"...",
        "osType":"...",
        "autoCollectionType":"...",
        "connectResult":"...",
        "refreshStatus":"...",
        "message":"...",
        "lastRefreshed":"...",
        "refreshDateForInventory":"...",
        "refreshDateForPerformance":"...",
        "numOfHypervisors":"...",
        "numOfVms":"...",
        "numOfApplications":"...",
        "collectorCredentials":[{
            "ipAddress":"...",
            "userId":"...",
            "portNumber":"...",
            "hypertextTransferProtocolType":"...",
            "domainName":"...",
            "useAdministrativeShares":"...",
            "shareName":"...",
            "sharedFolder":"...",
            "logicalHostName":"...",
            "useLogicalHostName":"..."
        },
        :
        ],
        "productName":"...",
        "providerName":"...",
        "refreshDateForApp":"..."
}

Collector (Type: Collector)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

name

string

コレクターの名称

collectorType

enum

コレクターの種別

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

VCENTER

AJS

PFM

IM

osType

enum

コレクターのOS種別。コレクターの種別(collectorType)が「AJS」，「PFM」，「IM」の場合のみ指定します

(指定可能な値は「列挙型一覧」のCollectorOsTypeの表を参照してください。)

autoCollectionType

enum

コレクターの定期実行の設定

(指定可能な値は「列挙型一覧」のConnectTypeの表を参照してください。)

以下に示す値のみ指定可能です。

AutoConnect

NotAutoConnect

connectResult

enum

コレクター の最新の実行結果

(指定可能な値は「列挙型一覧」のConnectStatusTypeの表を参照してください。)

以下に示す値のみ指定可能です。

NoConnect

Succeeded

Failed

refreshStatus

enum

コレクター の実行状態

(指定可能な値は「列挙型一覧」のConnectStatusTypeの表を参照してください。)

以下に示す値のみ指定可能です。

NoConnect

InProgress

message

string

コレクターの実行結果のメッセージ

lastRefreshed

dateTime

最終リフレッシュ日時

refreshDateForInventory

dateTime

構成情報のリフレッシュ日時

refreshDateForPerformance

dateTime

性能情報のリフレッシュ日時

numOfHypervisors

int

コレクターにより発見されたハイパーバイザーの数

numOfVms

int

コレクターにより発見された仮想マシンの数

numOfApplications

int

コレクターにより発見されたアプリケーションの数

collectorCredentials

CollectorCredential[]

監視対象の接続に使用する認証情報

productName

string

収集対象製品名

providerName

string

コレクター作成者

refreshDateForApp

dateTime

定義反映日時

collectorCredentials (Type: CollectorCredential)

属性

データ型

説明

ipAddress

string

管理ソフトウェアへの接続に使用するIPアドレスまたはホスト名

userId

string

管理ソフトウェアへの接続に使用するユーザーID。255byte以下の文字列を指定します。

portNumber

int

管理ソフトウェアへの接続に使用するポート番号。

hypertextTransferProtocolType

enum

管理ソフトウェアへの接続時にSSL(https)を使用するかどうか。

(指定可能な値は「列挙型一覧」のHypertextTransferProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

HTTP

HTTPS

domainName

string

ドメイン名。アプリケーション連携でWindows選択時に使用。

useAdministrativeShares

boolean

管理共有を行う場合にtrueを設定する

shareName

string

共有名

sharedFolder

string

共有フォルダのパス

logicalHostName

string

論理ホスト名

useLogicalHostName

boolean

論理ホスト名を使用する場合にtrueに設定する

ステータスコード

HTTPステータスコード

Reason phrase

説明

201

Created

正常終了

400

Bad Request

・リクエストボディ形式不正

・リクエスト不正

401

Unauthorized

ログイン権限がない

403

Forbidden

作成権限がない

409

Conflict

nameが一致するリソースが存在する

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
POST /Analytics/v1/objects/Collectors HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 236

[Request Body]
{
  "name": "test Collector",
  "autoCollectionType": "AutoConnect",
  "collectorType": "VCENTER",
  "collectorCredentials": [
    {
      "ipAddress": "172.17.17.113",
      "userId": "test",
      "password": "dGVzdA==",
      "portNumber": 443,
      "hypertextTransferProtocolType": "HTTPS"
    }
  ]
}

[Response Header]
HTTP/1.1 201 Created
Date: Fri, 27 Nov 2015 08:23:46 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO bfb7bb1ac5122d4e95bddc86cfb215f4c04715_WVlGcHsLfg5ffg0I_V0810
Location: http://localhost:22015/Analytics/v1/objects/Collectors/13
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : 13,
  "name" : "vCenter_71",
  "collectorType" : "VCENTER",
  "autoCollectionType" : "AutoConnect",
  "connectResult" : "Succeeded",
  "refreshStatus" : "NoConnect",
  "lastRefreshed" : "2016-11-21T17:17:59.926+09:00",
  "refreshDateForInventory" : "2016-11-21T16:52:03.271+09:00",
  "refreshDateForPerformance" : "2016-11-21T17:17:59.926+09:00",
  "numOfHypervisors" : 3,
  "numOfVms" : 33,
  "numOfStorages" : 0,
  "numOfApplications" : 0,
  "collectorCredentials" : [ {
    "ipAddress" : "172.25.73.71",
    "userId" : "administrator@vsphere.local",
    "portNumber" : 443,
    "hypertextTransferProtocolType" : "HTTPS"
  } ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.3.4　コレクターの更新

指定したコレクターに含まれるユーザーIDとパスワードの更新を行います。ただし、任意のアプリケーションのコレクターは更新できません。

権限

Admin

APIのバージョン

v1

リクエスト形式

PUT http[s]://host:port/Analytics/version/objects/Collectors/{id}

リクエストボディー

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

Collector

{
        "name":"...",
        "collectorType":"...",
        "osType":"...",
        "autoCollectionType":"...",
        "collectorCredentials":[{
            "ipAddress":"...",
            "userId":"...",
            "password":"...",
            "updatePassword":"...",
            "portNumber":"...",
            "hypertextTransferProtocolType":"...",
            "domainName":"...",
            "rootPassword":"...",
            "updateRootPassword":"...",
            "useAdministrativeShares":"...",
            "shareName":"...",
            "sharedFolder":"...",
            "logicalHostName":"...",
            "useLogicalHostName":"..."
        },
        :
        ]
}

Collector (Type: Collector)

属性

データ型

説明

name

string

コレクターの名称

collectorType

enum

コレクターの種別

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

VCENTER

AJS

PFM

IM

osType

enum

コレクターのOS種別。コレクターの種別(collectorType)が「AJS」，「PFM」，「IM」の場合のみ指定します

(指定可能な値は「列挙型一覧」のCollectorOsTypeの表を参照してください。)

autoCollectionType

enum

コレクターの定期実行の設定

(指定可能な値は「列挙型一覧」のConnectTypeの表を参照してください。)

以下に示す値のみ指定可能です。

AutoConnect

NotAutoConnect

collectorCredentials

CollectorCredential[]

監視対象の接続に使用する認証情報

collectorCredentials (Type: CollectorCredential)

属性

データ型

説明

ipAddress

string

管理ソフトウェアへの接続に使用するIPアドレスまたはホスト名

userId

string

管理ソフトウェアへの接続に使用するユーザーID。255byte以下の文字列を指定します。

password

string

管理ソフトウェアへの接続に使用するパスワード。255byte以下の文字列をBase64でエンコードして指定します。

updatePassword

boolean

管理ソフトウェアへの接続に使用するパスワードを変更するかどうか。

・true:パスワードの変更を行う。

・false:パスワードの変更を行わない。

省略時はfalseが指定されます。

portNumber

int

管理ソフトウェアへの接続に使用するポート番号。

hypertextTransferProtocolType

enum

管理ソフトウェアへの接続時にSSL(https)を使用するかどうか。

(指定可能な値は「列挙型一覧」のHypertextTransferProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

HTTP

HTTPS

domainName

string

ドメイン名。アプリケーション連携でWindows選択時に使用。

rootPassword

string

rootパスワード。アプリケーション連携でUnix選択時に使用。

updateRootPassword

boolean

パスワードを変更する場合にtrueを設定する。更新時のみ使用。

useAdministrativeShares

boolean

管理共有を行う場合にtrueを設定する

shareName

string

共有名

sharedFolder

string

共有フォルダのパス

logicalHostName

string

論理ホスト名

useLogicalHostName

boolean

論理ホスト名を使用する場合にtrueに設定する

レスポンスボディー

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

Collector

{
        "instanceID":"...",
        "name":"...",
        "collectorType":"...",
        "osType":"...",
        "autoCollectionType":"...",
        "connectResult":"...",
        "refreshStatus":"...",
        "message":"...",
        "lastRefreshed":"...",
        "refreshDateForInventory":"...",
        "refreshDateForPerformance":"...",
        "numOfHypervisors":"...",
        "numOfVms":"...",
        "numOfApplications":"...",
        "collectorCredentials":[{
            "ipAddress":"...",
            "userId":"...",
            "portNumber":"...",
            "hypertextTransferProtocolType":"...",
            "domainName":"...",
            "useAdministrativeShares":"...",
            "shareName":"...",
            "sharedFolder":"...",
            "logicalHostName":"...",
            "useLogicalHostName":"..."
        },
        :
        ],
        "productName":"...",
        "providerName":"...",
        "refreshDateForApp":"..."
}

Collector (Type: Collector)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

name

string

コレクターの名称

collectorType

enum

コレクターの種別

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

VCENTER

AJS

PFM

IM

osType

enum

コレクターのOS種別。コレクターの種別(collectorType)が「AJS」，「PFM」，「IM」の場合のみ指定します

(指定可能な値は「列挙型一覧」のCollectorOsTypeの表を参照してください。)

autoCollectionType

enum

コレクターの定期実行の設定

(指定可能な値は「列挙型一覧」のConnectTypeの表を参照してください。)

以下に示す値のみ指定可能です。

AutoConnect

NotAutoConnect

connectResult

enum

コレクター の最新の実行結果

(指定可能な値は「列挙型一覧」のConnectStatusTypeの表を参照してください。)

以下に示す値のみ指定可能です。

NoConnect

Succeeded

Failed

refreshStatus

enum

コレクター の実行状態

(指定可能な値は「列挙型一覧」のConnectStatusTypeの表を参照してください。)

以下に示す値のみ指定可能です。

NoConnect

InProgress

message

string

コレクターの実行結果のメッセージ

lastRefreshed

dateTime

最終リフレッシュ日時

refreshDateForInventory

dateTime

構成情報のリフレッシュ日時

refreshDateForPerformance

dateTime

性能情報のリフレッシュ日時

numOfHypervisors

int

コレクターにより発見されたハイパーバイザーの数

numOfVms

int

コレクターにより発見された仮想マシンの数

numOfApplications

int

コレクターにより発見されたアプリケーションの数

collectorCredentials

CollectorCredential[]

監視対象の接続に使用する認証情報

productName

string

収集対象製品名

providerName

string

コレクター作成者

refreshDateForApp

dateTime

定義反映日時

collectorCredentials (Type: CollectorCredential)

属性

データ型

説明

ipAddress

string

管理ソフトウェアへの接続に使用するIPアドレスまたはホスト名

userId

string

管理ソフトウェアへの接続に使用するユーザーID。255byte以下の文字列を指定します。

portNumber

int

管理ソフトウェアへの接続に使用するポート番号。

hypertextTransferProtocolType

enum

管理ソフトウェアへの接続時にSSL(https)を使用するかどうか。

(指定可能な値は「列挙型一覧」のHypertextTransferProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

HTTP

HTTPS

domainName

string

ドメイン名。アプリケーション連携でWindows選択時に使用。

useAdministrativeShares

boolean

管理共有を行う場合にtrueを設定する

shareName

string

共有名

sharedFolder

string

共有フォルダのパス

logicalHostName

string

論理ホスト名

useLogicalHostName

boolean

論理ホスト名を使用する場合にtrueに設定する

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

400

Bad Request

・リクエストボディ形式不正

・リクエスト不正

401

Unauthorized

ログイン権限がない

403

Forbidden

更新権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
PUT /Analytics/v1/objects/Collectors/11 HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 482

[Request Body]
{
  "instanceID" : 11,
  "name" : "vCenterMonitoring",
  "collectorType" : "VCENTER",
  "autoCollectionType" : "AutoConnect",
  "connectResult" : "NoConnect",
  "refreshStatus" : "NoConnect",
  "numOfHypervisors" : 0,
  "numOfVms" : 0,
  "numOfStorages" : 0,
  "collectorCredentials" : [ {
    "ipAddress" : "172.17.17.116",
    "userId" : "Administrator",
    "updatePassword" : true,
    "password" : "c3lzdGVtOm1hbmFnZXI=",
    "portNumber" : 443,
    "hypertextTransferProtocolType" : "HTTPS"
  } ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 08:42:46 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO ea7ee5beeebb36f7aeb0571ff9adba9e12fca4_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : 11,
  "name" : "vCenterMonitoring",
  "collectorType" : "VCENTER",
  "autoCollectionType" : "AutoConnect",
  "connectResult" : "NoConnect",
  "refreshStatus" : "NoConnect",
  "numOfHypervisors" : 0,
  "numOfVms" : 0,
  "numOfStorages" : 0,
  "collectorCredentials" : [ {
    "ipAddress" : "172.17.17.116",
    "userId" : "Administrator",
    "portNumber" : 443,
    "hypertextTransferProtocolType" : "HTTPS"
  } ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.3.5　コレクターの削除

指定したコレクターを削除します。ただし、任意のアプリケーションのコレクターは削除できません。

権限

Admin

APIのバージョン

v1

リクエスト形式

DELETE http[s]://host:port/Analytics/version/objects/Collectors/{id}

リクエストボディー

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

レスポンスボディー

レスポンスボディーは出力されません。

ステータスコード

HTTPステータスコード

Reason phrase

説明

204

No Content

正常終了

400

Bad Request

削除対象外のリソース

401

Unauthorized

ログイン権限がない

403

Forbidden

削除権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
DELETE http://localhost:22015/Analytics/v1/objects/Collectors/0 HTTP/1.1
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Response Header]
HTTP/1.1 204 No Content
Date: Wed, 07 Dec 2016 10:27:46 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO d5133e9e3ece3f258eda94ad4ed3fc2c8e7eda63_Vlo8Y30Idn8EY0BdB3IEfwgabiA=_V0810
X-Frame-Options: SAMEORIGIN
Content-Length: 0
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Type: application/json

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.4　ユーザープロファイルに関するAPI一覧

JP1/OAが監視対象の監視に使用するユーザープロファイルの操作を説明します。

2.4.1　ユーザープロファイルの一覧の取得

ユーザープロファイルの一覧を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/UserThresholdProfiles

リクエストボディー

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

レスポンスボディー

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

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性

データ型

説明

data

anyType[]

UserThresholdProfile のコレクション。 UserThresholdProfile の詳細は以下の表を参照ください。

pagination

Pagination

ページ情報。リソースが存在しない場合、このパラメータは表示されません。

count

int

条件に合致したデータの個数

pagination (Type: Pagination)

属性

データ型

説明

page

integer

ページ

pageSize

integer

ページサイズ

numPages

integer

ページの数

totalCount

integer

オブジェクトの数

UserThresholdProfile

{
        "instanceID":"...",
        "profileName":"...",
        "description":"...",
        "resourceType":"...",
        "profileType":"...",
        "thresholdValues":[{
            "instanceID":"...",
            "monitoring":"...",
            "metricType":"...",
            "displayName":"...",
            "unit":"...",
            "proportion":"...",
            "thresholdValueOfWarning":"...",
            "thresholdValueOfError":"...",
            "stepSize":"...",
            "max":"...",
            "min":"..."
        },
        :
        ],
        "numOfResources":"...",
        "autoAssignFilters":["...", ...]
}

UserThresholdProfile (Type: UserThresholdProfile)

属性

データ型

説明

instanceID

long

インスタンスを特定するID。

profileName

string

ユーザープロファイルの名称。128文字以下の文字列を指定します。

description

string

ユーザープロファイルの説明。256文字以下の文字列を指定します。

resourceType

string

ユーザープロファイルが適用できるリソース種別。以下の値のみ指定可能。

・VM:仮想マシン

・VOLUME:ボリューム

・WINDOWS:Windows

・LINUX_UNIX:LinuxまたはUNIX

profileType

string

ユーザープロファイルの変更種別

・User:ユーザーが作成したプロファイル

・Default:デフォルトで登録されているプロファイル

・Preset:初期値が設定されたプロファイル

thresholdValues

UserThresholdValue[]

ユーザープロファイルに設定されているしきい値の内容。

numOfResources

int

ユーザープロファイルが割り当たっているリソースの数

autoAssignFilters

string[]

自動割り当てルールのルール名。

thresholdValues (Type: UserThresholdValue)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

monitoring

boolean

監視しているしきい値かどうか。

・true:監視している。

・false:監視していない。

省略時はfalseが設定されます。

metricType

string

しきい値の識別子。未サポートのメンバーです。

displayName

string

しきい値の表示名。

unit

string

しきい値の単位を表す文字列。

proportion

boolean

しきい値の方向。

true:測定値がしきい値を下回る場合に異常または警告となる。

false:測定値がしきい値を上回る場合に異常または警告になる。

thresholdValueOfWarning

float

警告を表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。

・stepSizeの倍数

・max以下

・min以上

thresholdValueOfError

float

エラーを表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。

・stepSizeの倍数

・max以下

・min以上

stepSize

float

しきい値の増加量。

max

double

しきい値がとりえる最大値。

min

double

しきい値がとりえる最小値。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

400

Bad Request

クエリパラメータ不正

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/UserThresholdProfiles HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 05:42:22 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO ef807fefafe4f3d3f3058e252907ae61ed6a63a_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : 62,
  "profileName" : "Default Profile for Volume",
  "description" : "Default Profile for Volume",
  "resourceType" : "VOLUME",
  "profileType" : "User",
  "thresholdValues" : [ {
  "  instanceID" : 763,
    "monitoring" : false,
    "metricType" : "STO_VOLUME_TOTAL_IO_RATE",
    "displayName" : "Volume IOPS ",
    "unit" : "transfers/sec",
    "proportion" : false,
    "thresholdValueOfWarning" : 0.0,
    "thresholdValueOfError" : 2222.0,
    "stepSize" : 1.0,
    "max" : 3.4028235E38,
    "min" : 0.0
  }, {
    "instanceID" : 761,
    "monitoring" : false,
    "metricType" : "STO_VOLUME_TOTAL_XFER_RATE",
    "displayName" : "Volume IO Rate",
    "unit" : "MBps",
    "proportion" : false,
    "thresholdValueOfWarning" : 421.0,
    "thresholdValueOfError" : 450.0,
    "stepSize" : 1.0,
    "max" : 3.4028235E38,
    "min" : 0.0
  }, {
    "instanceID" : 762,
    "monitoring" : true,
    "metricType" : "STO_IO_RESPONSE_TIME_ON_CTRL0",
    "displayName" : "Volume Response Time Per IO Request",
    "unit" : "msec/transfer",
    "proportion" : false,
    "thresholdValueOfWarning" : 499.9,
    "thresholdValueOfError" : 500.1,
    "stepSize" : 0.1,
    "max" : 3.4028235E38,
    "min" : 0.0
  } ],
  "numOfResources" : 0,
  "autoAssignFilters" : [ ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.4.2　ユーザープロファイルの情報取得

指定したユーザープロファイルの情報を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/UserThresholdProfiles/{id}

リクエストボディー

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

レスポンスボディー

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

UserThresholdProfile

{
        "instanceID":"...",
        "profileName":"...",
        "description":"...",
        "resourceType":"...",
        "profileType":"...",
        "thresholdValues":[{
            "instanceID":"...",
            "monitoring":"...",
            "metricType":"...",
            "displayName":"...",
            "unit":"...",
            "proportion":"...",
            "thresholdValueOfWarning":"...",
            "thresholdValueOfError":"...",
            "stepSize":"...",
            "max":"...",
            "min":"..."
        },
        :
        ],
        "numOfResources":"...",
        "autoAssignFilters":["...", ...]
}

UserThresholdProfile (Type: UserThresholdProfile)

属性

データ型

説明

instanceID

long

インスタンスを特定するID。

profileName

string

ユーザープロファイルの名称。128文字以下の文字列を指定します。

description

string

ユーザープロファイルの説明。256文字以下の文字列を指定します。

resourceType

string

ユーザープロファイルが適用できるリソース種別。以下の値のみ指定可能。

・VM:仮想マシン

・VOLUME:ボリューム

・WINDOWS:Windows

・LINUX_UNIX:LinuxまたはUNIX

profileType

string

ユーザープロファイルの変更種別

・User:ユーザーが作成したプロファイル

・Default:デフォルトで登録されているプロファイル

・Preset:初期値が設定されたプロファイル

thresholdValues

UserThresholdValue[]

ユーザープロファイルに設定されているしきい値の内容。

numOfResources

int

ユーザープロファイルが割り当たっているリソースの数

autoAssignFilters

string[]

自動割り当てルールのルール名。

thresholdValues (Type: UserThresholdValue)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

monitoring

boolean

監視しているしきい値かどうか。

・true:監視している。

・false:監視していない。

省略時はfalseが設定されます。

metricType

string

しきい値の識別子。未サポートのメンバーです。

displayName

string

しきい値の表示名。

unit

string

しきい値の単位を表す文字列。

proportion

boolean

しきい値の方向。

true:測定値がしきい値を下回る場合に異常または警告となる。

false:測定値がしきい値を上回る場合に異常または警告になる。

thresholdValueOfWarning

float

警告を表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。

・stepSizeの倍数

・max以下

・min以上

thresholdValueOfError

float

エラーを表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。

・stepSizeの倍数

・max以下

・min以上

stepSize

float

しきい値の増加量。

max

double

しきい値がとりえる最大値。

min

double

しきい値がとりえる最小値。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/UserThresholdProfiles/62 HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 07:19:45 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO fe84f16f0bb366a0b4d1226353e169d76c5ee_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
"instanceID" : 23,
"profileName" : "Default Profile for Hyper-V",
"description" : "Default Profile for Hyper-V",
"resourceType" : "HYPERV",
"profileType" : "Default",
"thresholdValues" : [ {
"instanceID" : 539,
"monitoring" : true,
"metricType" : "WIN_CPU_LOAD",
"displayName" : "CPU Use",
"unit" : "%",
"proportion" : false,
"thresholdValueOfWarning" : 80.0,
"thresholdValueOfError" : 90.0,
"stepSize" : 1.0,
"max" : 100.0,
"min" : 0.0
}, {
.......
},
.......
],
"numOfResources" : 1
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.4.3　ユーザープロファイルの作成

ユーザープロファイルを新規に作成します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

POST http[s]://host:port/Analytics/version/objects/UserThresholdProfiles

リクエストボディー

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

UserThresholdProfile

{
        "profileName":"...",
        "description":"...",
        "resourceType":"...",
        "profileType":"...",
        "thresholdValues":[{
            "monitoring":"...",
            "metricType":"...",
            "displayName":"...",
            "unit":"...",
            "proportion":"...",
            "thresholdValueOfWarning":"...",
            "thresholdValueOfError":"...",
            "stepSize":"...",
            "max":"...",
            "min":"..."
        },
        :
        ]
}

UserThresholdProfile (Type: UserThresholdProfile)

属性

データ型

説明

profileName

string

ユーザープロファイルの名称。128文字以下の文字列を指定します。

description

string

ユーザープロファイルの説明。256文字以下の文字列を指定します。

resourceType

string

ユーザープロファイルが適用できるリソース種別。以下の値のみ指定可能。

・VM:仮想マシン

・VOLUME:ボリューム

・WINDOWS:Windows

・LINUX_UNIX:LinuxまたはUNIX

profileType

string

ユーザープロファイルの変更種別

・User:ユーザーが作成したプロファイル

・Default:デフォルトで登録されているプロファイル

・Preset:初期値が設定されたプロファイル

thresholdValues

UserThresholdValue[]

ユーザープロファイルに設定されているしきい値の内容。

thresholdValues (Type: UserThresholdValue)

属性

データ型

説明

monitoring

boolean

監視しているしきい値かどうか。

・true:監視している。

・false:監視していない。

省略時はfalseが設定されます。

metricType

string

しきい値の識別子。未サポートのメンバーです。

displayName

string

しきい値の表示名。

unit

string

しきい値の単位を表す文字列。

proportion

boolean

しきい値の方向。

true:測定値がしきい値を下回る場合に異常または警告となる。

false:測定値がしきい値を上回る場合に異常または警告になる。

thresholdValueOfWarning

float

警告を表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。

・stepSizeの倍数

・max以下

・min以上

thresholdValueOfError

float

エラーを表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。

・stepSizeの倍数

・max以下

・min以上

stepSize

float

しきい値の増加量。

max

double

しきい値がとりえる最大値。

min

double

しきい値がとりえる最小値。

レスポンスボディー

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

UserThresholdProfile

{
        "instanceID":"...",
        "profileName":"...",
        "description":"...",
        "resourceType":"...",
        "profileType":"...",
        "thresholdValues":[{
            "instanceID":"...",
            "monitoring":"...",
            "metricType":"...",
            "displayName":"...",
            "unit":"...",
            "proportion":"...",
            "thresholdValueOfWarning":"...",
            "thresholdValueOfError":"...",
            "stepSize":"...",
            "max":"...",
            "min":"..."
        },
        :
        ],
        "numOfResources":"...",
        "autoAssignFilters":["...", ...]
}

UserThresholdProfile (Type: UserThresholdProfile)

属性

データ型

説明

instanceID

long

インスタンスを特定するID。

profileName

string

ユーザープロファイルの名称。128文字以下の文字列を指定します。

description

string

ユーザープロファイルの説明。256文字以下の文字列を指定します。

resourceType

string

ユーザープロファイルが適用できるリソース種別。以下の値のみ指定可能。

・VM:仮想マシン

・VOLUME:ボリューム

・WINDOWS:Windows

・LINUX_UNIX:LinuxまたはUNIX

profileType

string

ユーザープロファイルの変更種別

・User:ユーザーが作成したプロファイル

・Default:デフォルトで登録されているプロファイル

・Preset:初期値が設定されたプロファイル

thresholdValues

UserThresholdValue[]

ユーザープロファイルに設定されているしきい値の内容。

numOfResources

int

ユーザープロファイルが割り当たっているリソースの数

autoAssignFilters

string[]

自動割り当てルールのルール名。

thresholdValues (Type: UserThresholdValue)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

monitoring

boolean

監視しているしきい値かどうか。

・true:監視している。

・false:監視していない。

省略時はfalseが設定されます。

metricType

string

しきい値の識別子。未サポートのメンバーです。

displayName

string

しきい値の表示名。

unit

string

しきい値の単位を表す文字列。

proportion

boolean

しきい値の方向。

true:測定値がしきい値を下回る場合に異常または警告となる。

false:測定値がしきい値を上回る場合に異常または警告になる。

thresholdValueOfWarning

float

警告を表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。

・stepSizeの倍数

・max以下

・min以上

thresholdValueOfError

float

エラーを表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。

・stepSizeの倍数

・max以下

・min以上

stepSize

float

しきい値の増加量。

max

double

しきい値がとりえる最大値。

min

double

しきい値がとりえる最小値。

ステータスコード

HTTPステータスコード

Reason phrase

説明

201

Created

正常終了

400

Bad Request

リクエストボディ形式不正

401

Unauthorized

ログイン権限がない

403

Forbidden

更新権限がない

404

Not Found

リソースが存在しない

409

Conflict

nameが一致するリソースが存在する

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
POST /Analytics/v1/objects/UserThresholdProfiles HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 1330

[Request Body]
{
  "instanceID" : 0,
  "profileName" : "Default Profile for Volume",
  "description" : "Default Profile for Volume",
  "resourceType" : "VOLUME",
  "profileType" : "User",
  "thresholdValues" : [ {
    "instanceID" : 763,
    "monitoring" : false,
    "metricType" : "STO_VOLUME_TOTAL_IO_RATE",
    "displayName" : "Volume IOPS,
    "unit" : "transfers/sec",
    "proportion" : false,
    "thresholdValueOfWarning" : 0.0,
    "thresholdValueOfError" : 2222.0,
    "stepSize" : 1.0,
    "max" : 3.4028235E38,
    "min" : 0.0
    }, {
    "instanceID" : 761,
    "monitoring" : false,
    "metricType" : "STO_VOLUME_TOTAL_XFER_RATE",
    "displayName" : "Volume IO Rate",
    "unit" : "MBps",
    "proportion" : false,
    "thresholdValueOfWarning" : 421.0,
    "thresholdValueOfError" : 450.0,
    "stepSize" : 1.0,
    "max" : 3.4028235E38,
    "min" : 0.0
    }, {
    "instanceID" : 762,
    "monitoring" : true,
    "metricType" : "STO_IO_RESPONSE_TIME_ON_CTRL0",
    "displayName" : "Volume Response Time Per IO Request",
    "unit" : "msec/transfer",
    "proportion" : false,
    "thresholdValueOfWarning" : 499.9,
    "thresholdValueOfError" : 500.1,
    "stepSize" : 0.1,
    "max" : 3.4028235E38,
    "min" : 0.0
  } ],
  "numOfResources" : 0,
  "autoAssignFilters" : [ ]
}

[Response Header]
HTTP/1.1 201 Created
Date: Fri, 27 Nov 2015 07:59:59 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 92912a219d69363f390aa8d6fa84157ab1e58d6_WVlGcHsLfg5ffg0I_V0810
Location: http://localhost:22015/Analytics/v1/objects/UserThresholdProfiles/63
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : 63,
  "profileName" : "Default Profile for Volume",
  "description" : "Default Profile for Volume",
  "resourceType" : "VOLUME",
  "profileType" : "User",
  "thresholdValues" : [ {
    "instanceID" : 769,
    "monitoring" : false,
    "metricType" : "STO_VOLUME_TOTAL_IO_RATE",
    "displayName" : "Volume IOPS",
    "unit" : "transfers/sec",
    "proportion" : false,
    "thresholdValueOfWarning" : 0.0,
    "thresholdValueOfError" : 2222.0,
    "stepSize" : 1.0,
    "max" : 3.4028235E38,
    "min" : 0.0
  }, {
    "instanceID" : 768,
    "monitoring" : false,
    "metricType" : "STO_VOLUME_TOTAL_XFER_RATE",
    "displayName" : "Volume IO Rate",
    "unit" : "MBps",
    "proportion" : false,
    "thresholdValueOfWarning" : 421.0,
    "thresholdValueOfError" : 450.0,
    "stepSize" : 1.0,
    "max" : 3.4028235E38,
    "min" : 0.0
  }, {
    "instanceID" : 767,
    "monitoring" : true,
    "metricType" : "STO_IO_RESPONSE_TIME_ON_CTRL0",
    "displayName" : "Volume Response Time Per IO Request,
    "unit" : "msec/transfer",
    "proportion" : false,
    "thresholdValueOfWarning" : 499.9,
    "thresholdValueOfError" : 500.1,
    "stepSize" : 0.1,
    "max" : 3.4028235E38,
    "min" : 0.0
  } ],
  "numOfResources" : 0,
  "autoAssignFilters" : [ ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.4.4　ユーザープロファイルの更新

指定したユーザープロファイルの更新を行います。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

PUT http[s]://host:port/Analytics/version/objects/UserThresholdProfiles/{id}

リクエストボディー

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

UserThresholdProfile

{
        "profileName":"...",
        "description":"...",
        "resourceType":"...",
        "profileType":"...",
        "thresholdValues":[{
            "monitoring":"...",
            "metricType":"...",
            "displayName":"...",
            "unit":"...",
            "proportion":"...",
            "thresholdValueOfWarning":"...",
            "thresholdValueOfError":"...",
            "stepSize":"...",
            "max":"...",
            "min":"..."
        },
        :
        ]
}

UserThresholdProfile (Type: UserThresholdProfile)

属性

データ型

説明

profileName

string

ユーザープロファイルの名称。128文字以下の文字列を指定します。

description

string

ユーザープロファイルの説明。256文字以下の文字列を指定します。

resourceType

string

ユーザープロファイルが適用できるリソース種別。以下の値のみ指定可能。

・VM:仮想マシン

・VOLUME:ボリューム

・WINDOWS:Windows

・LINUX_UNIX:LinuxまたはUNIX

profileType

string

ユーザープロファイルの変更種別

・User:ユーザーが作成したプロファイル

・Default:デフォルトで登録されているプロファイル

・Preset:初期値が設定されたプロファイル

thresholdValues

UserThresholdValue[]

ユーザープロファイルに設定されているしきい値の内容。

thresholdValues (Type: UserThresholdValue)

属性

データ型

説明

monitoring

boolean

監視しているしきい値かどうか。

・true:監視している。

・false:監視していない。

省略時はfalseが設定されます。

metricType

string

しきい値の識別子。未サポートのメンバーです。

displayName

string

しきい値の表示名。

unit

string

しきい値の単位を表す文字列。

proportion

boolean

しきい値の方向。

true:測定値がしきい値を下回る場合に異常または警告となる。

false:測定値がしきい値を上回る場合に異常または警告になる。

thresholdValueOfWarning

float

警告を表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。

・stepSizeの倍数

・max以下

・min以上

thresholdValueOfError

float

エラーを表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。

・stepSizeの倍数

・max以下

・min以上

stepSize

float

しきい値の増加量。

max

double

しきい値がとりえる最大値。

min

double

しきい値がとりえる最小値。

レスポンスボディー

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

UserThresholdProfile

{
        "instanceID":"...",
        "profileName":"...",
        "description":"...",
        "resourceType":"...",
        "profileType":"...",
        "thresholdValues":[{
            "instanceID":"...",
            "monitoring":"...",
            "metricType":"...",
            "displayName":"...",
            "unit":"...",
            "proportion":"...",
            "thresholdValueOfWarning":"...",
            "thresholdValueOfError":"...",
            "stepSize":"...",
            "max":"...",
            "min":"..."
        },
        :
        ],
        "numOfResources":"...",
        "autoAssignFilters":["...", ...]
}

UserThresholdProfile (Type: UserThresholdProfile)

属性

データ型

説明

instanceID

long

インスタンスを特定するID。

profileName

string

ユーザープロファイルの名称。128文字以下の文字列を指定します。

description

string

ユーザープロファイルの説明。256文字以下の文字列を指定します。

resourceType

string

ユーザープロファイルが適用できるリソース種別。以下の値のみ指定可能。

・VM:仮想マシン

・VOLUME:ボリューム

・WINDOWS:Windows

・LINUX_UNIX:LinuxまたはUNIX

profileType

string

ユーザープロファイルの変更種別

・User:ユーザーが作成したプロファイル

・Default:デフォルトで登録されているプロファイル

・Preset:初期値が設定されたプロファイル

thresholdValues

UserThresholdValue[]

ユーザープロファイルに設定されているしきい値の内容。

numOfResources

int

ユーザープロファイルが割り当たっているリソースの数

autoAssignFilters

string[]

自動割り当てルールのルール名。

thresholdValues (Type: UserThresholdValue)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

monitoring

boolean

監視しているしきい値かどうか。

・true:監視している。

・false:監視していない。

省略時はfalseが設定されます。

metricType

string

しきい値の識別子。未サポートのメンバーです。

displayName

string

しきい値の表示名。

unit

string

しきい値の単位を表す文字列。

proportion

boolean

しきい値の方向。

true:測定値がしきい値を下回る場合に異常または警告となる。

false:測定値がしきい値を上回る場合に異常または警告になる。

thresholdValueOfWarning

float

警告を表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。

・stepSizeの倍数

・max以下

・min以上

thresholdValueOfError

float

エラーを表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。

・stepSizeの倍数

・max以下

・min以上

stepSize

float

しきい値の増加量。

max

double

しきい値がとりえる最大値。

min

double

しきい値がとりえる最小値。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

400

Bad Request

リクエストボディ形式不正

401

Unauthorized

ログイン権限がない

403

Forbidden

更新権限がない

404

Not Found

リソースが存在しない

409

Conflict

nameが一致するリソースが存在する

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
PUT /Analytics/v1/objects/UserThresholdProfiles/63 HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 1331

[Request Body]
{
"instanceID" : 63,
"profileName" : "Default Profile for Volume",
"description" : "Default Profile for Volume",
"resourceType" : "VOLUME",
"profileType" : "User",
"thresholdValues" : [ {
"instanceID" : 763,
"monitoring" : false,
"metricType" : "STO_VOLUME_TOTAL_IO_RATE",
"displayName" : "Volume IOPS",
"unit" : "transfers/sec",
"proportion" : false,
"thresholdValueOfWarning" : 0.0,
"thresholdValueOfError" : 2222.0,
"stepSize" : 1.0,
"max" : 3.4028235E38,
"min" : 0.0
}, {
"instanceID" : 761,
"monitoring" : false,
"metricType" : "STO_VOLUME_TOTAL_XFER_RATE",
"displayName" : "Volume IO Rate",
"unit" : "MBps",
"proportion" : false,
"thresholdValueOfWarning" : 421.0,
"thresholdValueOfError" : 450.0,
"stepSize" : 1.0,
"max" : 3.4028235E38,
"min" : 0.0
}, {
"instanceID" : 762,
"monitoring" : true,
"metricType" : "STO_IO_RESPONSE_TIME_ON_CTRL0",
"displayName" : "Volume Response Time Per IO Request",
"unit" : "msec/transfer",
"proportion" : false,
"thresholdValueOfWarning" : 499.9,
"thresholdValueOfError" : 500.1,
"stepSize" : 0.1,
"max" : 3.4028235E38,
"min" : 0.0
} ],
"numOfResources" : 0,
"autoAssignFilters" : [ ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 08:42:46 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO e6ef783f42e697183f8c7a8539cf44beed12e8c_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
"instanceID" : 63,
"profileName" : "Default Profile for Volume",
"description" : "Default Profile for Volume",
"resourceType" : "VOLUME",
"profileType" : "User",
"thresholdValues" : [ {
"instanceID" : 769,
"monitoring" : false,
"metricType" : "STO_VOLUME_TOTAL_IO_RATE",
"displayName" : "Volume IOPS",
"unit" : "transfers/sec",
"proportion" : false,
"thresholdValueOfWarning" : 0.0,
"thresholdValueOfError" : 2222.0,
"stepSize" : 1.0,
"max" : 3.4028235E38,
"min" : 0.0
}, {
"instanceID" : 768,
"monitoring" : false,
"metricType" : "STO_VOLUME_TOTAL_XFER_RATE",
"displayName" : "Volume IO Rate",
"unit" : "MBps",
"proportion" : false,
"thresholdValueOfWarning" : 421.0,
"thresholdValueOfError" : 450.0,
"stepSize" : 1.0,
"max" : 3.4028235E38,
"min" : 0.0
}, {
"instanceID" : 767,
"monitoring" : true,
"metricType" : "STO_IO_RESPONSE_TIME_ON_CTRL0",
"displayName" : "Volume Response Time Per IO Request",
"unit" : "msec/transfer",
"proportion" : false,
"thresholdValueOfWarning" : 499.9,
"thresholdValueOfError" : 500.1,
"stepSize" : 0.1,
"max" : 3.4028235E38,
"min" : 0.0
} ],
"numOfResources" : 0,
"autoAssignFilters" : [ ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.4.5　ユーザープロファイルの削除

指定したユーザープロファイルを削除します。削除したユーザープロファイルが割り当てられた監視対象リソースは，デフォルトのユーザープロファイルが再割り当てされます。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

DELETE http[s]://host:port/Analytics/version/objects/UserThresholdProfiles/{id}

リクエストボディー

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

レスポンスボディー

レスポンスボディーは出力されません。

ステータスコード

HTTPステータスコード

Reason phrase

説明

204

No Content

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

削除権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
DELETE /Analytics/v1/objects/UserThresholdProfiles/63 HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 204 No Content
Date: Fri, 27 Nov 2015 11:24:22 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO ca54892ac23952deaf9c5aa71d7eb117d5f5e0c1_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Content-Length: 0
Content-Type: application/json

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.4.6　ユーザープロファイルに対する操作一覧の取得

指定したユーザープロファイルに対して実行できる操作の一覧を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/UserThresholdProfiles/{id}/actions

リクエストボディー

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

レスポンスボディー

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

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性

データ型

説明

data

anyType[]

Action のコレクション。 Action の詳細は以下の表を参照ください。

pagination

Pagination

ページ情報。リソースが存在しない場合、このパラメータは表示されません。

count

int

条件に合致したデータの個数

pagination (Type: Pagination)

属性

データ型

説明

page

integer

ページ

pageSize

integer

ページサイズ

numPages

integer

ページの数

totalCount

integer

オブジェクトの数

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要なコレクション。空欄です。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/UserThresholdProfiles/62/actions HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 08:52:29 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 6e5ebd331dec95678b4ba4fa76694f61b8bb7_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "name" : "updateTargetResource",
    "href" : "http://localhost:22015/Analytics/v1/objects/UserThresholdProfiles/62/actions/updateTargetResource/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  } ],
  "count" : 1
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.4.7　ユーザープロファイルの割り当てに必要な情報の取得

指定したユーザープロファイルを監視対象リソースに割り当てるために必要な情報を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/UserThresholdProfiles/{id}/actions/updateTargetResource

リクエストボディー

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

レスポンスボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な InstanceID のコレクション。 InstanceID の詳細は以下の表を参照ください。

InstanceID

{
        "instanceID":"..."
}

InstanceID (Type: InstanceID)

属性

データ型

説明

instanceID

long

インスタンスID

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/UserThresholdProfiles/62/actions/updateTargetResource HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:01:05 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 5c177954bed8e8afe14a6e3b6c9e7607d453e1_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "updateTargetResource",
  "href" : "http://localhost:22015/Analytics/v1/objects/UserThresholdProfiles/62/actions/updateTargetResource/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.4.8　ユーザープロファイルの割り当て

指定したユーザープロファイルを監視対象に割り当てます。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

POST http[s]://host:port/Analytics/version/objects/UserThresholdProfiles/{id}/actions/updateTargetResource/invoke

リクエストボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な InstanceID のコレクション。 InstanceID の詳細は以下の表を参照ください。

InstanceID

{
        "instanceID":"..."
}

InstanceID (Type: InstanceID)

属性

データ型

説明

instanceID

long

インスタンスID

レスポンスボディー

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

Job

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

属性

データ型

説明

instanceID

string

インスタンスのIDを示します。

created

string

オブジェクトの生成日付を示します。ISO8601形式です。

updated

string

オブジェクトが更新された時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

completed

string

処理が完了した時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

state

string

以下の値が設定されます。

“failed”: 操作が正常終了しなかったことを示します。

“success”: 操作が正常終了したことを示します。

affectedResource

string[]

操作の結果，作成または更新されたAPIのリソースのURLを示します。リソースが存在しない場合、このパラメータは空欄です。

result

anyType[]

実行結果のコレクション。空欄です。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

400

Bad Request

リクエストボディ形式不正

401

Unauthorized

ログイン権限がない

403

Forbidden

更新権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
POST /Analytics/v1/objects/UserThresholdProfiles/62/actions/updateTargetResource/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 251

[Request Body]
{
  "name" : "updateTargetResource",
  "href" : "http://localhost:22015/Analytics/v1/objects/UserThresholdProfiles/62/actions/updateTargetResource/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "instanceID" : 540
  },{
    "instanceID" : 541
  }]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:16:00 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 64b88abff57b911327c0d26c6394beea311ae7a_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "7bdbb872-18a0-42dd-9481-51ca3f66758c",
  "created" : "2015-11-27T18:16:00.996+09:00",
  "updated" : "2015-11-27T18:16:01.372+09:00",
  "completed" : "2015-11-27T18:16:01.373+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.5　システムプロファイルに関するAPI一覧

JP1/OAが監視対象の監視に使用するユーザープロファイルの操作を説明します。

2.5.1　システムプロファイルの一覧の取得

システムプロファイルの一覧を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/SystemThresholdProfiles

リクエストボディー

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

レスポンスボディー

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

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性

データ型

説明

data

anyType[]

SystemThresholdProfile のコレクション。 SystemThresholdProfile の詳細は以下の表を参照ください。

pagination

Pagination

ページ情報。リソースが存在しない場合、このパラメータは表示されません。

count

int

条件に合致したデータの個数

pagination (Type: Pagination)

属性

データ型

説明

page

integer

ページ

pageSize

integer

ページサイズ

numPages

integer

ページの数

totalCount

integer

オブジェクトの数

SystemThresholdProfile

{
        "instanceID":"...",
        "profileName":"...",
        "description":"...",
        "resourceType":"...",
        "profileType":"...",
        "thresholdValues":[{
            "instanceID":"...",
            "monitoring":"...",
            "metricType":"...",
            "displayName":"...",
            "unit":"...",
            "proportion":"...",
            "thresholdValueOfWarning":"...",
            "thresholdValueOfError":"...",
            "stepSize":"...",
            "max":"...",
            "min":"..."
        },
        :
        ],
        "numOfResources":"..."
}

SystemThresholdProfile (Type: SystemThresholdProfile)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

profileName

string

システムプロファイルの名称。128文字以下の文字列を指定します。

description

string

システムプロファイルの説明。256文字以下の文字列を指定します。

resourceType

string

システムプロファイルが適用できるリソース種別。

・ESX:ESXサーバ

・HYPERV:Hyper-Vサーバ

・IPSWITCH:IPスイッチ

・FCSWITCH:FCスイッチ

profileType

string

システムプロファイルの変更種別

・User:ユーザーが作成したプロファイル

・Default:デフォルトで登録されているプロファイル

・Preset:初期値が設定されたプロファイル

thresholdValues

SystemThresholdValue[]

システムプロファイルに設定されているしきい値の内容。

numOfResources

int

システムプロファイルが割り当たっているリソースの数

thresholdValues (Type: SystemThresholdValue)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

monitoring

boolean

監視しているしきい値かどうか。

・true:監視している。

・false:監視していない。

省略時はfalseが設定されます。

metricType

string

しきい値の識別子。未サポートのメンバーです。

displayName

string

しきい値の表示名。

unit

string

しきい値の単位を表す文字列。

proportion

boolean

しきい値の方向。

・true:測定値がしきい値を下回る場合に異常または警告となる。

・false:測定値がしきい値を上回る場合に異常または警告になる。

thresholdValueOfWarning

float

警告を表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。

・stepSizeの倍数

・max以下

・min以上

thresholdValueOfError

float

エラーを表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。

・stepSizeの倍数

・max以下

・min以上

stepSize

float

しきい値の増加量。

max

double

しきい値がとりえる最大値。

min

double

しきい値がとりえる最小値。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

400

Bad Request

クエリパラメータ不正

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/SystemThresholdProfiles HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 05:21:49 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO d4ca28827d6fe35b964eeece674e3fbda29b5a11_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "instanceID" : 23,
    "profileName" : "Default Profile for Hyper-V",
    "description" : "Default Profile for Hyper-V",
    "resourceType" : "HYPERV",
    "profileType" : "Default",
    "thresholdValues" : [ {
      "instanceID" : 539,
      "monitoring" : true,
      "metricType" : "WIN_CPU_LOAD",
      "displayName" : "CPU Use",
      "unit" : "%",
      "proportion" : false,
      "thresholdValueOfWarning" : 80.0,
      "thresholdValueOfError" : 90.0,
      "stepSize" : 1.0,
      "max" : 100.0,
      "min" : 0.0
    }, {
      ..........
    },
    ..........
  ],
  "numOfResources" : 0
}
  "count" : 8
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.5.2　システムプロファイルの情報取得

指定したシステムプロファイルの情報を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/SystemThresholdProfiles/{id}

リクエストボディー

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

レスポンスボディー

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

SystemThresholdProfile

{
        "instanceID":"...",
        "profileName":"...",
        "description":"...",
        "resourceType":"...",
        "profileType":"...",
        "thresholdValues":[{
            "instanceID":"...",
            "monitoring":"...",
            "metricType":"...",
            "displayName":"...",
            "unit":"...",
            "proportion":"...",
            "thresholdValueOfWarning":"...",
            "thresholdValueOfError":"...",
            "stepSize":"...",
            "max":"...",
            "min":"..."
        },
        :
        ],
        "numOfResources":"..."
}

SystemThresholdProfile (Type: SystemThresholdProfile)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

profileName

string

システムプロファイルの名称。128文字以下の文字列を指定します。

description

string

システムプロファイルの説明。256文字以下の文字列を指定します。

resourceType

string

システムプロファイルが適用できるリソース種別。

・ESX:ESXサーバ

・HYPERV:Hyper-Vサーバ

・IPSWITCH:IPスイッチ

・FCSWITCH:FCスイッチ

profileType

string

システムプロファイルの変更種別

・User:ユーザーが作成したプロファイル

・Default:デフォルトで登録されているプロファイル

・Preset:初期値が設定されたプロファイル

thresholdValues

SystemThresholdValue[]

システムプロファイルに設定されているしきい値の内容。

numOfResources

int

システムプロファイルが割り当たっているリソースの数

thresholdValues (Type: SystemThresholdValue)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

monitoring

boolean

監視しているしきい値かどうか。

・true:監視している。

・false:監視していない。

省略時はfalseが設定されます。

metricType

string

しきい値の識別子。未サポートのメンバーです。

displayName

string

しきい値の表示名。

unit

string

しきい値の単位を表す文字列。

proportion

boolean

しきい値の方向。

・true:測定値がしきい値を下回る場合に異常または警告となる。

・false:測定値がしきい値を上回る場合に異常または警告になる。

thresholdValueOfWarning

float

警告を表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。

・stepSizeの倍数

・max以下

・min以上

thresholdValueOfError

float

エラーを表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。

・stepSizeの倍数

・max以下

・min以上

stepSize

float

しきい値の増加量。

max

double

しきい値がとりえる最大値。

min

double

しきい値がとりえる最小値。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/SystemThresholdProfiles/23 HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 07:19:45 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 15b057d2c5566e657ce642a6811075512e0cb95_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
"instanceID" : 23,
"profileName" : "Default Profile for Hyper-V",
"description" : "Default Profile for Hyper-V",
"resourceType" : "HYPERV",
"profileType" : "Default",
"thresholdValues" : [ {
"instanceID" : 539,
"monitoring" : true,
"metricType" : "WIN_CPU_LOAD",
"displayName" : "CPU Use",
"unit" : "%",
"proportion" : false,
"thresholdValueOfWarning" : 80.0,
"thresholdValueOfError" : 90.0,
"stepSize" : 1.0,
"max" : 100.0,
"min" : 0.0
}, {
.......
},
.......
],
"numOfResources" : 1
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.5.3　システムプロファイルの作成

システムプロファイルを新規に作成します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

POST http[s]://host:port/Analytics/version/objects/SystemThresholdProfiles

リクエストボディー

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

SystemThresholdProfile

{
        "profileName":"...",
        "description":"...",
        "resourceType":"...",
        "profileType":"...",
        "thresholdValues":[{
            "monitoring":"...",
            "metricType":"...",
            "displayName":"...",
            "unit":"...",
            "proportion":"...",
            "thresholdValueOfWarning":"...",
            "thresholdValueOfError":"...",
            "stepSize":"...",
            "max":"...",
            "min":"..."
        },
        :
        ]
}

SystemThresholdProfile (Type: SystemThresholdProfile)

属性

データ型

説明

profileName

string

システムプロファイルの名称。128文字以下の文字列を指定します。

description

string

システムプロファイルの説明。256文字以下の文字列を指定します。

resourceType

string

システムプロファイルが適用できるリソース種別。

・ESX:ESXサーバ

・HYPERV:Hyper-Vサーバ

・IPSWITCH:IPスイッチ

・FCSWITCH:FCスイッチ

profileType

string

システムプロファイルの変更種別

・User:ユーザーが作成したプロファイル

・Default:デフォルトで登録されているプロファイル

・Preset:初期値が設定されたプロファイル

thresholdValues

SystemThresholdValue[]

システムプロファイルに設定されているしきい値の内容。

thresholdValues (Type: SystemThresholdValue)

属性

データ型

説明

monitoring

boolean

監視しているしきい値かどうか。

・true:監視している。

・false:監視していない。

省略時はfalseが設定されます。

metricType

string

しきい値の識別子。未サポートのメンバーです。

displayName

string

しきい値の表示名。

unit

string

しきい値の単位を表す文字列。

proportion

boolean

しきい値の方向。

・true:測定値がしきい値を下回る場合に異常または警告となる。

・false:測定値がしきい値を上回る場合に異常または警告になる。

thresholdValueOfWarning

float

警告を表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。

・stepSizeの倍数

・max以下

・min以上

thresholdValueOfError

float

エラーを表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。

・stepSizeの倍数

・max以下

・min以上

stepSize

float

しきい値の増加量。

max

double

しきい値がとりえる最大値。

min

double

しきい値がとりえる最小値。

レスポンスボディー

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

SystemThresholdProfile

{
        "instanceID":"...",
        "profileName":"...",
        "description":"...",
        "resourceType":"...",
        "profileType":"...",
        "thresholdValues":[{
            "instanceID":"...",
            "monitoring":"...",
            "metricType":"...",
            "displayName":"...",
            "unit":"...",
            "proportion":"...",
            "thresholdValueOfWarning":"...",
            "thresholdValueOfError":"...",
            "stepSize":"...",
            "max":"...",
            "min":"..."
        },
        :
        ],
        "numOfResources":"..."
}

SystemThresholdProfile (Type: SystemThresholdProfile)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

profileName

string

システムプロファイルの名称。128文字以下の文字列を指定します。

description

string

システムプロファイルの説明。256文字以下の文字列を指定します。

resourceType

string

システムプロファイルが適用できるリソース種別。

・ESX:ESXサーバ

・HYPERV:Hyper-Vサーバ

・IPSWITCH:IPスイッチ

・FCSWITCH:FCスイッチ

profileType

string

システムプロファイルの変更種別

・User:ユーザーが作成したプロファイル

・Default:デフォルトで登録されているプロファイル

・Preset:初期値が設定されたプロファイル

thresholdValues

SystemThresholdValue[]

システムプロファイルに設定されているしきい値の内容。

numOfResources

int

システムプロファイルが割り当たっているリソースの数

thresholdValues (Type: SystemThresholdValue)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

monitoring

boolean

監視しているしきい値かどうか。

・true:監視している。

・false:監視していない。

省略時はfalseが設定されます。

metricType

string

しきい値の識別子。未サポートのメンバーです。

displayName

string

しきい値の表示名。

unit

string

しきい値の単位を表す文字列。

proportion

boolean

しきい値の方向。

・true:測定値がしきい値を下回る場合に異常または警告となる。

・false:測定値がしきい値を上回る場合に異常または警告になる。

thresholdValueOfWarning

float

警告を表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。

・stepSizeの倍数

・max以下

・min以上

thresholdValueOfError

float

エラーを表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。

・stepSizeの倍数

・max以下

・min以上

stepSize

float

しきい値の増加量。

max

double

しきい値がとりえる最大値。

min

double

しきい値がとりえる最小値。

ステータスコード

HTTPステータスコード

Reason phrase

説明

201

Created

正常終了

400

Bad Request

リクエストボディ形式不正

401

Unauthorized

ログイン権限がない

403

Forbidden

更新権限がない

404

Not Found

リソースが存在しない

409

Conflict

nameが一致するリソースが存在する

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
POST /Analytics/v1/objects/SystemThresholdProfiles HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 6861
Expect: 100-continue

[Request Body]
{
"instanceID" : 23,
"profileName" : "Default Profile for Hyper-V",
"description" : "Default Profile for Hyper-V",
"resourceType" : "HYPERV",
"profileType" : "User",
"thresholdValues" : [ {
"instanceID" : 539,
"monitoring" : true,
"metricType" : "WIN_CPU_LOAD",
"displayName" : "CPU Use",
"unit" : "%",
"proportion" : false,
"thresholdValueOfWarning" : 80.0,
"thresholdValueOfError" : 90.0,
"stepSize" : 1.0,
"max" : 100.0,
"min" : 0.0
211
}, {
......
},
......
],
"numOfResources" : 1
}

[Response Header]
HTTP/1.1 100 Continue
HTTP/1.1 201 Created
Date: Fri, 27 Nov 2015 07:59:59 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 2dfd66512c3fb3d859df167fc452989dd389797_WVlGcHsLfg5ffg0I_V0810
Location: http://localhost:22015/Analytics/v1/objects/SystemThresholdProfiles/64
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
"instanceID" : 64,
"profileName" : "Default Profile for Hyper-V",
"description" : "Default Profile for Hyper-V",
"resourceType" : "HYPERV",
"profileType" : "User",
"thresholdValues" : [ {
"instanceID" : 807,
"monitoring" : true,
"metricType" : "WIN_CPU_LOAD",
"displayName" : "CPU Use",
"unit" : "%",
"proportion" : false,
"thresholdValueOfWarning" : 80.0,
"thresholdValueOfError" : 90.0,
"stepSize" : 1.0,
"max" : 100.0,
"min" : 0.0
}, {
......
},
......
],
"numOfResources" : 0
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.5.4　システムプロファイルの更新

指定したシステムプロファイルの更新を行います。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

PUT http[s]://host:port/Analytics/version/objects/SystemThresholdProfiles/{id}

リクエストボディー

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

SystemThresholdProfile

{
        "profileName":"...",
        "description":"...",
        "resourceType":"...",
        "profileType":"...",
        "thresholdValues":[{
            "monitoring":"...",
            "metricType":"...",
            "displayName":"...",
            "unit":"...",
            "proportion":"...",
            "thresholdValueOfWarning":"...",
            "thresholdValueOfError":"...",
            "stepSize":"...",
            "max":"...",
            "min":"..."
        },
        :
        ]
}

SystemThresholdProfile (Type: SystemThresholdProfile)

属性

データ型

説明

profileName

string

システムプロファイルの名称。128文字以下の文字列を指定します。

description

string

システムプロファイルの説明。256文字以下の文字列を指定します。

resourceType

string

システムプロファイルが適用できるリソース種別。

・ESX:ESXサーバ

・HYPERV:Hyper-Vサーバ

・IPSWITCH:IPスイッチ

・FCSWITCH:FCスイッチ

profileType

string

システムプロファイルの変更種別

・User:ユーザーが作成したプロファイル

・Default:デフォルトで登録されているプロファイル

・Preset:初期値が設定されたプロファイル

thresholdValues

SystemThresholdValue[]

システムプロファイルに設定されているしきい値の内容。

thresholdValues (Type: SystemThresholdValue)

属性

データ型

説明

monitoring

boolean

監視しているしきい値かどうか。

・true:監視している。

・false:監視していない。

省略時はfalseが設定されます。

metricType

string

しきい値の識別子。未サポートのメンバーです。

displayName

string

しきい値の表示名。

unit

string

しきい値の単位を表す文字列。

proportion

boolean

しきい値の方向。

・true:測定値がしきい値を下回る場合に異常または警告となる。

・false:測定値がしきい値を上回る場合に異常または警告になる。

thresholdValueOfWarning

float

警告を表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。

・stepSizeの倍数

・max以下

・min以上

thresholdValueOfError

float

エラーを表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。

・stepSizeの倍数

・max以下

・min以上

stepSize

float

しきい値の増加量。

max

double

しきい値がとりえる最大値。

min

double

しきい値がとりえる最小値。

レスポンスボディー

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

SystemThresholdProfile

{
        "instanceID":"...",
        "profileName":"...",
        "description":"...",
        "resourceType":"...",
        "profileType":"...",
        "thresholdValues":[{
            "instanceID":"...",
            "monitoring":"...",
            "metricType":"...",
            "displayName":"...",
            "unit":"...",
            "proportion":"...",
            "thresholdValueOfWarning":"...",
            "thresholdValueOfError":"...",
            "stepSize":"...",
            "max":"...",
            "min":"..."
        },
        :
        ],
        "numOfResources":"..."
}

SystemThresholdProfile (Type: SystemThresholdProfile)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

profileName

string

システムプロファイルの名称。128文字以下の文字列を指定します。

description

string

システムプロファイルの説明。256文字以下の文字列を指定します。

resourceType

string

システムプロファイルが適用できるリソース種別。

・ESX:ESXサーバ

・HYPERV:Hyper-Vサーバ

・IPSWITCH:IPスイッチ

・FCSWITCH:FCスイッチ

profileType

string

システムプロファイルの変更種別

・User:ユーザーが作成したプロファイル

・Default:デフォルトで登録されているプロファイル

・Preset:初期値が設定されたプロファイル

thresholdValues

SystemThresholdValue[]

システムプロファイルに設定されているしきい値の内容。

numOfResources

int

システムプロファイルが割り当たっているリソースの数

thresholdValues (Type: SystemThresholdValue)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

monitoring

boolean

監視しているしきい値かどうか。

・true:監視している。

・false:監視していない。

省略時はfalseが設定されます。

metricType

string

しきい値の識別子。未サポートのメンバーです。

displayName

string

しきい値の表示名。

unit

string

しきい値の単位を表す文字列。

proportion

boolean

しきい値の方向。

・true:測定値がしきい値を下回る場合に異常または警告となる。

・false:測定値がしきい値を上回る場合に異常または警告になる。

thresholdValueOfWarning

float

警告を表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。

・stepSizeの倍数

・max以下

・min以上

thresholdValueOfError

float

エラーを表すしきい値。しきい値は以下の条件に合わせて指定する必要があります。

・stepSizeの倍数

・max以下

・min以上

stepSize

float

しきい値の増加量。

max

double

しきい値がとりえる最大値。

min

double

しきい値がとりえる最小値。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

400

Bad Request

リクエストボディ形式不正

401

Unauthorized

ログイン権限がない

403

Forbidden

更新権限がない

404

Not Found

リソースが存在しない

409

Conflict

nameが一致するリソースが存在する

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
PUT /Analytics/v1/objects/SystemThresholdProfiles/64 HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 6861

[Request Body]
{
  "instanceID" : 64,
  "profileName" : "Default Profile for Hyper-V",
  "description" : "Default Profile for Hyper-V",
  "resourceType" : "HYPERV",
  "profileType" : "User",
  "thresholdValues" : [ {
    "instanceID" : 807,
    "monitoring" : true,
    "metricType" : "WIN_CPU_LOAD",
    "displayName" : "CPU Use",
    "unit" : "%",
    "proportion" : false,
    "thresholdValueOfWarning" : 80.0,
    "thresholdValueOfError" : 90.0,
    "stepSize" : 1.0,
    "max" : 100.0,
    "min" : 0.0
  }, {
    ......
},
......
],
"numOfResources" : 0
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 08:42:46 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO ef29b28697744f4dbd5de75038b9fb5aea9f502_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : 64,
  "profileName" : "Default Profile for Hyper-V",
  "description" : "Default Profile for Hyper-V",
  "resourceType" : "HYPERV",
  "profileType" : "User",
  "thresholdValues" : [ {
    "instanceID" : 807,
    "monitoring" : true,
    "metricType" : "WIN_CPU_LOAD",
    "displayName" : " CPU Use",
    "unit" : "%",
    "proportion" : false,
    "thresholdValueOfWarning" : 80.0,
    "thresholdValueOfError" : 90.0,
    "stepSize" : 1.0,
    "max" : 100.0,
    "min" : 0.0
  }, {
    ......
  },
  ......
  ],
  "numOfResources" : 0
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.5.5　システムプロファイルの削除

指定したシステムプロファイルを削除します。削除したシステムプロファイルが割り当てられた監視対象リソースは，デフォルトのシステムプロファイルが再割り当てされます。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

DELETE http[s]://host:port/Analytics/version/objects/SystemThresholdProfiles/{id}

リクエストボディー

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

レスポンスボディー

レスポンスボディーは出力されません。

ステータスコード

HTTPステータスコード

Reason phrase

説明

204

No Content

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

削除権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
DELETE /Analytics/v1/objects/SystemThresholdProfiles/64 HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 204 No Content
Date: Fri, 27 Nov 2015 11:24:22 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO cb3bc1b920fd9b534c57538990506d5ab5258cc_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Content-Length: 0
Content-Type: application/json

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.5.6　システムプロファイルに対する操作一覧の取得

指定したシステムプロファイルに対して実行できる操作の一覧を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/SystemThresholdProfiles/{id}/actions

リクエストボディー

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

レスポンスボディー

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

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性

データ型

説明

data

anyType[]

Action のコレクション。 Action の詳細は以下の表を参照ください。

pagination

Pagination

ページ情報。リソースが存在しない場合、このパラメータは表示されません。

count

int

条件に合致したデータの個数

pagination (Type: Pagination)

属性

データ型

説明

page

integer

ページ

pageSize

integer

ページサイズ

numPages

integer

ページの数

totalCount

integer

オブジェクトの数

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要なコレクション。空欄です。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/SystemThresholdProfiles/23/actions HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 08:52:29 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 4d3178ead3e093e934287dcb05187272788ae5c_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "name" : "updateTargetResource",
    "href" : "http://localhost:22015/Analytics/v1/objects/SystemThresholdProfiles/23/actions/updateTargetResource/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  } ],
  "count" : 1
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.5.7　システムプロファイルの割り当てに必要な情報の取得

指定したシステムプロファイルを監視対象リソースに割り当てるために必要な情報を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/SystemThresholdProfiles/{id}/actions/updateTargetResource

リクエストボディー

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

レスポンスボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な InstanceID のコレクション。 InstanceID の詳細は以下の表を参照ください。

InstanceID

{
        "instanceID":"..."
}

InstanceID (Type: InstanceID)

属性

データ型

説明

instanceID

long

インスタンスID

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/SystemThresholdProfiles/23/actions/updateTargetResource HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:01:05 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO b996edeeab148c282cf3cbeb6cbec37584796239_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "updateTargetResource",
  "href" : "http://localhost:22015/Analytics/v1/objects/SystemThresholdProfiles/23/actions/updateTargetResource/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "instanceID" : 4
  } ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.5.8　システムプロファイルの割り当て

指定したシステムプロファイルを監視対象に割り当てます。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

POST http[s]://host:port/Analytics/version/objects/SystemThresholdProfiles/{id}/actions/updateTargetResource/invoke

リクエストボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な InstanceID のコレクション。 InstanceID の詳細は以下の表を参照ください。

InstanceID

{
        "instanceID":"..."
}

InstanceID (Type: InstanceID)

属性

データ型

説明

instanceID

long

インスタンスID

レスポンスボディー

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

Job

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

属性

データ型

説明

instanceID

string

インスタンスのIDを示します。

created

string

オブジェクトの生成日付を示します。ISO8601形式です。

updated

string

オブジェクトが更新された時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

completed

string

処理が完了した時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

state

string

以下の値が設定されます。

“failed”: 操作が正常終了しなかったことを示します。

“success”: 操作が正常終了したことを示します。

affectedResource

string[]

操作の結果，作成または更新されたAPIのリソースのURLを示します。リソースが存在しない場合、このパラメータは空欄です。

result

anyType[]

実行結果のコレクション。空欄です。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

400

Bad Request

リクエストボディ形式不正

401

Unauthorized

ログイン権限がない

403

Forbidden

更新権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
POST /Analytics/v1/objects/SystemThresholdProfiles/23/actions/updateTargetResource/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 251

[Request Body]
{
  "name" : "updateTargetResource",
  "href" : "http://localhost:22015/Analytics/v1/objects/SystemThresholdProfiles/23/actions/updateTargetResource/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "instanceID" : 4
  } ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:11:06 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 2cf2b949bc23ff176de6c674e95e8d7b2cb3148_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "2d8efa39-3ce7-475e-a0a3-7e16504edb97",
  "created" : "2015-11-27T18:11:06.459+09:00",
  "updated" : "2015-11-27T18:11:06.525+09:00",
  "completed" : "2015-11-27T18:11:06.526+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.6　コンシューマーに関するAPI一覧

コンシューマーとコンシューマーに設定するグレードの操作を説明します。

2.6.1　コンシューマーの一覧の取得

コンシューマーの一覧を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/Groups

リクエストボディー

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

レスポンスボディー

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

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性

データ型

説明

data

anyType[]

Group のコレクション。 Group の詳細は以下の表を参照ください。

pagination

Pagination

ページ情報。リソースが存在しない場合、このパラメータは表示されません。

count

int

条件に合致したデータの個数

pagination (Type: Pagination)

属性

データ型

説明

page

integer

ページ

pageSize

integer

ページサイズ

numPages

integer

ページの数

totalCount

integer

オブジェクトの数

Group

{
        "instanceID":"...",
        "name":"...",
        "status":"...",
        "gradeKey":"...",
        "gradeName":"...",
        "gradeDisplayOrder":"...",
        "description":"...",
        "urls":["...", ...],
        "urlDisplayNames":["...", ...],
        "templateCreatorType":"...",
        "vmAutoAssignment":"...",
        "applicationAssignFollow":"...",
        "numOfVolumes":"...",
        "numOfVMs":"...",
        "numOfHosts":"...",
        "numOfHypervisors":"...",
        "numOfApplications":"...",
        "vmAutoAssignFilters":["...", ...],
        "hostAutoAssignFilters":["...", ...],
        "volumeIDs":["...", ...],
        "vmIDs":["...", ...],
        "hostIDs":["...", ...],
        "hypervisorIDs":["...", ...],
        "applicationIDs":["...", ...]
}

Group (Type: Group)

属性

データ型

説明

instanceID

long

インスタンスを特定するID。

name

string

コンシューマーの名称。128文字以下の文字列を指定します。

status

enum

コンシューマーの状態。

(指定可能な値は「列挙型一覧」のNodeStatusTypeの表を参照してください。)

以下に示す値のみ指定可能です。

Normal

Warning

Error

gradeKey

string

グレードを識別するID。

gradeName

string

グレードの名称。

gradeDisplayOrder

int

グレードの優先順位

description

string

コンシューマーの説明。1000文字以下の文字列を指定します。

urls

string[]

URL

urlDisplayNames

string[]

URLの表示文字列

templateCreatorType

enum

コンシューマーの変更種別

(指定可能な値は「列挙型一覧」のTemplateCreatorTypeの表を参照してください。)

以下に示す値のみ指定可能です。

User

Default

vmAutoAssignment

boolean

このコンシューマーに属するハイパーバイザー配下の仮想マシンを自動的に割り当てる場合にtrue

applicationAssignFollow

boolean

このコンシューマーに属するリソース配下のアプリケーションを自動的に割り当てる場合にtrue

numOfVolumes

int

コンシューマーが割り当てられているボリュームの数。

numOfVMs

int

コンシューマーが割り当てられている仮想マシンの数。

numOfHosts

int

コンシューマーが割り当てられているホストの数。

numOfHypervisors

int

コンシューマーが割り当てられているハイパーバイザーの数。

numOfApplications

int

コンシューマーが割り当てられているアプリケーションの数。

vmAutoAssignFilters

string[]

仮想サーバに設定されている自動割り当てルールのルール名。

hostAutoAssignFilters

string[]

ホストに設定されている自動割り当てルールのルール名。

volumeIDs

long[]

コンシューマーに割り当てられているボリュームを特定するIDのリスト

vmIDs

long[]

コンシューマーに割り当てられている仮想マシンを特定するIDのリスト

hostIDs

long[]

コンシューマーに割り当てられているホストを特定するIDのリスト

hypervisorIDs

long[]

コンシューマーに割り当てられているハイパーバイザーを特定するIDのリスト

applicationIDs

long[]

コンシューマーに割り当てられているアプリケーションを特定するIDのリスト

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

400

Bad Request

クエリパラメーター不正

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/Groups HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 05:21:50 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 3ffa18cbf3e9f46049c06aaf52a1c5444c5e2c3a_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "instanceID" : 0,
    "name" : "#Unassigned Resources",
    "description" : "Resources which have not been assigned to a consumer.",
    "templateCreatorType" : "Default",
    "numOfVolumes" : 0,
    "numOfVMs" : 27,
    "numOfHosts" : 0,
    "volumeAutoAssignFilters" : [ ],
    "vmAutoAssignFilters" : [ ],
    "hostAutoAssignFilters" : [ ]
  } ],
  "count" : 1
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.6.2　コンシューマーの情報取得

指定したコンシューマーの情報を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/Groups/{id}

リクエストボディー

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

レスポンスボディー

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

Group

{
        "instanceID":"...",
        "name":"...",
        "status":"...",
        "gradeKey":"...",
        "gradeName":"...",
        "gradeDisplayOrder":"...",
        "description":"...",
        "urls":["...", ...],
        "urlDisplayNames":["...", ...],
        "templateCreatorType":"...",
        "vmAutoAssignment":"...",
        "applicationAssignFollow":"...",
        "numOfVolumes":"...",
        "numOfVMs":"...",
        "numOfHosts":"...",
        "numOfHypervisors":"...",
        "numOfApplications":"...",
        "vmAutoAssignFilters":["...", ...],
        "hostAutoAssignFilters":["...", ...],
        "volumeIDs":["...", ...],
        "vmIDs":["...", ...],
        "hostIDs":["...", ...],
        "hypervisorIDs":["...", ...],
        "applicationIDs":["...", ...]
}

Group (Type: Group)

属性

データ型

説明

instanceID

long

インスタンスを特定するID。

name

string

コンシューマーの名称。128文字以下の文字列を指定します。

status

enum

コンシューマーの状態。

(指定可能な値は「列挙型一覧」のNodeStatusTypeの表を参照してください。)

以下に示す値のみ指定可能です。

Normal

Warning

Error

gradeKey

string

グレードを識別するID。

gradeName

string

グレードの名称。

gradeDisplayOrder

int

グレードの優先順位

description

string

コンシューマーの説明。1000文字以下の文字列を指定します。

urls

string[]

URL

urlDisplayNames

string[]

URLの表示文字列

templateCreatorType

enum

コンシューマーの変更種別

(指定可能な値は「列挙型一覧」のTemplateCreatorTypeの表を参照してください。)

以下に示す値のみ指定可能です。

User

Default

vmAutoAssignment

boolean

このコンシューマーに属するハイパーバイザー配下の仮想マシンを自動的に割り当てる場合にtrue

applicationAssignFollow

boolean

このコンシューマーに属するリソース配下のアプリケーションを自動的に割り当てる場合にtrue

numOfVolumes

int

コンシューマーが割り当てられているボリュームの数。

numOfVMs

int

コンシューマーが割り当てられている仮想マシンの数。

numOfHosts

int

コンシューマーが割り当てられているホストの数。

numOfHypervisors

int

コンシューマーが割り当てられているハイパーバイザーの数。

numOfApplications

int

コンシューマーが割り当てられているアプリケーションの数。

vmAutoAssignFilters

string[]

仮想サーバに設定されている自動割り当てルールのルール名。

hostAutoAssignFilters

string[]

ホストに設定されている自動割り当てルールのルール名。

volumeIDs

long[]

コンシューマーに割り当てられているボリュームを特定するIDのリスト

vmIDs

long[]

コンシューマーに割り当てられている仮想マシンを特定するIDのリスト

hostIDs

long[]

コンシューマーに割り当てられているホストを特定するIDのリスト

hypervisorIDs

long[]

コンシューマーに割り当てられているハイパーバイザーを特定するIDのリスト

applicationIDs

long[]

コンシューマーに割り当てられているアプリケーションを特定するIDのリスト

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/Groups/10 HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 07:19:45 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 0163c9c89df447c5a31b2b14c4b4e94aca5afa4_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : 10,
  "name" : "Group A",
  "status" : "Normal",
  "gradeKey" : "0",
  "gradeName" : "Platinum",
  "gradeDisplayOrder" : 0,
  "description" : "Tel:XXX-YYYYY, User:Administrator",
  "templateCreatorType" : "User",
  "numOfVolumes" : 0,
  "numOfVMs" : 0,
  "numOfHosts" : 0,
  "volumeAutoAssignFilters" : [ ],
  "vmAutoAssignFilters" : [ ],
  "hostAutoAssignFilters" : [ ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.6.3　グレードの一覧の取得

コンシューマーに含まれるグレードの一覧を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/Grades

リクエストボディー

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

レスポンスボディー

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

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性

データ型

説明

data

anyType[]

Grade のコレクション。 Grade の詳細は以下の表を参照ください。

pagination

Pagination

ページ情報。リソースが存在しない場合、このパラメータは表示されません。

count

int

条件に合致したデータの個数

pagination (Type: Pagination)

属性

データ型

説明

page

integer

ページ

pageSize

integer

ページサイズ

numPages

integer

ページの数

totalCount

integer

オブジェクトの数

Grade

{
        "gradeKey":"...",
        "name":"...",
        "displayOrder":"..."
}

Grade (Type: Grade)

属性

データ型

説明

gradeKey

string

グレードを識別するID。

name

string

グレードの名称。

displayOrder

int

グレードの優先順位。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

400

Bad Request

クエリパラメータ不正

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/Grades HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 05:21:50 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 723cc9c7dbae3aa85bad85fc46d1bc9edb64d_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "instanceID" : 410,
    "gradeKey" : "0",
    "name" : "Platinum",
    "displayOrder" : 0
  }, {
    "instanceID" : 413,
    "gradeKey" : "10",
    "name" : "Gold",
    "displayOrder" : 10
  }, {
    "instanceID" : 412,
    "gradeKey" : "20",
    "name" : "Silver",
    "displayOrder" : 20
  }, {
    "instanceID" : 411,
    "gradeKey" : "30",
    "name" : "Bronze",
    "displayOrder" : 30
  } ],
  "count" : 4
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.6.4　コンシューマーの作成

コンシューマーを新規に作成します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

POST http[s]://host:port/Analytics/version/objects/Groups

リクエストボディー

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

Group

{
        "name":"...",
        "gradeKey":"...",
        "description":"...",
        "urls":["...", ...],
        "urlDisplayNames":["...", ...],
        "templateCreatorType":"...",
        "vmAutoAssignment":"...",
        "applicationAssignFollow":"..."
}

Group (Type: Group)

属性

データ型

説明

name

string

コンシューマーの名称。128文字以下の文字列を指定します。

gradeKey

string

グレードを識別するID。

description

string

コンシューマーの説明。1000文字以下の文字列を指定します。

urls

string[]

URL

urlDisplayNames

string[]

URLの表示文字列

templateCreatorType

enum

コンシューマーの変更種別

(指定可能な値は「列挙型一覧」のTemplateCreatorTypeの表を参照してください。)

以下に示す値のみ指定可能です。

User

Default

vmAutoAssignment

boolean

このコンシューマーに属するハイパーバイザー配下の仮想マシンを自動的に割り当てる場合にtrue

applicationAssignFollow

boolean

このコンシューマーに属するリソース配下のアプリケーションを自動的に割り当てる場合にtrue

レスポンスボディー

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

Group

{
        "instanceID":"...",
        "name":"...",
        "status":"...",
        "gradeKey":"...",
        "gradeName":"...",
        "gradeDisplayOrder":"...",
        "description":"...",
        "urls":["...", ...],
        "urlDisplayNames":["...", ...],
        "templateCreatorType":"...",
        "vmAutoAssignment":"...",
        "applicationAssignFollow":"...",
        "numOfVolumes":"...",
        "numOfVMs":"...",
        "numOfHosts":"...",
        "numOfHypervisors":"...",
        "numOfApplications":"...",
        "vmAutoAssignFilters":["...", ...],
        "hostAutoAssignFilters":["...", ...],
        "volumeIDs":["...", ...],
        "vmIDs":["...", ...],
        "hostIDs":["...", ...],
        "hypervisorIDs":["...", ...],
        "applicationIDs":["...", ...]
}

Group (Type: Group)

属性

データ型

説明

instanceID

long

インスタンスを特定するID。

name

string

コンシューマーの名称。128文字以下の文字列を指定します。

status

enum

コンシューマーの状態。

(指定可能な値は「列挙型一覧」のNodeStatusTypeの表を参照してください。)

以下に示す値のみ指定可能です。

Normal

Warning

Error

gradeKey

string

グレードを識別するID。

gradeName

string

グレードの名称。

gradeDisplayOrder

int

グレードの優先順位

description

string

コンシューマーの説明。1000文字以下の文字列を指定します。

urls

string[]

URL

urlDisplayNames

string[]

URLの表示文字列

templateCreatorType

enum

コンシューマーの変更種別

(指定可能な値は「列挙型一覧」のTemplateCreatorTypeの表を参照してください。)

以下に示す値のみ指定可能です。

User

Default

vmAutoAssignment

boolean

このコンシューマーに属するハイパーバイザー配下の仮想マシンを自動的に割り当てる場合にtrue

applicationAssignFollow

boolean

このコンシューマーに属するリソース配下のアプリケーションを自動的に割り当てる場合にtrue

numOfVolumes

int

コンシューマーが割り当てられているボリュームの数。

numOfVMs

int

コンシューマーが割り当てられている仮想マシンの数。

numOfHosts

int

コンシューマーが割り当てられているホストの数。

numOfHypervisors

int

コンシューマーが割り当てられているハイパーバイザーの数。

numOfApplications

int

コンシューマーが割り当てられているアプリケーションの数。

vmAutoAssignFilters

string[]

仮想サーバに設定されている自動割り当てルールのルール名。

hostAutoAssignFilters

string[]

ホストに設定されている自動割り当てルールのルール名。

volumeIDs

long[]

コンシューマーに割り当てられているボリュームを特定するIDのリスト

vmIDs

long[]

コンシューマーに割り当てられている仮想マシンを特定するIDのリスト

hostIDs

long[]

コンシューマーに割り当てられているホストを特定するIDのリスト

hypervisorIDs

long[]

コンシューマーに割り当てられているハイパーバイザーを特定するIDのリスト

applicationIDs

long[]

コンシューマーに割り当てられているアプリケーションを特定するIDのリスト

ステータスコード

HTTPステータスコード

Reason phrase

説明

201

Created

正常終了

400

Bad Request

リクエストボディ形式不正

401

Unauthorized

ログイン権限がない

403

Forbidden

作成権限がない

404

Not Found

グレードが存在しない

409

Conflict

nameが一致するリソースが存在する

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
POST /Analytics/v1/objects/Groups HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 147

[Request Body]
{
  "instanceID" : 0,
  "name" : "Group A",
  "description" : "Tel:XXX-YYYYY, User:Administrator",
  "templateCreatorType" : "User",
  "gradeKey" : "0"
}

[Response Header]
HTTP/1.1 201 Created
Date: Fri, 27 Nov 2015 08:23:46 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO bfb7bb1ac5122d4e95bddc86cfb215f4c04715_WVlGcHsLfg5ffg0I_V0810
Location: http://localhost:22015/Analytics/v1/objects/Groups/10
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : 10,
  "name" : "Group A",
  "status" : "Normal",
  "gradeKey" : "0",
  "gradeName" : "Platinum",
  "gradeDisplayOrder" : 0,
  "description" : "Tel:XXX-YYYYY, User:Administrator",
  "templateCreatorType" : "User",
  "numOfVolumes" : 0,
  "numOfVMs" : 0,
  "numOfHosts" : 0,
  "volumeAutoAssignFilters" : [ ],
  "vmAutoAssignFilters" : [ ],
  "hostAutoAssignFilters" : [ ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.6.5　コンシューマーの更新

指定したコンシューマーの更新を行います。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

PUT http[s]://host:port/Analytics/version/objects/Groups/{id}

リクエストボディー

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

Group

{
        "name":"...",
        "gradeKey":"...",
        "description":"...",
        "urls":["...", ...],
        "urlDisplayNames":["...", ...],
        "templateCreatorType":"...",
        "vmAutoAssignment":"...",
        "applicationAssignFollow":"..."
}

Group (Type: Group)

属性

データ型

説明

name

string

コンシューマーの名称。128文字以下の文字列を指定します。

gradeKey

string

グレードを識別するID。

description

string

コンシューマーの説明。1000文字以下の文字列を指定します。

urls

string[]

URL

urlDisplayNames

string[]

URLの表示文字列

templateCreatorType

enum

コンシューマーの変更種別

(指定可能な値は「列挙型一覧」のTemplateCreatorTypeの表を参照してください。)

以下に示す値のみ指定可能です。

User

Default

vmAutoAssignment

boolean

このコンシューマーに属するハイパーバイザー配下の仮想マシンを自動的に割り当てる場合にtrue

applicationAssignFollow

boolean

このコンシューマーに属するリソース配下のアプリケーションを自動的に割り当てる場合にtrue

レスポンスボディー

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

Group

{
        "instanceID":"...",
        "name":"...",
        "status":"...",
        "gradeKey":"...",
        "gradeName":"...",
        "gradeDisplayOrder":"...",
        "description":"...",
        "urls":["...", ...],
        "urlDisplayNames":["...", ...],
        "templateCreatorType":"...",
        "vmAutoAssignment":"...",
        "applicationAssignFollow":"...",
        "numOfVolumes":"...",
        "numOfVMs":"...",
        "numOfHosts":"...",
        "numOfHypervisors":"...",
        "numOfApplications":"...",
        "vmAutoAssignFilters":["...", ...],
        "hostAutoAssignFilters":["...", ...],
        "volumeIDs":["...", ...],
        "vmIDs":["...", ...],
        "hostIDs":["...", ...],
        "hypervisorIDs":["...", ...],
        "applicationIDs":["...", ...]
}

Group (Type: Group)

属性

データ型

説明

instanceID

long

インスタンスを特定するID。

name

string

コンシューマーの名称。128文字以下の文字列を指定します。

status

enum

コンシューマーの状態。

(指定可能な値は「列挙型一覧」のNodeStatusTypeの表を参照してください。)

以下に示す値のみ指定可能です。

Normal

Warning

Error

gradeKey

string

グレードを識別するID。

gradeName

string

グレードの名称。

gradeDisplayOrder

int

グレードの優先順位

description

string

コンシューマーの説明。1000文字以下の文字列を指定します。

urls

string[]

URL

urlDisplayNames

string[]

URLの表示文字列

templateCreatorType

enum

コンシューマーの変更種別

(指定可能な値は「列挙型一覧」のTemplateCreatorTypeの表を参照してください。)

以下に示す値のみ指定可能です。

User

Default

vmAutoAssignment

boolean

このコンシューマーに属するハイパーバイザー配下の仮想マシンを自動的に割り当てる場合にtrue

applicationAssignFollow

boolean

このコンシューマーに属するリソース配下のアプリケーションを自動的に割り当てる場合にtrue

numOfVolumes

int

コンシューマーが割り当てられているボリュームの数。

numOfVMs

int

コンシューマーが割り当てられている仮想マシンの数。

numOfHosts

int

コンシューマーが割り当てられているホストの数。

numOfHypervisors

int

コンシューマーが割り当てられているハイパーバイザーの数。

numOfApplications

int

コンシューマーが割り当てられているアプリケーションの数。

vmAutoAssignFilters

string[]

仮想サーバに設定されている自動割り当てルールのルール名。

hostAutoAssignFilters

string[]

ホストに設定されている自動割り当てルールのルール名。

volumeIDs

long[]

コンシューマーに割り当てられているボリュームを特定するIDのリスト

vmIDs

long[]

コンシューマーに割り当てられている仮想マシンを特定するIDのリスト

hostIDs

long[]

コンシューマーに割り当てられているホストを特定するIDのリスト

hypervisorIDs

long[]

コンシューマーに割り当てられているハイパーバイザーを特定するIDのリスト

applicationIDs

long[]

コンシューマーに割り当てられているアプリケーションを特定するIDのリスト

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

400

Bad Request

リクエストボディ形式不正

401

Unauthorized

ログイン権限がない

403

Forbidden

更新権限がない

404

Not Found

リソースが存在しない

409

Conflict

nameが一致するリソースが存在する

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
PUT /Analytics/v1/objects/Groups/10 HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 376

[Request Body]
{
  "instanceID" : 10,
  "name" : "Group A",
  "status" : "Normal",
  "gradeKey" : "0",
  "gradeName" : "Platinum",
  "gradeDisplayOrder" : 0,
  "description" : "Tel:XXX-YYYYY, User:Administrator",
  "templateCreatorType" : "User",
  "numOfVolumes" : 0,
  "numOfVMs" : 0,
  "numOfHosts" : 0,
  "volumeAutoAssignFilters" : [ ],
  "vmAutoAssignFilters" : [ ],
  "hostAutoAssignFilters" : [ ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 08:42:47 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO f2eae1699945a979e8c7285d8923241d67ed782_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : 10,
  "name" : "Group A",
  "status" : "Normal",
  "gradeKey" : "0",
  "gradeName" : "Platinum",
  "gradeDisplayOrder" : 0,
  "description" : "Tel:XXX-YYYYY, User:Administrator",
  "templateCreatorType" : "User",
  "numOfVolumes" : 0,
  "numOfVMs" : 0,
  "numOfHosts" : 0,
  "volumeAutoAssignFilters" : [ ],
  "vmAutoAssignFilters" : [ ],
  "hostAutoAssignFilters" : [ ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.6.6　コンシューマーの削除

指定したコンシューマーを削除します。 削除したコンシューマーに割り当てされていたリソースは，未割当(#Unassigned Resources)に設定されます。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

DELETE http[s]://host:port/Analytics/version/objects/Groups/{id}

リクエストボディー

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

レスポンスボディー

レスポンスボディーは出力されません。

ステータスコード

HTTPステータスコード

Reason phrase

説明

204

No Content

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

削除権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
DELETE /Analytics/v1/objects/Groups/10 HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 204 No Content
Date: Fri, 27 Nov 2015 11:24:22 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO f1f0fb1a6ac21a0695f6536ba8950b641c263a4_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Content-Length: 0
Content-Type: application/json

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.6.7　コンシューマーに対する操作一覧の取得

指定したコンシューマーに対して実行できる操作の一覧を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/Groups/{id}/actions

リクエストボディー

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

レスポンスボディー

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

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性

データ型

説明

data

anyType[]

Action のコレクション。 Action の詳細は以下の表を参照ください。

pagination

Pagination

ページ情報。リソースが存在しない場合、このパラメータは表示されません。

count

int

条件に合致したデータの個数

pagination (Type: Pagination)

属性

データ型

説明

page

integer

ページ

pageSize

integer

ページサイズ

numPages

integer

ページの数

totalCount

integer

オブジェクトの数

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要なコレクション。空欄です。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/Groups/10/actions HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:00:14 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO dfce93dd9ddbe2e8fbfbe06da99384c2cd301a_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "name" : "updateTargetResource",
    "href" : "http://localhost:22015/Analytics/v1/objects/Groups/10/actions/updateTargetResource/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  } ],
  "count" : 1
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.6.8　コンシューマーの割り当てに必要な情報の取得

指定したコンシューマーを監視対象リソースの割り当てに必要な情報を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/Groups/{id}/actions/updateTargetResource

リクエストボディー

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

レスポンスボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な UpdateTargetResourceParam のコレクション。 UpdateTargetResourceParam の詳細は以下の表を参照ください。

UpdateTargetResourceParam

{
        "volumeIDs":["...", ...],
        "vmIDs":["...", ...],
        "resourceIDs":["...", ...]
}

UpdateTargetResourceParam (Type: UpdateTargetResourceParam)

属性

データ型

説明

volumeIDs

long[]

コンシューマーを割り当てるボリュームを特定するIDを指定します。複数のボリュームに割り当てを行う場合は，IDを連結して指定します。すでに割り当て済みの監視対象のIDも含め，設定する必要があります。

"volumeIDs" : [ 81, 87 ]

すべてのボリュームの割り当てを解除する場合は，メンバーの値を空欄にします。

"volumeIDs" : [ ]

vmIDs

long[]

コンシューマーを割り当てる仮想マシンを特定するIDを指定します。複数の仮想マシンに割り当てを行う場合は，IDを連結して指定します。すでに割り当て済みの監視対象のIDも含め，設定する必要があります。

" vmIDs " : [ 81, 87 ]

すべての仮想マシンの割り当てを解除する場合は，メンバーの値を空欄にします。

" vmIDs " : [ ]

resourceIDs

long[]

コンシューマーを割り当てるホストを特定するIDを指定します。複数のホストに割り当てを行う場合は，IDを連結して指定します。すでに割り当て済みの監視対象のIDも含め，設定する必要があります。

" resourceIDs " : [ 81, 87 ]

すべての仮想マシンの割り当てを解除する場合は，メンバーの値を空欄にします。

" resourceIDs " : [ ]

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/Groups/10/actions/updateTargetResource HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:04:21 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO ba4d83751660bee033d1ccdaf4d78e97f6c893a_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "updateTargetResource",
  "href" : "http://localhost:22015/Analytics/v1/objects/Groups/10/actions/updateTargetResource/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "volumeIDs" : [ ],
    "vmIDs" : [ 97 ],
    "resourceIDs" : [ ]
  } ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.6.9　コンシューマーの割り当て

指定したコンシューマーを監視対象に割り当てます。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

POST http[s]://host:port/Analytics/version/objects/Groups/{id}/actions/updateTargetResource/invoke

リクエストボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な UpdateTargetResourceParam のコレクション。 UpdateTargetResourceParam の詳細は以下の表を参照ください。

UpdateTargetResourceParam

{
        "volumeIDs":["...", ...],
        "vmIDs":["...", ...],
        "resourceIDs":["...", ...]
}

UpdateTargetResourceParam (Type: UpdateTargetResourceParam)

属性

データ型

説明

volumeIDs

long[]

コンシューマーを割り当てるボリュームを特定するIDを指定します。複数のボリュームに割り当てを行う場合は，IDを連結して指定します。すでに割り当て済みの監視対象のIDも含め，設定する必要があります。

"volumeIDs" : [ 81, 87 ]

すべてのボリュームの割り当てを解除する場合は，メンバーの値を空欄にします。

"volumeIDs" : [ ]

vmIDs

long[]

コンシューマーを割り当てる仮想マシンを特定するIDを指定します。複数の仮想マシンに割り当てを行う場合は，IDを連結して指定します。すでに割り当て済みの監視対象のIDも含め，設定する必要があります。

" vmIDs " : [ 81, 87 ]

すべての仮想マシンの割り当てを解除する場合は，メンバーの値を空欄にします。

" vmIDs " : [ ]

resourceIDs

long[]

コンシューマーを割り当てるホストを特定するIDを指定します。複数のホストに割り当てを行う場合は，IDを連結して指定します。すでに割り当て済みの監視対象のIDも含め，設定する必要があります。

" resourceIDs " : [ 81, 87 ]

すべての仮想マシンの割り当てを解除する場合は，メンバーの値を空欄にします。

" resourceIDs " : [ ]

レスポンスボディー

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

Job

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

属性

データ型

説明

instanceID

string

インスタンスのIDを示します。

created

string

オブジェクトの生成日付を示します。ISO8601形式です。

updated

string

オブジェクトが更新された時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

completed

string

処理が完了した時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

state

string

以下の値が設定されます。

“failed”: 操作が正常終了しなかったことを示します。

“success”: 操作が正常終了したことを示します。

affectedResource

string[]

操作の結果，作成または更新されたAPIのリソースのURLを示します。リソースが存在しない場合、このパラメータは空欄です。

result

anyType[]

実行結果のコレクション。空欄です。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

400

Bad Request

リクエストボディ形式不正

401

Unauthorized

ログイン権限がない

403

Forbidden

更新権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
POST /Analytics/v1/objects/Groups/10/actions/updateTargetResource/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 288

[Request Body]
{
  "name" : "updateTargetResource",
  "href" : "http://localhost:22015/Analytics/v1/objects/Groups/10/actions/updateTargetResource/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "volumeIDs" : [ 534 ],
    "vmIDs" : [ 97, 31 ],
    "resourceIDs" : [ ]
  } ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:11:06 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 154d18c71a465150d5e228e8f16bf42c4dd280_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "e89f633c-700d-4e75-9f81-d2d59c95a7bf",
  "created" : "2015-11-27T18:11:06.679+09:00",
  "updated" : "2015-11-27T18:11:07.023+09:00",
  "completed" : "2015-11-27T18:11:07.023+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.6.10　リソースの割り当て方を指定したコンシューマーの割り当てに必要な情報の取得

指定したコンシューマーを，指定した割り当て方に応じて監視対象に割り当てるのに必要な情報を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/Groups/{id}/actions/updateTargetResourceWithAssignmentType

リクエストボディー

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

レスポンスボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な UpdateTargetResourceWithAssignmentType のコレクション。 UpdateTargetResourceWithAssignmentType の詳細は以下の表を参照ください。

UpdateTargetResourceWithAssignmentType

{
        "volumes":[{
            "id":"...",
            "assignmentType":"..."
        },
        :
        ],
        "vms":[{
            "id":"...",
            "assignmentType":"..."
        },
        :
        ],
        "resources":[{
            "id":"...",
            "assignmentType":"..."
        },
        :
        ],
        "hypervisors":[{
            "id":"...",
            "assignmentType":"..."
        },
        :
        ],
        "applications":[{
            "id":"...",
            "assignmentType":"..."
        },
        :
        ]
}

UpdateTargetResourceWithAssignmentType (Type: UpdateTargetResourceWithAssignmentType)

属性

データ型

説明

volumes

TargetResource[]

割り当てるボリュームのリスト

vms

TargetResource[]

割り当てる仮想マシンのリスト

resources

TargetResource[]

割り当てるホストのリスト

hypervisors

TargetResource[]

割り当てるハイパーバイザ

applications

TargetResource[]

割り当てるアプリケーション

volumes (Type: TargetResource)

属性

データ型

説明

id

long

リソースを特定するID

assignmentType

enum

リソース割り当て区分

(指定可能な値は「列挙型一覧」のAssignmentTypeの表を参照してください。)

vms (Type: TargetResource)

属性

データ型

説明

id

long

リソースを特定するID

assignmentType

enum

リソース割り当て区分

(指定可能な値は「列挙型一覧」のAssignmentTypeの表を参照してください。)

resources (Type: TargetResource)

属性

データ型

説明

id

long

リソースを特定するID

assignmentType

enum

リソース割り当て区分

(指定可能な値は「列挙型一覧」のAssignmentTypeの表を参照してください。)

hypervisors (Type: TargetResource)

属性

データ型

説明

id

long

リソースを特定するID

assignmentType

enum

リソース割り当て区分

(指定可能な値は「列挙型一覧」のAssignmentTypeの表を参照してください。)

applications (Type: TargetResource)

属性

データ型

説明

id

long

リソースを特定するID

assignmentType

enum

リソース割り当て区分

(指定可能な値は「列挙型一覧」のAssignmentTypeの表を参照してください。)

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/Groups/10/actions/updateTargetResourceWithAssignmentType HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:04:21 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO ba4d83751660bee033d1ccdaf4d78e97f6c893a_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "updateTargetResourceWithAssignmentType",
  "href" : "http://10.197.198.106:22015/Analytics/v1/objects/Groups/10/actions/updateTargetResourceWithAssignmentType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "volumes" : [ ],
    "vms" : [ {
      "id" : 578,
      "assignmentType" : "NoChange"
    }, {
      "id" : 619,
      "assignmentType" : "NoChange"
    } ],
    "resources" : [ ],
    "hypervisors" : [ ]
  } ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.6.11　リソースの割り当て方を指定したコンシューマーの割り当て

指定したコンシューマーを，指定した割り当て方に応じて監視対象に割り当てます。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

POST http[s]://host:port/Analytics/version/objects/Groups/{id}/actions/updateTargetResourceWithAssignmentType/invoke

リクエストボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な UpdateTargetResourceWithAssignmentType のコレクション。 UpdateTargetResourceWithAssignmentType の詳細は以下の表を参照ください。

UpdateTargetResourceWithAssignmentType

{
        "volumes":[{
            "id":"...",
            "assignmentType":"..."
        },
        :
        ],
        "vms":[{
            "id":"...",
            "assignmentType":"..."
        },
        :
        ],
        "resources":[{
            "id":"...",
            "assignmentType":"..."
        },
        :
        ],
        "hypervisors":[{
            "id":"...",
            "assignmentType":"..."
        },
        :
        ],
        "applications":[{
            "id":"...",
            "assignmentType":"..."
        },
        :
        ]
}

UpdateTargetResourceWithAssignmentType (Type: UpdateTargetResourceWithAssignmentType)

属性

データ型

説明

volumes

TargetResource[]

割り当てるボリュームのリスト

vms

TargetResource[]

割り当てる仮想マシンのリスト

resources

TargetResource[]

割り当てるホストのリスト

hypervisors

TargetResource[]

割り当てるハイパーバイザ

applications

TargetResource[]

割り当てるアプリケーション

volumes (Type: TargetResource)

属性

データ型

説明

id

long

リソースを特定するID

assignmentType

enum

リソース割り当て区分

(指定可能な値は「列挙型一覧」のAssignmentTypeの表を参照してください。)

vms (Type: TargetResource)

属性

データ型

説明

id

long

リソースを特定するID

assignmentType

enum

リソース割り当て区分

(指定可能な値は「列挙型一覧」のAssignmentTypeの表を参照してください。)

resources (Type: TargetResource)

属性

データ型

説明

id

long

リソースを特定するID

assignmentType

enum

リソース割り当て区分

(指定可能な値は「列挙型一覧」のAssignmentTypeの表を参照してください。)

hypervisors (Type: TargetResource)

属性

データ型

説明

id

long

リソースを特定するID

assignmentType

enum

リソース割り当て区分

(指定可能な値は「列挙型一覧」のAssignmentTypeの表を参照してください。)

applications (Type: TargetResource)

属性

データ型

説明

id

long

リソースを特定するID

assignmentType

enum

リソース割り当て区分

(指定可能な値は「列挙型一覧」のAssignmentTypeの表を参照してください。)

レスポンスボディー

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

Job

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

属性

データ型

説明

instanceID

string

インスタンスのIDを示します。

created

string

オブジェクトの生成日付を示します。ISO8601形式です。

updated

string

オブジェクトが更新された時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

completed

string

処理が完了した時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

state

string

以下の値が設定されます。

“failed”: 操作が正常終了しなかったことを示します。

“success”: 操作が正常終了したことを示します。

affectedResource

string[]

操作の結果，作成または更新されたAPIのリソースのURLを示します。リソースが存在しない場合、このパラメータは空欄です。

result

anyType[]

実行結果のコレクション。空欄です。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

400

Bad Request

リクエストボディ形式不正

401

Unauthorized

ログイン権限がない

403

Forbidden

更新権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
POST /Analytics/v1/objects/Groups/10/actions/updateTargetResourceWithAssignmentType/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 288

[Request Body]
{
  "name" : "updateTargetResourceWithAssignmentType",
  "href" : "http://10.197.198.106:22015/Analytics/v1/objects/Groups/10/actions/updateTargetResourceWithAssignmentType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "volumes" : [ ],
    "vms" : [ {
      "id" : 578,
      "assignmentType" : "NoChange"
    }, {
      "id" : 619,
      "assignmentType" : "NoChange"
    } ],
    "resources" : [ ],
    "hypervisors" : [ ]
  } ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:11:06 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 154d18c71a465150d5e228e8f16bf42c4dd280_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "092d8a40-9bb3-4067-9d39-404c5c646101",
  "created" : "2016-11-22T11:30:45.805+09:00",
  "updated" : "2016-11-22T11:30:47.122+09:00",
  "completed" : "2016-11-22T11:30:47.122+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.7　アプリケーションに関するAPI一覧

アプリケーションへの操作を説明します。

2.7.1　アプリケーションの一覧の取得

アプリケーションの一覧を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/Applications

リクエストボディー

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

レスポンスボディー

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

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性

データ型

説明

data

anyType[]

Application のコレクション。 Application の詳細は以下の表を参照ください。

pagination

Pagination

ページ情報。リソースが存在しない場合、このパラメータは表示されません。

count

int

条件に合致したデータの個数

pagination (Type: Pagination)

属性

データ型

説明

page

integer

ページ

pageSize

integer

ページサイズ

numPages

integer

ページの数

totalCount

integer

オブジェクトの数

Application

{
        "instanceID":"...",
        "name":"...",
        "applicationType":"...",
        "applicationDetailType":"...",
        "ipAddress":"...",
        "description":"...",
        "collectorID":"...",
        "collectorName":"...",
        "applicationHosts":[{
            "resourceID":"...",
            "resourceType":"..."
        },
        :
        ],
        "autoCollectionType":"...",
        "groupIDs":["...", ...],
        "groupNames":["...", ...],
        "gradeNames":["...", ...],
        "gradeOrders":["...", ...],
        "usedCredentialID":"...",
        "usedCredentials":"...",
        "accessPointType":"...",
        "accessPointIpAddress":"...",
        "accessPointUser":"..."
}

Application (Type: Application)

属性

データ型

説明

instanceID

long

インスタンスを特定するID

name

string

発見されたリソース名

applicationType

enum

アプリケーションの種別

(指定可能な値は「列挙型一覧」のApplicationTypeの表を参照してください。)

以下に示す値のみ指定可能です。

AJS_MANAGER

AJS_AGENT

PFM_SERVICERESPONSE

PFM_AJS3

PFM_DOMINO

PFM_EXCHANGE

PFM_SAPSYSTEM

PFM_IBMWEBSPHEREMQ

PFM_OPENTP1

PFM_COSMINEXUS

PFM_IIS

PFM_WEBLOGICSERVER

PFM_WEBSPHEREAPPLICATIONSERVER

PFM_DB2

PFM_HIRDB

PFM_SQL

PFM_RMSQLSERVER

PFM_ORACLE

PFM_RMORACLE

PFM_RMPLATFORM

PFM_UNIX

PFM_WINDOWS

IM_OS

PFM_RMVIRTUALMACHINE

PFM_VIRTUALMACHINE

applicationDetailType

string

任意のアプリケーションの種別

ipAddress

string

アプリケーションのIPアドレス

description

string

アプリケーションの詳細情報

collectorID

long

発見に使用されたコレクターを特定するID

collectorName

string

発見に使用されたコレクターの名称

applicationHosts

ApplicationHost[]

アプリケーションが属するリソースの情報

autoCollectionType

enum

コレクターの定期実行設定

(指定可能な値は「列挙型一覧」のConnectTypeの表を参照してください。)

groupIDs

long[]

アプリケーションが割り当たっているコンシューマーを特定するID

groupNames

string[]

アプリケーションが割り当たっているコンシューマーの名称

gradeNames

string[]

アプリケーションが割り当たっているコンシューマーのグレード

gradeOrders

integer[]

アプリケーションが割り当たっているコンシューマーのグレードの優先度

usedCredentialID

long

発見時に使用された認証情報を特定するID

usedCredentials

string

発見時に使用された認証情報

accessPointType

enum

認証情報の種別

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

accessPointIpAddress

string

認証情報のIPアドレスまたはホスト名

accessPointUser

string

監視対象または管理ソフトウェアへの接続に使用したユーザーID

applicationHosts (Type: ApplicationHost)

属性

データ型

説明

resourceID

long

アプリケーションが属するリソースのID

resourceType

enum

アプリケーションが属するリソースの種別

(指定可能な値は「列挙型一覧」のApplicationResourceTypeの表を参照してください。)

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/Applications HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 05:21:50 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 3ffa18cbf3e9f46049c06aaf52a1c5444c5e2c3a_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "pagination" : {
    "page" : 1,
    "pageSize" : 1,
    "numPages" : 569,
    "totalCount" : 569
  },
  "data" : [ {
    "instanceID" : 568,
    "name" : "IMM-HOST02",
    "applicationType" : "IM_OS",
    "ipAddress" : "IMM-HOST02",
    "description" : "10.197.73.120",
    "collectorID" : 4,
    "collectorName" : "10.197.73.120",
    "applicationHosts":
    [
        {
            "resourceID": 13,
            "resourceType": "Host"
        }
    ],
    "autoCollectionType": "AutoConnect",
    "groupIDs":
    [
        0
    ],
    "groupNames":
    [
        "#Unassigned Resources"
    ],
    "gradeNames":
    [
        ""
    ],
    "gradeOrders":
    [
        -1
    ],
    "usedCredentialID" : 17,
    "accessPointType" : "IM",
    "accessPointIpAddress" : "10.197.73.120",
    "accessPointUser" : "Administrator"
  },
  {
      "instanceID": 567,
      "name": "Zabbix server1",
      "applicationType": "CUSTOM",
      "applicationDetailType": "App Zabbix Server",
      "ipAddress": "192.168.1.251",
      "description": "XX Monitoring System",
      "collectorID": 3,
      "collectorName": "customCollector",
      "applicationHosts":
      [
      ],
      "autoCollectionType": "AutoConnect",
      "groupIDs":
      [
          0
      ],
      "groupNames":
      [
          "#Unassigned Resources"
      ],
      "gradeNames":
      [
          ""
      ],
      "gradeOrders":
      [
          -1
      ],
      "usedCredentialID": 0,
      "accessPointType": "CUSTOM"
  } ],
  "count" : 2
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.8　仮想マシンに関するAPI一覧

仮想マシンへの操作を説明します。

2.8.1　仮想マシンの一覧の取得

仮想マシンの一覧を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/VirtualMachines

リクエストボディー

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

レスポンスボディー

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

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性

データ型

説明

data

anyType[]

VirtualMachine のコレクション。 VirtualMachine の詳細は以下の表を参照ください。

pagination

Pagination

ページ情報。リソースが存在しない場合、このパラメータは表示されません。

count

int

条件に合致したデータの個数

pagination (Type: Pagination)

属性

データ型

説明

page

integer

ページ

pageSize

integer

ページサイズ

numPages

integer

ページの数

totalCount

integer

オブジェクトの数

VirtualMachine

{
        "instanceID":"...",
        "name":"...",
        "ipAddress":"...",
        "status":"...",
        "monitorStatus":"...",
        "description":"...",
        "collectorID":"...",
        "collectorName":"...",
        "autoCollectionType":"...",
        "clusterName":"...",
        "hypervisorType":"...",
        "hypervisorID":"...",
        "hypervisorName":"...",
        "hypervisorMonitorStatus":"...",
        "hostName":"...",
        "thresholdProfileID":"...",
        "thresholdProfileName":"...",
        "groupIDs":["...", ...],
        "groupNames":["...", ...],
        "gradeNames":["...", ...],
        "gradeOrders":["...", ...],
        "usedCredentialID":"...",
        "usedCredentials":"...",
        "accessPointType":"...",
        "accessPointIpAddress":"...",
        "accessPointUser":"..."
}

VirtualMachine (Type: VirtualMachine)

属性

データ型

説明

instanceID

long

仮想マシンを特定するID

name

string

仮想マシンの名称

ipAddress

string

仮想マシンのIPアドレス

status

enum

仮想マシンの状態

(指定可能な値は「列挙型一覧」のNodeStatusTypeの表を参照してください。)

以下に示す値のみ指定可能です。

Normal

Warning

Error

Unreachable

Unknown

NotMonitored

monitorStatus

enum

仮想マシンの監視状態

(指定可能な値は「列挙型一覧」のComponentMonitorTypeの表を参照してください。)

以下に示す値のみ指定可能です。

InUse

NotMonitored

description

string

仮想マシンの詳細情報。

collectorID

long

発見に使用されたコレクターを特定するID。

collectorName

string

発見に使用されたコレクターの名称。

autoCollectionType

enum

コレクターの定期実行の設定。

(指定可能な値は「列挙型一覧」のConnectTypeの表を参照してください。)

以下に示す値のみ指定可能です。

AutoConnect

NotAutoConnect

clusterName

string

仮想マシンが属するクラスタの名称

hypervisorType

enum

仮想マシンが属するハイパーバイザーの種別

(指定可能な値は「列挙型一覧」のArgusNodeTypeの表を参照してください。)

以下に示す値のみ指定可能です。

SERVER_ESX

SERVER_HYPERV

hypervisorID

long

仮想マシンが属するハイパーバイザーを特定するID

hypervisorName

string

仮想マシンが属するハイパーバイザーの名称

hypervisorMonitorStatus

enum

仮想マシンが属するハイパーバイザーの監視状態

(指定可能な値は「列挙型一覧」のManagementLevelTypeの表を参照してください。)

以下に示す値のみ指定可能です。

New

Manage

ignore

MonitorOff

hostName

string

仮想マシン上で動作するOSのホスト名

thresholdProfileID

long

仮想マシンに割り当てられたしきい値プロファイルを特定するID

thresholdProfileName

string

仮想マシンに割り当てられたしきい値プロファイルの名称

groupIDs

long[]

仮想マシンが割り当たっているコンシューマーを特定するID

groupNames

string[]

仮想マシンが割り当たっているコンシューマーの名称

gradeNames

string[]

仮想マシンが割り当たっているコンシューマーのグレード

gradeOrders

integer[]

仮想マシンが割り当たっているコンシューマーのグレードの優先度

usedCredentialID

long

発見時に使用された認証情報を特定するID。

usedCredentials

string

発見時に使用された認証情報の名称。

accessPointType

enum

発見時に使用された認証情報のプロトコルまたはコレクターの種別。

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

WMI

VCENTER

accessPointIpAddress

string

監視対象または管理ソフトウェアへの接続に使用したIPアドレスまたはホスト名

accessPointUser

string

監視対象または管理ソフトウェアへの接続に使用したユーザーID

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/VirtualMachines HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 05:21:50 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 7ca86aa5a44eb9b1c86c97c990674963cf98534d_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "instanceID" : 31,
    "name" : "vm017182",
    "ipAddress" : "172.17.17.182",
    "status" : "Normal",
    "monitorStatus" : "InUse",
    "description" : "vm017182 : 564d326f-e63b-1ec9-2cf0-7d1ae7755abe",
    "collectorID" : 0,
    "collectorName" : "172.17.17.115",
    "autoCollectionType" : "AutoConnect",
    "hypervisorType" : "SERVER_ESX",
    "hypervisorID" : 1,
    "hypervisorName" : "172.17.17.181",
    "hypervisorMonitorStatus" : "Manage",
    "hostName" : "vm017182",
    "thresholdProfileID" : 19,
    "thresholdProfileName" : "Default Profile for VM",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ],
    "accessPointType" : "VCENTER",
    "accessPointIpAddress" : "172.17.17.115",
    "accessPointUser" : "Administrator"
  } ],
  "count" : 11
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.8.2　仮想マシンに対する操作一覧の取得

仮想マシンに対して実行できる操作の一覧を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/services/VirtualMachines/actions

リクエストボディー

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

レスポンスボディー

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

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性

データ型

説明

data

anyType[]

Action のコレクション。 Action の詳細は以下の表を参照ください。

pagination

Pagination

ページ情報。リソースが存在しない場合、このパラメータは表示されません。

count

int

条件に合致したデータの個数

pagination (Type: Pagination)

属性

データ型

説明

page

integer

ページ

pageSize

integer

ページサイズ

numPages

integer

ページの数

totalCount

integer

オブジェクトの数

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要なコレクション。空欄です。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/services/VirtualMachines/actions/changeManagedType HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:19:21 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 5120405fb8a980d12331c748369039cf28af252_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "name" : "changeManagedType",
    "href" : "http://localhost:22015/Analytics/v1/services/VirtualMachines/actions/changeManagedType/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  } ],
  "count" : 1
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.8.3　仮想マシンの監視状態変更に必要な情報の取得

仮想マシンの監視状態を変更するために必要な情報を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/services/VirtualMachines/actions/changeManagedType

リクエストボディー

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

レスポンスボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な ChangeManagedTypeParamForVM のコレクション。 ChangeManagedTypeParamForVM の詳細は以下の表を参照ください。

ChangeManagedTypeParamForVM

{
        "newMonitoringOperationType":"...",
        "virtualMachineIds":["...", ...]
}

ChangeManagedTypeParamForVM (Type: ChangeManagedTypeParamForVM)

属性

データ型

説明

newMonitoringOperationType

enum

変更したい監視状態を指定します。

(指定可能な値は「列挙型一覧」のMonitoringOperationTypeの表を参照してください。)

以下に示す値のみ指定可能です。

Monitor

Ignore

virtualMachineIds

long[]

仮想マシンを特定するIDを指定します。複数同時に指定する場合は，IDを連結して指定します。

instanceID=50,51を指定する場合は以下のように指定します。

virtualMachineIds : [ 50, 51 ]

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/services/VirtualMachines/actions HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:17:42 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 1e89694342cfad52de32bd8e1a2921a48b8d8_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/VirtualMachines/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitoringOperationType" : "Monitor",
    "virtualMachineIds" : [ ]
  } ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.8.4　仮想マシンの監視状態の変更

仮想マシンの監視状態を変更します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

POST http[s]://host:port/Analytics/version/services/VirtualMachines/actions/changeManagedType/invoke

リクエストボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な ChangeManagedTypeParamForVM のコレクション。 ChangeManagedTypeParamForVM の詳細は以下の表を参照ください。

ChangeManagedTypeParamForVM

{
        "newMonitoringOperationType":"...",
        "virtualMachineIds":["...", ...]
}

ChangeManagedTypeParamForVM (Type: ChangeManagedTypeParamForVM)

属性

データ型

説明

newMonitoringOperationType

enum

変更したい監視状態を指定します。

(指定可能な値は「列挙型一覧」のMonitoringOperationTypeの表を参照してください。)

以下に示す値のみ指定可能です。

Monitor

Ignore

virtualMachineIds

long[]

仮想マシンを特定するIDを指定します。複数同時に指定する場合は，IDを連結して指定します。

instanceID=50,51を指定する場合は以下のように指定します。

virtualMachineIds : [ 50, 51 ]

レスポンスボディー

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

Job

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

属性

データ型

説明

instanceID

string

インスタンスのIDを示します。

created

string

オブジェクトの生成日付を示します。ISO8601形式です。

updated

string

オブジェクトが更新された時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

completed

string

処理が完了した時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

state

string

以下の値が設定されます。

“failed”: 操作が正常終了しなかったことを示します。

“success”: 操作が正常終了したことを示します。

affectedResource

string[]

操作の結果，作成または更新されたAPIのリソースのURLを示します。リソースが存在しない場合、このパラメータは空欄です。

result

anyType[]

実行結果のコレクション。空欄です。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

400

Bad Request

リクエストボディ形式不正

401

Unauthorized

ログイン権限がない

403

Forbidden

更新権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
POST /Analytics/v1/services/VirtualMachines/actions/changeManagedType/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 296

[Request Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/VirtualMachines/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitoringOperationType" : "Ignore",
    "virtualMachineIds" : [ 31, 80 ]
  } ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:22:28 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 284045794595c1ed7a98d2184419b8656e48a15_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "53b1e702-9750-4c1c-9857-d1a3a8d4cac7",
  "created" : "2015-11-27T18:22:28.528+09:00",
  "updated" : "2015-11-27T18:22:28.647+09:00",
  "completed" : "2015-11-27T18:22:28.647+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.9　ハイパーバイザーに関するAPI一覧

ハイパーバイザーへの操作を説明します。

2.9.1　ハイパーバイザーの一覧の取得

ハイパーバイザーの一覧を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/Hypervisors

リクエストボディー

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

レスポンスボディー

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

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性

データ型

説明

data

anyType[]

Hypervisor のコレクション。 Hypervisor の詳細は以下の表を参照ください。

pagination

Pagination

ページ情報。リソースが存在しない場合、このパラメータは表示されません。

count

int

条件に合致したデータの個数

pagination (Type: Pagination)

属性

データ型

説明

page

integer

ページ

pageSize

integer

ページサイズ

numPages

integer

ページの数

totalCount

integer

オブジェクトの数

Hypervisor

{
        "instanceID":"...",
        "name":"...",
        "ipAddress":"...",
        "status":"...",
        "monitorStatus":"...",
        "description":"...",
        "collectorID":"...",
        "collectorName":"...",
        "autoCollectionType":"...",
        "clusterName":"...",
        "usedCredentialID":"...",
        "usedCredentials":"...",
        "hypervisorType":"...",
        "thresholdProfileID":"...",
        "thresholdProfileName":"...",
        "accessPointType":"...",
        "accessPointIpAddress":"...",
        "accessPointUser":"...",
        "groupIDs":["...", ...],
        "groupNames":["...", ...],
        "gradeNames":["...", ...],
        "gradeOrders":["...", ...]
}

Hypervisor (Type: Hypervisor)

属性

データ型

説明

instanceID

long

ハイパーバイザーを特定するID

name

string

ハイパーバイザーの名称

ipAddress

string

ハイパーバイザーのIPアドレス

status

enum

ハイパーバイザーの状態

(指定可能な値は「列挙型一覧」のNodeStatusTypeの表を参照してください。)

以下に示す値のみ指定可能です。

Normal

Warning

Error

Unreachable

Unknown

NotMonitored

monitorStatus

enum

ハイパーバイザーの監視状態。

(指定可能な値は「列挙型一覧」のManagementLevelTypeの表を参照してください。)

以下に示す値のみ指定可能です。

New

Manage

ignore

MonitorOff

description

string

ハイパーバイザーの詳細情報

collectorID

long

発見に使用されたコレクターを特定するID。

collectorName

string

発見に使用されたコレクターの名称。

autoCollectionType

enum

コレクターの定期実行の設定。

(指定可能な値は「列挙型一覧」のConnectTypeの表を参照してください。)

以下に示す値のみ指定可能です。

AutoConnect

NotAutoConnect

clusterName

string

ハイパーバイザーが登録されているクラスタの名称

usedCredentialID

long

発見時に使用された認証情報を特定するID。

usedCredentials

string

発見時に使用された認証情報の名称。

hypervisorType

string

ハイパーバイザーの種別。以下の値のみ指定可能。

・SERVER_ESX:ESXサーバ

・SERVER_HYPERV:Hyper-Vサーバ

thresholdProfileID

long

ハイパーバイザーに割り当たっているしきい値プロファイルを特定するID

thresholdProfileName

string

ハイパーバイザーに割り当たっているしきい値プロファイルの名称

accessPointType

enum

発見時に使用された認証情報のプロトコルまたはコレクターの種別。

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

WMI

VCENTER

accessPointIpAddress

string

監視対象または管理ソフトウェアへの接続に使用したIPアドレスまたはホスト名

accessPointUser

string

監視対象または管理ソフトウェアへの接続に使用したユーザーID

groupIDs

long[]

ハイパーバイザーが割り当たっているコンシューマーを特定するID

groupNames

string[]

ハイパーバイザーが割り当たっているコンシューマーの名称

gradeNames

string[]

ハイパーバイザーが割り当たっているコンシューマーのグレード

gradeOrders

integer[]

ハイパーバイザーが割り当たっているコンシューマーのグレードの優先度

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/Hypervisors HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 20:11:36 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 87d94e387ca516a82287ff4254ddac7f44e18bd4_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "instanceID" : 4,
    "name" : "hyperV",
    "ipAddress" : "10.197.87.56",
    "status" : "Unknown",
    "monitorStatus" : "Manage",
    "description" : "Hyper-V 4C4C4544-0037-4710-8036-B7C04F504258",
    "usedCredentialID" : 9,
    "usedCredentials" : "10.197.87.56",
    "hypervisorType" : "HYPERV",
    "thresholdProfileID" : 23,
    "thresholdProfileName" : "Default Profile for Hyper-V",
    "accessPointType" : "WMI",
    "accessPointIpAddress" : "10.197.87.56",
    "accessPointUser" : "Administrator"
  }, {
    "instanceID" : 1,
    "name" : "172.17.17.181",
    "ipAddress" : "172.17.17.181",
    "status" : "Normal",
    "monitorStatus" : "Manage",
    "description" : "ESX 42234bf5-2c85-4bd6-7452-5b235faae0d2",
    "collectorID" : 0,
    "collectorName" : "172.17.17.115",
    "autoCollectionType" : "AutoConnect",
    "hypervisorType" : "ESX",
    "thresholdProfileID" : 6,
    "thresholdProfileName" : "Default Profile for ESX",
    "accessPointType" : "VCENTER",
    "accessPointIpAddress" : "172.17.17.115",
    "accessPointUser" : "Administrator"
  } ],  "count" : 2
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.9.2　ハイパーバイザーに対する操作一覧の取得

ハイパーバイザーに対して実行できる操作の一覧を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/services/Hypervisors/actions

リクエストボディー

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

レスポンスボディー

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

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性

データ型

説明

data

anyType[]

Action のコレクション。 Action の詳細は以下の表を参照ください。

pagination

Pagination

ページ情報。リソースが存在しない場合、このパラメータは表示されません。

count

int

条件に合致したデータの個数

pagination (Type: Pagination)

属性

データ型

説明

page

integer

ページ

pageSize

integer

ページサイズ

numPages

integer

ページの数

totalCount

integer

オブジェクトの数

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要なコレクション。空欄です。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/services/Hypervisors/actions HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:17:42 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 1e89694342cfad52de32bd8e1a2921a48b8d8_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "name" : "changeManagedType",
    "href" : "http://localhost:22015/Analytics/v1/services/Hypervisors/actions/changeManagedType/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  } ],
  "count" : 1
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.9.3　ハイパーバイザーの監視状態変更に必要な情報の取得

ハイパーバイザーの監視状態を変更するために必要な情報を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/services/Hypervisors/actions/changeManagedType

リクエストボディー

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

レスポンスボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な ChangeManagedTypeParamForRes のコレクション。 ChangeManagedTypeParamForRes の詳細は以下の表を参照ください。

ChangeManagedTypeParamForRes

{
        "newMonitorStatus":"...",
        "ids":["...", ...]
}

ChangeManagedTypeParamForRes (Type: ChangeManagedTypeParamForRes)

属性

データ型

説明

newMonitorStatus

enum

設定するリソースの管理状態

(指定可能な値は「列挙型一覧」のManagementLevelTypeの表を参照してください。)

以下に示す値のみ指定可能です。

New

Manage

ignore

MonitorOff

ids

long[]

リソースのIDのリスト

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/services/Hypervisors/actions/changeManagedType HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:19:21 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 5120405fb8a980d12331c748369039cf28af252_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/Hypervisors/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitorStatus": "Manage",
    "ids" : [ ]
  } ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.9.4　ハイパーバイザーの監視状態の変更

ハイパーバイザーの監視状態を変更します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

POST http[s]://host:port/Analytics/version/services/Hypervisors/actions/changeManagedType/invoke

リクエストボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な ChangeManagedTypeParamForRes のコレクション。 ChangeManagedTypeParamForRes の詳細は以下の表を参照ください。

ChangeManagedTypeParamForRes

{
        "newMonitorStatus":"...",
        "ids":["...", ...]
}

ChangeManagedTypeParamForRes (Type: ChangeManagedTypeParamForRes)

属性

データ型

説明

newMonitorStatus

enum

設定するリソースの管理状態

(指定可能な値は「列挙型一覧」のManagementLevelTypeの表を参照してください。)

以下に示す値のみ指定可能です。

New

Manage

ignore

MonitorOff

ids

long[]

リソースのIDのリスト

レスポンスボディー

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

Job

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

属性

データ型

説明

instanceID

string

インスタンスのIDを示します。

created

string

オブジェクトの生成日付を示します。ISO8601形式です。

updated

string

オブジェクトが更新された時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

completed

string

処理が完了した時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

state

string

以下の値が設定されます。

“failed”: 操作が正常終了しなかったことを示します。

“success”: 操作が正常終了したことを示します。

affectedResource

string[]

操作の結果，作成または更新されたAPIのリソースのURLを示します。リソースが存在しない場合、このパラメータは空欄です。

result

anyType[]

実行結果のコレクション。空欄です。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

400

Bad Request

リクエストボディ形式不正

401

Unauthorized

ログイン権限がない

403

Forbidden

更新権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
POST /Analytics/v1/services/Hypervisors/actions/changeManagedType/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 287

[Request Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/Hypervisors/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitorStatus" : "MonitorOff",
    "ids" : [ 50 ]
  } ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:22:28 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 284045794595c1ed7a98d2184419b8656e48a15_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "53b1e702-9750-4c1c-9857-d1a3a8d4cac7",
  "created" : "2015-11-27T18:22:28.528+09:00",
  "updated" : "2015-11-27T18:22:28.647+09:00",
  "completed" : "2015-11-27T18:22:28.647+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.10　ホストに関するAPI一覧

ホストへの操作を説明します。

2.10.1　ホストの一覧の取得

ホストの一覧を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/Hosts

リクエストボディー

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

レスポンスボディー

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

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性

データ型

説明

data

anyType[]

Host のコレクション。 Host の詳細は以下の表を参照ください。

pagination

Pagination

ページ情報。リソースが存在しない場合、このパラメータは表示されません。

count

int

条件に合致したデータの個数

pagination (Type: Pagination)

属性

データ型

説明

page

integer

ページ

pageSize

integer

ページサイズ

numPages

integer

ページの数

totalCount

integer

オブジェクトの数

Host

{
        "instanceID":"...",
        "name":"...",
        "ipAddress":"...",
        "osType":"...",
        "status":"...",
        "monitorStatus":"...",
        "description":"...",
        "vmName":"...",
        "usedCredentialID":"...",
        "usedCredentials":"...",
        "thresholdProfileID":"...",
        "thresholdProfileName":"...",
        "groupIDs":["...", ...],
        "groupNames":["...", ...],
        "deviceClassificationLabel":"...",
        "accessPointType":"...",
        "accessPointIpAddress":"...",
        "accessPointUser":"..."
}

Host (Type: Host)

属性

データ型

説明

instanceID

long

ホストを特定するID

name

string

ホストの名称

ipAddress

string

ホストのIPアドレス

osType

string

ホストのOS種別。以下の値のみ指定可能。

・SERVER_WINDOWS:OSがWindowsである。

・SERVER_LINUX:OSがLinuxである。

・SERVER_SOL:OSがSolarisである。

・SERVER_HPUX:OSがHP-UXである。

・SERVER_AIX:OSがAIXである。

status

enum

ホストの状態

(指定可能な値は「列挙型一覧」のNodeStatusTypeの表を参照してください。)

以下に示す値のみ指定可能です。

Normal

Warning

Error

Unreachable

Unknown

NotMonitored

monitorStatus

enum

ホストの監視状態。

(指定可能な値は「列挙型一覧」のManagementLevelTypeの表を参照してください。)

以下に示す値のみ指定可能です。

New

Manage

ignore

MonitorOff

description

string

ホストの詳細情報

vmName

string

ホストが仮想マシン上で動作している場合の仮想マシン名。

usedCredentialID

long

発見時に使用された認証情報を特定するID。

usedCredentials

string

発見時に使用された認証情報の名称。

thresholdProfileID

long

ホストに割り当てられたしきい値プロファイルを特定するID

thresholdProfileName

string

ホストに割り当てられたしきい値プロファイルの名称

groupIDs

long[]

ホストに割り当てられたコンシューマーを特定するID

groupNames

string[]

ホストに割り当てられたコンシューマーのグレード名称

deviceClassificationLabel

string

ホストに割り当てられた分類ラベル

accessPointType

enum

発見時に使用された認証情報の種別。

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

WMI

SSH

accessPointIpAddress

string

監視対象への接続に使用したIPアドレス

accessPointUser

string

監視対象への接続に使用したユーザーID

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/Hosts HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 07:11:36 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 87d94e387ca516a82287ff4254ddac7f44e18bd4_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "instanceID" : 8,
    "name" : "fuji",
    "ipAddress" : "10.197.87.43",
    "status" : "Unknown",
    "osType" : "SERVER_LINUX",
    "monitorStatus" : "Manage",
    "description" : "XXXX YYYY/ZZ Linux Server",
    "deviceClassificationLabel":"Linux Development Env",
    "usedCredentialID" : 17,
    "usedCredentials" : "10.197.87.43",
    "thresholdProfileID" : 4,
    "thresholdProfileName" : "Default Profile for Linux/UNIX",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "accessPointType" : "SSH",
    "accessPointIpAddress" : "10.197.87.43",
    "accessPointUser" : "root"
  } ],
  "count" : 1
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.10.2　ホストに対する操作一覧の取得

ホストに対して実行できる操作の一覧を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/services/Hosts/actions

リクエストボディー

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

レスポンスボディー

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

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性

データ型

説明

data

anyType[]

Action のコレクション。 Action の詳細は以下の表を参照ください。

pagination

Pagination

ページ情報。リソースが存在しない場合、このパラメータは表示されません。

count

int

条件に合致したデータの個数

pagination (Type: Pagination)

属性

データ型

説明

page

integer

ページ

pageSize

integer

ページサイズ

numPages

integer

ページの数

totalCount

integer

オブジェクトの数

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要なコレクション。空欄です。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/services/Hosts/actions HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:17:42 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 1e89694342cfad52de32bd8e1a2921a48b8d8_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "name" : "changeManagedType",
    "href" : "http://localhost:22015/Analytics/v1/services/Hosts/actions/changeManagedType/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  } ],
  "count" : 1
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.10.3　ホストの監視状態変更に必要な情報の取得

ホストの監視状態を変更するために必要な情報を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/services/Hosts/actions/changeManagedType

リクエストボディー

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

レスポンスボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な ChangeManagedTypeParamForRes のコレクション。 ChangeManagedTypeParamForRes の詳細は以下の表を参照ください。

ChangeManagedTypeParamForRes

{
        "newMonitorStatus":"...",
        "ids":["...", ...]
}

ChangeManagedTypeParamForRes (Type: ChangeManagedTypeParamForRes)

属性

データ型

説明

newMonitorStatus

enum

設定するリソースの管理状態

(指定可能な値は「列挙型一覧」のManagementLevelTypeの表を参照してください。)

以下に示す値のみ指定可能です。

New

Manage

ignore

MonitorOff

ids

long[]

リソースのIDのリスト

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/services/Hosts/actions/changeManagedType HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:19:21 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 5120405fb8a980d12331c748369039cf28af252_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/Hosts/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitorStatus": "Manage",
    "ids" : [ ]
  } ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.10.4　ホストの監視状態の変更

ホストの監視状態を変更します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

POST http[s]://host:port/Analytics/version/services/Hosts/actions/changeManagedType/invoke

リクエストボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な ChangeManagedTypeParamForRes のコレクション。 ChangeManagedTypeParamForRes の詳細は以下の表を参照ください。

ChangeManagedTypeParamForRes

{
        "newMonitorStatus":"...",
        "ids":["...", ...]
}

ChangeManagedTypeParamForRes (Type: ChangeManagedTypeParamForRes)

属性

データ型

説明

newMonitorStatus

enum

設定するリソースの管理状態

(指定可能な値は「列挙型一覧」のManagementLevelTypeの表を参照してください。)

以下に示す値のみ指定可能です。

New

Manage

ignore

MonitorOff

ids

long[]

リソースのIDのリスト

レスポンスボディー

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

Job

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

属性

データ型

説明

instanceID

string

インスタンスのIDを示します。

created

string

オブジェクトの生成日付を示します。ISO8601形式です。

updated

string

オブジェクトが更新された時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

completed

string

処理が完了した時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

state

string

以下の値が設定されます。

“failed”: 操作が正常終了しなかったことを示します。

“success”: 操作が正常終了したことを示します。

affectedResource

string[]

操作の結果，作成または更新されたAPIのリソースのURLを示します。リソースが存在しない場合、このパラメータは空欄です。

result

anyType[]

実行結果のコレクション。空欄です。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

400

Bad Request

リクエストボディ形式不正

401

Unauthorized

ログイン権限がない

403

Forbidden

更新権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
POST /Analytics/v1/services/Hosts/actions/changeManagedType/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 279

[Request Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/Hosts/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitorStatus" : "MonitorOff",
    "ids" : [ 50 ]
  } ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:22:28 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 284045794595c1ed7a98d2184419b8656e48a15_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "53b1e702-9750-4c1c-9857-d1a3a8d4cac7",
  "created" : "2015-11-27T18:22:28.528+09:00",
  "updated" : "2015-11-27T18:22:28.647+09:00",
  "completed" : "2015-11-27T18:22:28.647+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.11　IPスイッチに関するAPI一覧

IPスイッチへの操作を説明します。

2.11.1　IPスイッチの一覧の取得

IPスイッチの一覧を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/IPSwitches

リクエストボディー

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

レスポンスボディー

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

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性

データ型

説明

data

anyType[]

IPSwitch のコレクション。 IPSwitch の詳細は以下の表を参照ください。

pagination

Pagination

ページ情報。リソースが存在しない場合、このパラメータは表示されません。

count

int

条件に合致したデータの個数

pagination (Type: Pagination)

属性

データ型

説明

page

integer

ページ

pageSize

integer

ページサイズ

numPages

integer

ページの数

totalCount

integer

オブジェクトの数

IPSwitch

{
        "instanceID":"...",
        "name":"...",
        "ipAddress":"...",
        "status":"...",
        "monitorStatus":"...",
        "description":"...",
        "usedCredentialID":"...",
        "usedCredentials":"...",
        "thresholdProfileID":"...",
        "thresholdProfileName":"...",
        "accessPointType":"...",
        "accessPointSnmpVersion":"...",
        "accessPointIpAddress":"...",
        "accessPointUser":"..."
}

IPSwitch (Type: IPSwitch)

属性

データ型

説明

instanceID

long

IPスイッチを特定するID

name

string

IPスイッチの名称

ipAddress

string

IPスイッチのIPアドレス

status

enum

IPスイッチの状態

(指定可能な値は「列挙型一覧」のNodeStatusTypeの表を参照してください。)

以下に示す値のみ指定可能です。

Normal

Warning

Error

Unreachable

Unknown

NotMonitored

monitorStatus

enum

IPスイッチの監視状態。

(指定可能な値は「列挙型一覧」のManagementLevelTypeの表を参照してください。)

以下に示す値のみ指定可能です。

New

Manage

ignore

MonitorOff

description

string

IPスイッチの詳細情報

usedCredentialID

long

発見時に使用された認証情報を特定するID。

usedCredentials

string

発見時に使用された認証情報の名称。

thresholdProfileID

long

IPスイッチに割り当たっているしきい値プロファイルを特定するID

thresholdProfileName

string

IPスイッチに割り当たっているしきい値プロファイルの名称

accessPointType

enum

発見時に使用された認証情報の種別。

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

SNMP

accessPointSnmpVersion

enum

発見時に使用されたSNMPのバージョン。

(指定可能な値は「列挙型一覧」のSnmpVersionの表を参照してください。)

以下に示す値のみ指定可能です。

V1_V2C

V3

accessPointIpAddress

string

監視対象への接続に使用したIPアドレス

accessPointUser

string

監視対象への接続に使用したユーザーID

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/IPSwitches HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 21:15:36 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 87d94e387ca516a82287ff4254ddac7f44e18bd4_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "instanceID" : 3,
    "name" : "dell2",
    "ipAddress" : "10.197.87.242",
    "status" : "Unknown",
    "monitorStatus" : "Manage",
    "description" : "YYYY Ethernet Switch",
    "usedCredentialID" : 7,
    "usedCredentials" : "10.197.87.242",
    "thresholdProfileID" : 10,
    "thresholdProfileName" : "Default Profile for IP Switch",
    "accessPointType" : "SNMP",
    "accessPointSnmpVersion" : "V1_V2C",
    "accessPointIpAddress" : "10.197.87.242",
  } ],
  "count" : 1
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.11.2　IPスイッチに対する操作一覧の取得

IPスイッチに対して実行できる操作の一覧を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/services/IPSwitches/actions

リクエストボディー

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

レスポンスボディー

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

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性

データ型

説明

data

anyType[]

Action のコレクション。 Action の詳細は以下の表を参照ください。

pagination

Pagination

ページ情報。リソースが存在しない場合、このパラメータは表示されません。

count

int

条件に合致したデータの個数

pagination (Type: Pagination)

属性

データ型

説明

page

integer

ページ

pageSize

integer

ページサイズ

numPages

integer

ページの数

totalCount

integer

オブジェクトの数

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要なコレクション。空欄です。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/services/IPSwitches/actions HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:17:42 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 1e89694342cfad52de32bd8e1a2921a48b8d8_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "name" : "changeManagedType",
    "href" : "http://localhost:22015/Analytics/v1/services/IPSwitches/actions/changeManagedType/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  } ],
  "count" : 1
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.11.3　IPスイッチの監視状態変更に必要な情報の取得

IPスイッチの監視状態を変更するために必要な情報を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/services/IPSwitches/actions/changeManagedType

リクエストボディー

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

レスポンスボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な ChangeManagedTypeParamForRes のコレクション。 ChangeManagedTypeParamForRes の詳細は以下の表を参照ください。

ChangeManagedTypeParamForRes

{
        "newMonitorStatus":"...",
        "ids":["...", ...]
}

ChangeManagedTypeParamForRes (Type: ChangeManagedTypeParamForRes)

属性

データ型

説明

newMonitorStatus

enum

設定するリソースの管理状態

(指定可能な値は「列挙型一覧」のManagementLevelTypeの表を参照してください。)

以下に示す値のみ指定可能です。

New

Manage

ignore

MonitorOff

ids

long[]

リソースのIDのリスト

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/services/IPSwitches/actions/changeManagedType HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:19:21 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 5120405fb8a980d12331c748369039cf28af252_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/IPSwitches/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitorStatus": "Manage",
    "ids" : [ ]
  } ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.11.4　IPスイッチの監視状態の変更

IPスイッチの監視状態を変更します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

POST http[s]://host:port/Analytics/version/services/IPSwitches/actions/changeManagedType/invoke

リクエストボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な ChangeManagedTypeParamForRes のコレクション。 ChangeManagedTypeParamForRes の詳細は以下の表を参照ください。

ChangeManagedTypeParamForRes

{
        "newMonitorStatus":"...",
        "ids":["...", ...]
}

ChangeManagedTypeParamForRes (Type: ChangeManagedTypeParamForRes)

属性

データ型

説明

newMonitorStatus

enum

設定するリソースの管理状態

(指定可能な値は「列挙型一覧」のManagementLevelTypeの表を参照してください。)

以下に示す値のみ指定可能です。

New

Manage

ignore

MonitorOff

ids

long[]

リソースのIDのリスト

レスポンスボディー

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

Job

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

属性

データ型

説明

instanceID

string

インスタンスのIDを示します。

created

string

オブジェクトの生成日付を示します。ISO8601形式です。

updated

string

オブジェクトが更新された時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

completed

string

処理が完了した時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

state

string

以下の値が設定されます。

“failed”: 操作が正常終了しなかったことを示します。

“success”: 操作が正常終了したことを示します。

affectedResource

string[]

操作の結果，作成または更新されたAPIのリソースのURLを示します。リソースが存在しない場合、このパラメータは空欄です。

result

anyType[]

実行結果のコレクション。空欄です。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

400

Bad Request

リクエストボディ形式不正

401

Unauthorized

ログイン権限がない

403

Forbidden

更新権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
POST /Analytics/v1/services/IPSwitches/actions/changeManagedType/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 284

[Request Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/IPSwitches/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitorStatus" : "MonitorOff",
    "ids" : [ 50 ]
  } ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:22:28 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 284045794595c1ed7a98d2184419b8656e48a15_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "53b1e702-9750-4c1c-9857-d1a3a8d4cac7",
  "created" : "2015-11-27T18:22:28.528+09:00",
  "updated" : "2015-11-27T18:22:28.647+09:00",
  "completed" : "2015-11-27T18:22:28.647+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.12　FCスイッチに関するAPI一覧

FCスイッチへの操作を説明します。

2.12.1　FCスイッチの一覧の取得

FCスイッチの一覧を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/FCSwitches

リクエストボディー

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

レスポンスボディー

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

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性

データ型

説明

data

anyType[]

FCSwitch のコレクション。 FCSwitch の詳細は以下の表を参照ください。

pagination

Pagination

ページ情報。リソースが存在しない場合、このパラメータは表示されません。

count

int

条件に合致したデータの個数

pagination (Type: Pagination)

属性

データ型

説明

page

integer

ページ

pageSize

integer

ページサイズ

numPages

integer

ページの数

totalCount

integer

オブジェクトの数

FCSwitch

{
        "instanceID":"...",
        "name":"...",
        "ipAddress":"...",
        "status":"...",
        "monitorStatus":"...",
        "description":"...",
        "usedCredentialID":"...",
        "usedCredentials":"...",
        "wwn":"...",
        "thresholdProfileID":"...",
        "thresholdProfileName":"...",
        "accessPointType":"...",
        "accessPointIpAddress":"...",
        "accessPointUser":"..."
}

FCSwitch (Type: FCSwitch)

属性

データ型

説明

instanceID

long

FCスイッチを特定するID

name

string

FCスイッチの名称

ipAddress

string

FCスイッチのIPアドレス

status

enum

FCスイッチの状態

(指定可能な値は「列挙型一覧」のNodeStatusTypeの表を参照してください。)

以下に示す値のみ指定可能です。

Normal

Warning

Error

Unreachable

Unknown

NotMonitored

monitorStatus

enum

FCスイッチの監視状態。

(指定可能な値は「列挙型一覧」のManagementLevelTypeの表を参照してください。)

以下に示す値のみ指定可能です。

New

Manage

ignore

MonitorOff

description

string

FCスイッチの詳細情報

usedCredentialID

long

発見時に使用された認証情報を特定するID。

usedCredentials

string

発見時に使用された認証情報の名称。

wwn

string

FCスイッチのWWNの値

thresholdProfileID

long

FCスイッチに割り当たっているしきい値プロファイルを特定するID

thresholdProfileName

string

FCスイッチに割り当たっているしきい値プロファイルの名称

accessPointType

enum

発見時に使用された認証情報の種別。

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

WBEM

SNMP

accessPointIpAddress

string

監視対象への接続に使用したIPアドレス

accessPointUser

string

監視対象への接続に使用したユーザーID

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/FCSwitches HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 07:11:36 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 87d94e387ca516a82287ff4254ddac7f44e18bd4_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "instanceID" : 5,
    "name" : "SANbox",
    "ipAddress" : "10.197.87.222",
    "status" : "Unknown",
    "monitorStatus" : "Manage",
    "description" : "FC Switch",
    "usedCredentialID" : 6,
    "usedCredentials" : "10.197.87.222",
    "wwn" : "10:00:00:C0:DD:0D:62:E4",
    "thresholdProfileID" : 8,
    "thresholdProfileName" : "Default Profile for FC Switch",
    "accessPointType" : "WBEM",
    "accessPointIpAddress" : "10.197.87.222",
    "accessPointUser" : "admin"
  } ],
  "count" : 1
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.12.2　FCスイッチに対する操作一覧の取得

FCスイッチに対して実行できる操作の一覧を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/services/FCSwitches/actions

リクエストボディー

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

レスポンスボディー

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

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性

データ型

説明

data

anyType[]

Action のコレクション。 Action の詳細は以下の表を参照ください。

pagination

Pagination

ページ情報。リソースが存在しない場合、このパラメータは表示されません。

count

int

条件に合致したデータの個数

pagination (Type: Pagination)

属性

データ型

説明

page

integer

ページ

pageSize

integer

ページサイズ

numPages

integer

ページの数

totalCount

integer

オブジェクトの数

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要なコレクション。空欄です。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/services/FCSwitches/actions HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:17:42 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 1e89694342cfad52de32bd8e1a2921a48b8d8_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "name" : "changeManagedType",
    "href" : "http://localhost:22015/Analytics/v1/services/FCSwitches/actions/changeManagedType/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  } ],
  "count" : 1
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.12.3　FCスイッチの監視状態変更に必要な情報の取得

FCスイッチの監視状態を変更するために必要な情報を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/services/FCSwitches/actions/changeManagedType

リクエストボディー

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

レスポンスボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な ChangeManagedTypeParamForRes のコレクション。 ChangeManagedTypeParamForRes の詳細は以下の表を参照ください。

ChangeManagedTypeParamForRes

{
        "newMonitorStatus":"...",
        "ids":["...", ...]
}

ChangeManagedTypeParamForRes (Type: ChangeManagedTypeParamForRes)

属性

データ型

説明

newMonitorStatus

enum

設定するリソースの管理状態

(指定可能な値は「列挙型一覧」のManagementLevelTypeの表を参照してください。)

以下に示す値のみ指定可能です。

New

Manage

ignore

MonitorOff

ids

long[]

リソースのIDのリスト

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/services/FCSwitches/actions/changeManagedType HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:19:21 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 5120405fb8a980d12331c748369039cf28af252_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/FCSwitches/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitorStatus": "Manage",
    "ids" : [ ]
  } ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.12.4　FCスイッチの監視状態の変更

FCスイッチの監視状態を変更します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

POST http[s]://host:port/Analytics/version/services/FCSwitches/actions/changeManagedType/invoke

リクエストボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な ChangeManagedTypeParamForRes のコレクション。 ChangeManagedTypeParamForRes の詳細は以下の表を参照ください。

ChangeManagedTypeParamForRes

{
        "newMonitorStatus":"...",
        "ids":["...", ...]
}

ChangeManagedTypeParamForRes (Type: ChangeManagedTypeParamForRes)

属性

データ型

説明

newMonitorStatus

enum

設定するリソースの管理状態

(指定可能な値は「列挙型一覧」のManagementLevelTypeの表を参照してください。)

以下に示す値のみ指定可能です。

New

Manage

ignore

MonitorOff

ids

long[]

リソースのIDのリスト

レスポンスボディー

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

Job

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

属性

データ型

説明

instanceID

string

インスタンスのIDを示します。

created

string

オブジェクトの生成日付を示します。ISO8601形式です。

updated

string

オブジェクトが更新された時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

completed

string

処理が完了した時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

state

string

以下の値が設定されます。

“failed”: 操作が正常終了しなかったことを示します。

“success”: 操作が正常終了したことを示します。

affectedResource

string[]

操作の結果，作成または更新されたAPIのリソースのURLを示します。リソースが存在しない場合、このパラメータは空欄です。

result

anyType[]

実行結果のコレクション。空欄です。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

400

Bad Request

リクエストボディ形式不正

401

Unauthorized

ログイン権限がない

403

Forbidden

更新権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
POST /Analytics/v1/services/FCSwitches/actions/changeManagedType/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 284

[Request Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/FCSwitches/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitorStatus" : "MonitorOff",
    "ids" : [ 50 ]
  } ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:22:28 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 284045794595c1ed7a98d2184419b8656e48a15_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "53b1e702-9750-4c1c-9857-d1a3a8d4cac7",
  "created" : "2015-11-27T18:22:28.528+09:00",
  "updated" : "2015-11-27T18:22:28.647+09:00",
  "completed" : "2015-11-27T18:22:28.647+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.13　ストレージシステムに関するAPI一覧

ストレージシステムへの操作を説明します。

2.13.1　ストレージシステムの一覧の取得

ストレージシステムの一覧を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/StorageSystems

リクエストボディー

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

レスポンスボディー

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

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性

データ型

説明

data

anyType[]

StorageSystem のコレクション。 StorageSystem の詳細は以下の表を参照ください。

pagination

Pagination

ページ情報。リソースが存在しない場合、このパラメータは表示されません。

count

int

条件に合致したデータの個数

pagination (Type: Pagination)

属性

データ型

説明

page

integer

ページ

pageSize

integer

ページサイズ

numPages

integer

ページの数

totalCount

integer

オブジェクトの数

StorageSystem

{
        "instanceID":"...",
        "name":"...",
        "ipAddress":"...",
        "status":"...",
        "monitorStatus":"...",
        "description":"...",
        "usedCredentialID":"...",
        "usedCredentials":"...",
        "thresholdProfileID":"...",
        "thresholdProfileName":"...",
        "accessPointType":"...",
        "accessPointIpAddress":"...",
        "accessPointUser":"..."
}

StorageSystem (Type: StorageSystem)

属性

データ型

説明

instanceID

long

ストレージシステムを特定するID

name

string

ストレージシステムの名称

ipAddress

string

ストレージシステムのIPアドレス

status

enum

ストレージシステムの状態

(指定可能な値は「列挙型一覧」のNodeStatusTypeの表を参照してください。)

以下に示す値のみ指定可能です。

Normal

Warning

Error

Unreachable

Unknown

NotMonitored

monitorStatus

enum

ストレージシステムの監視状態。

(指定可能な値は「列挙型一覧」のManagementLevelTypeの表を参照してください。)

以下に示す値のみ指定可能です。

New

Manage

ignore

MonitorOff

description

string

ストレージシステムの詳細情報

usedCredentialID

long

発見時に使用された認証情報の名称。

usedCredentials

string

発見時に使用された認証情報を特定するID。

thresholdProfileID

long

ストレージシステムに割り当たっているしきい値プロファイルを特定するID

thresholdProfileName

string

ストレージシステムに割り当たっているしきい値プロファイル名称

accessPointType

enum

発見時に使用された認証情報の種別。

(指定可能な値は「列挙型一覧」のProtocolTypeの表を参照してください。)

以下に示す値のみ指定可能です。

WBEM

accessPointIpAddress

string

監視対象への接続に使用したIPアドレス

accessPointUser

string

監視対象への接続に使用したユーザーID

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/StorageSystems HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 07:11:36 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 87d94e387ca516a82287ff4254ddac7f44e18bd4_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "instanceID" : 6,
    "name" : "storage",
    "ipAddress" : "10.197.87.17, 192.168.20.54",
    "status" : "Unknown",
    "monitorStatus" : "Manage",
    "description" : "Storage Systems",
    "usedCredentialID" : 10,
    "usedCredentials" : "172.17.3.107",
    "thresholdProfileID" : 14,
    "thresholdProfileName" : "Default Profile for Storage (SMI-S WBEM)",
    "accessPointType" : "WBEM",
    "accessPointIpAddress" : "172.17.3.107",
    "accessPointUser" : "Administrator"
  } ],
  "count" : 1
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.13.2　ストレージシステムに対する操作一覧の取得

ストレージシステムに対して実行できる操作の一覧を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/services/StorageSystems/actions

リクエストボディー

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

レスポンスボディー

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

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性

データ型

説明

data

anyType[]

Action のコレクション。 Action の詳細は以下の表を参照ください。

pagination

Pagination

ページ情報。リソースが存在しない場合、このパラメータは表示されません。

count

int

条件に合致したデータの個数

pagination (Type: Pagination)

属性

データ型

説明

page

integer

ページ

pageSize

integer

ページサイズ

numPages

integer

ページの数

totalCount

integer

オブジェクトの数

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要なコレクション。空欄です。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/services/StorageSystems/actions HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:17:42 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 1e89694342cfad52de32bd8e1a2921a48b8d8_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "name" : "changeManagedType",
    "href" : "http://localhost:22015/Analytics/v1/services/StorageSystems/actions/changeManagedType/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ ]
  } ],
  "count" : 1
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.13.3　ストレージシステムの監視状態変更に必要な情報の取得

ストレージシステムの監視状態を変更するために必要な情報を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/services/StorageSystems/actions/changeManagedType

リクエストボディー

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

レスポンスボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な ChangeManagedTypeParamForRes のコレクション。 ChangeManagedTypeParamForRes の詳細は以下の表を参照ください。

ChangeManagedTypeParamForRes

{
        "newMonitorStatus":"...",
        "ids":["...", ...]
}

ChangeManagedTypeParamForRes (Type: ChangeManagedTypeParamForRes)

属性

データ型

説明

newMonitorStatus

enum

設定するリソースの管理状態

(指定可能な値は「列挙型一覧」のManagementLevelTypeの表を参照してください。)

以下に示す値のみ指定可能です。

New

Manage

ignore

MonitorOff

ids

long[]

リソースのIDのリスト

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/services/StorageSystems/actions/changeManagedType HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:19:21 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 5120405fb8a980d12331c748369039cf28af252_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/StorageSystems/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitorStatus": "Manage",
    "ids" : [ ]
  } ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.13.4　ストレージシステムの監視状態の変更

ストレージシステムの監視状態を変更します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

POST http[s]://host:port/Analytics/version/services/StorageSystems/actions/changeManagedType/invoke

リクエストボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な ChangeManagedTypeParamForRes のコレクション。 ChangeManagedTypeParamForRes の詳細は以下の表を参照ください。

ChangeManagedTypeParamForRes

{
        "newMonitorStatus":"...",
        "ids":["...", ...]
}

ChangeManagedTypeParamForRes (Type: ChangeManagedTypeParamForRes)

属性

データ型

説明

newMonitorStatus

enum

設定するリソースの管理状態

(指定可能な値は「列挙型一覧」のManagementLevelTypeの表を参照してください。)

以下に示す値のみ指定可能です。

New

Manage

ignore

MonitorOff

ids

long[]

リソースのIDのリスト

レスポンスボディー

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

Job

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

属性

データ型

説明

instanceID

string

インスタンスのIDを示します。

created

string

オブジェクトの生成日付を示します。ISO8601形式です。

updated

string

オブジェクトが更新された時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

completed

string

処理が完了した時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

state

string

以下の値が設定されます。

“failed”: 操作が正常終了しなかったことを示します。

“success”: 操作が正常終了したことを示します。

affectedResource

string[]

操作の結果，作成または更新されたAPIのリソースのURLを示します。リソースが存在しない場合、このパラメータは空欄です。

result

anyType[]

実行結果のコレクション。空欄です。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

400

Bad Request

リクエストボディ形式不正

401

Unauthorized

ログイン権限がない

403

Forbidden

更新権限がない

404

Not Found

リソースが存在しない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
POST /Analytics/v1/services/StorageSystems/actions/changeManagedType/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 288

[Request Body]
{
  "name" : "changeManagedType",
  "href" : "http://localhost:22015/Analytics/v1/services/StorageSystems/actions/changeManagedType/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "newMonitorStatus" : "MonitorOff",
    "ids" : [ 50 ]
  } ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:22:28 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 284045794595c1ed7a98d2184419b8656e48a15_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "53b1e702-9750-4c1c-9857-d1a3a8d4cac7",
  "created" : "2015-11-27T18:22:28.528+09:00",
  "updated" : "2015-11-27T18:22:28.647+09:00",
  "completed" : "2015-11-27T18:22:28.647+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.14　ボリュームに関するAPI一覧

ボリュームへの操作を説明します。

2.14.1　ボリュームの一覧の取得

ボリュームの一覧を取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/Volumes

リクエストボディー

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

レスポンスボディー

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

Collections

{
        "data":["...", ...],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性

データ型

説明

data

anyType[]

Volume のコレクション。 Volume の詳細は以下の表を参照ください。

pagination

Pagination

ページ情報。リソースが存在しない場合、このパラメータは表示されません。

count

int

条件に合致したデータの個数

pagination (Type: Pagination)

属性

データ型

説明

page

integer

ページ

pageSize

integer

ページサイズ

numPages

integer

ページの数

totalCount

integer

オブジェクトの数

Volume

{
        "instanceID":"...",
        "status":"...",
        "ldev":"...",
        "storageSubsystemID":"...",
        "storageSubsystem":"...",
        "storageSubsystemMonitorStatus":"...",
        "parityGroup":"...",
        "storagePool":"...",
        "thresholdProfileID":"...",
        "thresholdProfileName":"...",
        "groupIDs":["...", ...],
        "groupNames":["...", ...],
        "gradeNames":["...", ...],
        "gradeOrders":["...", ...]
}

Volume (Type: Volume)

属性

データ型

説明

instanceID

long

ボリュームをを特定するID

status

enum

ボリュームの状態

(指定可能な値は「列挙型一覧」のNodeStatusTypeの表を参照してください。)

以下に示す値のみ指定可能です。

Normal

Warning

Error

Unreachable

Unknown

ldev

string

ボリュームが属するLDEVの名称

storageSubsystemID

long

ボリュームが属するストレージシステムを特定するID

storageSubsystem

string

ボリュームが属するストレージシステムの名称

storageSubsystemMonitorStatus

enum

ボリュームが属するストレージシステムの監視状態

(指定可能な値は「列挙型一覧」のManagementLevelTypeの表を参照してください。)

以下に示す値のみ指定可能です。

New

Manage

ignore

MonitorOff

parityGroup

string

ボリュームが属するパリティグループの名称

storagePool

string

ボリュームが属するストレージシステムプールの名称

thresholdProfileID

long

ボリュームに割りあたっているしきい値プロファイルを特定するID

thresholdProfileName

string

ボリュームに割りあたっているしきい値プロファイルの名称

groupIDs

long[]

ボリュームが割り当たっているコンシューマーを特定するID

groupNames

string[]

ボリュームが割り当たっているコンシューマーの名称

gradeNames

string[]

ボリュームが割り当たっているコンシューマーのグレード

gradeOrders

integer[]

ボリュームが割り当たっているコンシューマーのグレードの優先度

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

403

Forbidden

参照権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/objects/Volumes HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 07:11:36 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO df3a7ac35f3b99a9b2afafd22d433167067da9_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "instanceID" : 540,
    "status" : "Unknown",
    "ldev" : "vol0 (LU NUM=699d3b60-18f9-11de-a169-00a09810f3f4)",
    "storageSubsystemID" : 6,
    "storageSubsystem" : "FAS2050A-2",
    "storageSubsystemMonitorStatus" : "Manage",
    "thresholdProfileID" : 21,
    "thresholdProfileName" : "Default Profile for Volume",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ]
  }, {
    "instanceID" : 534,
    "status" : "Unknown",
    "ldev" : "vol1 (LU NUM=7cb5b900-1c0e-11de-9f89-00a09810f3f4)",
    "storageSubsystemID" : 6,
    "storageSubsystem" : "FAS2050A-2",
    "storageSubsystemMonitorStatus" : "Manage",
    "thresholdProfileID" : 21,
    "thresholdProfileName" : "Default Profile for Volume",
    "groupIDs" : [ 0 ],
    "groupNames" : [ "#Unassigned Resources" ],
    "gradeNames" : [ "" ],
    "gradeOrders" : [ -1 ]
  } ],
  "count" : 2
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.15　イベント情報に関するAPI一覧

イベントの情報を取得するための操作を説明します。

2.15.1　イベントの一覧をCSVで取得するために必要な情報の取得

イベントの一覧をCSVで取得するために必要な情報の取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/services/Events/actions/getEventDataCSV

リクエストボディー

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

レスポンスボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な ListGetParam のコレクション。 ListGetParam の詳細は以下の表を参照ください。

ListGetParam

{
        "hqlFilter":"...",
        "hqlSort":"...",
        "page":"...",
        "pageSize":"..."
}

ListGetParam (Type: ListGetParam)

属性

データ型

説明

hqlFilter

string

フィルタ情報

hqlSort

string

ソート情報

page

integer

取得ページ

pageSize

integer

ページサイズ

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/services/Events/actions/getEventDataCSV HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:17:42 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 1e89694342cfad52de32bd8e1a2921a48b8d8_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data": [{
    "name": "getNodesGraphDataCSV",
    "href": "http://localhost:22015/Analytics/v1/services/Events/actions/getEventDataCSV/invoke",
    "method": "POST",
    "type": "application/json",
    "parameters": [ {
      "hqlFilter" : "",
      "hqlSort" : "",
      "page" : 1,
      "pageSize" : 0
    }],
    "count": 1
 }]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.15.2　イベントの一覧をCSVで取得

イベントの一覧をCSVで取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

POST http[s]://host:port/Analytics/version/services/Events/actions/getEventDataCSV/invoke

リクエストボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な ListGetParam のコレクション。 ListGetParam の詳細は以下の表を参照ください。

ListGetParam

{
        "hqlFilter":"...",
        "hqlSort":"...",
        "page":"...",
        "pageSize":"..."
}

ListGetParam (Type: ListGetParam)

属性

データ型

説明

hqlFilter

string

フィルタ情報

hqlSort

string

ソート情報

page

integer

取得ページ

pageSize

integer

ページサイズ

レスポンスボディー

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

Job

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

属性

データ型

説明

instanceID

string

インスタンスのIDを示します。

created

string

オブジェクトの生成日付を示します。ISO8601形式です。

updated

string

オブジェクトが更新された時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

completed

string

処理が完了した時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

state

string

以下の値が設定されます。

“failed”: 操作が正常終了しなかったことを示します。

“success”: 操作が正常終了したことを示します。

affectedResource

string[]

操作の結果，作成または更新されたAPIのリソースのURLを示します。リソースが存在しない場合、このパラメータは空欄です。

result

anyType[]

実行結果の CsvData のコレクション。 CsvData の詳細は以下の表を参照ください。

CsvData

{
        "data":"..."
}

CsvData (Type: CsvData)

属性

データ型

説明

data

string

CSVデータが格納されます。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

400

Bad Request

リクエストボディ形式不正

401

Unauthorized

ログイン権限がない

403

Forbidden

実行権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
POST /Analytics/v1/services/Events/actions/getEventDataCSV/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 296

[Request Body]
{
  "name" : "getNodesGraphDataCSV",
  "href" : "http://localhost:22015/Analytics/v1/services/Events/actions/getEventDataCSV/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "hqlFilter" : "",
    "hqlSort" : "",
    "page" : 1,
    "pageSize" : 0
  } ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:22:28 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 284045794595c1ed7a98d2184419b8656e48a15_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "0052a2e2-713c-4cfb-892c-e9aaefb32b50",
  "created" : "2016-11-22T11:53:42.188+09:00",
  "updated" : "2016-11-22T11:53:42.354+09:00",
  "completed" : "2016-11-22T11:53:42.354+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ {
    "data": ""#JP1/Operations Analytics","111000","UTF-8 (BOM)"¥n"#Event Information"¥n..."
  } ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.16　［E2Eビュー］画面に関するAPI一覧

指定したリソースの情報や関連するリソース一覧を取得するための操作を説明します。

2.16.1　指定したリソースの情報や関連するリソース一覧をCSVで取得するために必要な情報の取得

指定したリソースの情報や関連するリソース一覧をCSVで取得するために必要な情報の取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/services/E2EView/actions/getNodesDataCSV

リクエストボディー

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

レスポンスボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な GetNodesDataCSVParam のコレクション。 GetNodesDataCSVParam の詳細は以下の表を参照ください。

GetNodesDataCSVParam

{
        "basePointNodes":[{
            "nodeID":"...",
            "nodeType":"..."
        },
        :
        ],
        "getType":"..."
}

GetNodesDataCSVParam (Type: GetNodesDataCSVParam)

属性

データ型

説明

basePointNodes

E2ENodeKey[]

ベースポイントとして指定する、取得対象のノードのリスト

getType

enum

取得する情報の区分

(指定可能な値は「列挙型一覧」のNodeInformationTypeの表を参照してください。)

basePointNodes (Type: E2ENodeKey)

属性

データ型

説明

nodeID

long

ノードのID

nodeType

enum

ノードの種別

(指定可能な値は「列挙型一覧」のE2ENodeTypeの表を参照してください。)

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET  http://127.0.0.1:22015/Analytics/v1/services/E2EView/actions/getNodesDataCSV
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Response Header]
HTTP/1.1 200 OK
Date: Tue, 22 Nov 2016 02:43:37 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 33659a74fcee4358dc272b34eca6ded1bf1131ec_YXZvNFIMehp3UB4jbmVyPGUgT3Q=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "name": "getNodesDataCSV",
  "href": "http://10.197.196.239:22015/Analytics/v1/services/E2EView/actions/getNodesDataCSV/invoke",
  "method": "POST",
  "type": "application/json",
  "parameters": [
    {
      "basePointNodes": [{
          "nodeID": 1,
          "nodeType": "VIRTUAL_MACHINE"
        }],
      "selectedNodes": [{
          "nodeID": 1,
          "nodeType": "VIRTUAL_MACHINE"
        }],
      "highlightNodes": [{
          "nodeID": 1,
          "nodeType": "VIRTUAL_MACHINE"
        }],
      "getType": "AllInformation"
    }
  ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.16.2　指定したリソースの情報や関連するリソース一覧をCSVで取得

指定したリソースの情報や関連するリソース一覧をCSVで取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

POST http[s]://host:port/Analytics/version/services/E2EView/actions/getNodesDataCSV/invoke

リクエストボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な GetNodesDataCSVParam のコレクション。 GetNodesDataCSVParam の詳細は以下の表を参照ください。

GetNodesDataCSVParam

{
        "basePointNodes":[{
            "nodeID":"...",
            "nodeType":"..."
        },
        :
        ],
        "getType":"..."
}

GetNodesDataCSVParam (Type: GetNodesDataCSVParam)

属性

データ型

説明

basePointNodes

E2ENodeKey[]

ベースポイントとして指定する、取得対象のノードのリスト

getType

enum

取得する情報の区分

(指定可能な値は「列挙型一覧」のNodeInformationTypeの表を参照してください。)

basePointNodes (Type: E2ENodeKey)

属性

データ型

説明

nodeID

long

ノードのID

nodeType

enum

ノードの種別

(指定可能な値は「列挙型一覧」のE2ENodeTypeの表を参照してください。)

レスポンスボディー

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

Job

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

属性

データ型

説明

instanceID

string

インスタンスのIDを示します。

created

string

オブジェクトの生成日付を示します。ISO8601形式です。

updated

string

オブジェクトが更新された時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

completed

string

処理が完了した時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

state

string

以下の値が設定されます。

“failed”: 操作が正常終了しなかったことを示します。

“success”: 操作が正常終了したことを示します。

affectedResource

string[]

操作の結果，作成または更新されたAPIのリソースのURLを示します。リソースが存在しない場合、このパラメータは空欄です。

result

anyType[]

実行結果の CsvData のコレクション。 CsvData の詳細は以下の表を参照ください。

CsvData

{
        "data":"..."
}

CsvData (Type: CsvData)

属性

データ型

説明

data

string

CSVデータが格納されます。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

400

Bad Request

リクエストボディ形式不正

401

Unauthorized

ログイン権限がない

412

Precondition Failed

・サーバーが起動していない

・クエリパラメータしきい値超え

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
POST http://127.0.0.1:22015/Analytics/v1/services/E2EView/actions/getNodesDataCSV/invoke
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Host: localhost:22015
Accept: application/json
Content-Type: application/json

[Request Body]
{
  "basePointNodes": [{
      "nodeID": 1,
      "nodeType": "VIRTUAL_MACHINE"
    }],
  "selectedNodes": [{
      "nodeID": 1,
      "nodeType": "VIRTUAL_MACHINE"
    }],
  "highlightNodes": [{
      "nodeID": 1,
      "nodeType": "VIRTUAL_MACHINE"
    }],
  "getType": "AllInformation"
}

[Response Header]
HTTP/1.1 200 OK
Date: Tue, 22 Nov 2016 02:43:37 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 33659a74fcee4358dc272b34eca6ded1bf1131ec_YXZvNFIMehp3UB4jbmVyPGUgT3Q=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "0052a2e2-713c-4cfb-892c-e9aaefb32b50",
  "created" : "2016-11-22T11:53:42.188+09:00",
  "updated" : "2016-11-22T11:53:42.354+09:00",
  "completed" : "2016-11-22T11:53:42.354+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ {
    "data": ""#JP1/Operations Analytics","111000","UTF-8 (BOM)"¥n"#Resource Information"¥n..."
  } ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.17　性能情報に関するAPI一覧

性能情報を取得するための操作を説明します。

2.17.1　指定した性能情報の時系列での性能値をCSVで取得するために必要な情報の取得

指定した性能情報の時系列での性能値をCSVで取得するために必要な情報の取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/services/PerfComponents/actions/getGraphDataCSV

リクエストボディー

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

レスポンスボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な GetGraphDataCSVParam のコレクション。 GetGraphDataCSVParam の詳細は以下の表を参照ください。

GetGraphDataCSVParam

{
        "perfComponentIDs":["...", ...],
        "baseTime":"...",
        "pointTimeRange":"..."
}

GetGraphDataCSVParam (Type: GetGraphDataCSVParam)

属性

データ型

説明

perfComponentIDs

long[]

PerfComponentのID

baseTime

dateTime

性能情報を取得する基点の時刻。指定した時刻からpointTimeRangeで指定した期間さかのぼった時刻までの性能情報を取得します。省略した場合は，APIを実行した時刻が基点として使用されます。

pointTimeRange

long

性能情報を取得する期間 [ミリ秒]

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/services/PerfComponents/actions HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:17:42 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 1e89694342cfad52de32bd8e1a2921a48b8d8_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data" : [ {
    "name" : "getGraphDataCSV",
    "href" : "http://localhost:22015/Analytics/v1/services/PerfComponents/actions/getGraphDataCSV/invoke",
    "method" : "POST",
    "type" : "application/json",
    "parameters" : [ {
    "perfComponentIDs" : [ ],
    "baseTime" : "2016-11-25T11:11:04.489+09:00",
    "pointTimeRange" : 86400000
  }  ]
  } ],
  "count" : 1
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.17.2　指定した性能情報の時系列での性能値をCSVで取得

指定した性能情報の時系列での性能値をCSVで取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

POST http[s]://host:port/Analytics/version/services/PerfComponents/actions/getGraphDataCSV/invoke

リクエストボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な GetGraphDataCSVParam のコレクション。 GetGraphDataCSVParam の詳細は以下の表を参照ください。

GetGraphDataCSVParam

{
        "perfComponentIDs":["...", ...],
        "baseTime":"...",
        "pointTimeRange":"..."
}

GetGraphDataCSVParam (Type: GetGraphDataCSVParam)

属性

データ型

説明

perfComponentIDs

long[]

PerfComponentのID

baseTime

dateTime

性能情報を取得する基点の時刻。指定した時刻からpointTimeRangeで指定した期間さかのぼった時刻までの性能情報を取得します。省略した場合は，APIを実行した時刻が基点として使用されます。

pointTimeRange

long

性能情報を取得する期間 [ミリ秒]

レスポンスボディー

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

Job

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

属性

データ型

説明

instanceID

string

インスタンスのIDを示します。

created

string

オブジェクトの生成日付を示します。ISO8601形式です。

updated

string

オブジェクトが更新された時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

completed

string

処理が完了した時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

state

string

以下の値が設定されます。

“failed”: 操作が正常終了しなかったことを示します。

“success”: 操作が正常終了したことを示します。

affectedResource

string[]

操作の結果，作成または更新されたAPIのリソースのURLを示します。リソースが存在しない場合、このパラメータは空欄です。

result

anyType[]

実行結果の CsvData のコレクション。 CsvData の詳細は以下の表を参照ください。

CsvData

{
        "data":"..."
}

CsvData (Type: CsvData)

属性

データ型

説明

data

string

CSVデータが格納されます。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

400

Bad Request

リクエストボディ形式不正

401

Unauthorized

ログイン権限がない

403

Forbidden

実行権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
POST /Analytics/v1/services/PerfComponents/actions/getGraphDataCSV/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 296

[Request Body]
{
  "name" : "getGraphDataCSV",
  "href" : "http://localhost:22015/Analytics/v1/services/PerfComponents/actions/getGraphDataCSV/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [ {
    "perfComponentIDs" : [ ],
    "baseTime" : "2016-11-25T11:11:04.489+09:00",
    "pointTimeRange" : 86400000
  }  ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:22:28 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 284045794595c1ed7a98d2184419b8656e48a15_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "0052a2e2-713c-4cfb-892c-e9aaefb32b50",
  "created" : "2016-11-22T11:53:42.188+09:00",
  "updated" : "2016-11-22T11:53:42.354+09:00",
  "completed" : "2016-11-22T11:53:42.354+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ {
    "data": ""#JP1/Operations Analytics","111000","UTF-8 (BOM)"¥n"#Time Series Performance Information"¥n..."
  } ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.17.3　指定したリソースが持つ性能情報の最新値をCSVで取得するために必要な情報の取得

指定したリソースが持つ性能情報の最新値をCSVで取得するために必要な情報の取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/services/PerfComponents/actions/getNodesGraphDataCSV

リクエストボディー

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

レスポンスボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な GetNodesGraphDataCSVParam のコレクション。 GetNodesGraphDataCSVParam の詳細は以下の表を参照ください。

GetNodesGraphDataCSVParam

{
        "basePointNodes":[{
            "nodeID":"...",
            "nodeType":"..."
        },
        :
        ],
        "baseTime":"..."
}

GetNodesGraphDataCSVParam (Type: GetNodesGraphDataCSVParam)

属性

データ型

説明

basePointNodes

E2ENodeKey[]

ベースポイントとして指定する、取得対象のノードのリスト

baseTime

dateTime

性能情報を取得する基点の時刻。省略した場合は，APIを実行した時刻が基点として使用されます。

basePointNodes (Type: E2ENodeKey)

属性

データ型

説明

nodeID

long

ノードのID

nodeType

enum

ノードの種別

(指定可能な値は「列挙型一覧」のE2ENodeTypeの表を参照してください。)

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/services/PerfComponents/actions/getNodesGraphDataCSV HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:17:42 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 1e89694342cfad52de32bd8e1a2921a48b8d8_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "data": [{
    "name": "getNodesGraphDataCSV",
    "href": "http://localhost:22015/Analytics/v1/services/PerfComponents/actions/getNodesGraphDataCSV/invoke",
    "method": "POST",
    "type": "application/json",
    "parameters": [{
      "basePointNodes": [{
          "nodeID": 1,
          "nodeType": "VIRTUAL_MACHINE"
        }],
      "selectedNodes": [{
          "nodeID": 1,
          "nodeType": "VIRTUAL_MACHINE"
        }],
      "baseTime": "2016-11-28T16:03:02.592+09:00"
    }]
  }],
  "count": 1
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.17.4　指定したリソースが持つ性能情報の最新値をCSVで取得

指定したリソースが持つ性能情報の最新値をCSVで取得します。

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

POST http[s]://host:port/Analytics/version/services/PerfComponents/actions/getNodesGraphDataCSV/invoke

リクエストボディー

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

Action

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":["...", ...]
}

Action (Type: Action)

属性

データ型

説明

name

string

操作名です。

href

string

操作の実行先URLです。

method

string

メソッド名です。

type

string

データのデータ形式です。

parameters

anyType[]

操作実行時に必要な GetNodesGraphDataCSVParam のコレクション。 GetNodesGraphDataCSVParam の詳細は以下の表を参照ください。

GetNodesGraphDataCSVParam

{
        "basePointNodes":[{
            "nodeID":"...",
            "nodeType":"..."
        },
        :
        ],
        "baseTime":"..."
}

GetNodesGraphDataCSVParam (Type: GetNodesGraphDataCSVParam)

属性

データ型

説明

basePointNodes

E2ENodeKey[]

ベースポイントとして指定する、取得対象のノードのリスト

baseTime

dateTime

性能情報を取得する基点の時刻。省略した場合は，APIを実行した時刻が基点として使用されます。

basePointNodes (Type: E2ENodeKey)

属性

データ型

説明

nodeID

long

ノードのID

nodeType

enum

ノードの種別

(指定可能な値は「列挙型一覧」のE2ENodeTypeの表を参照してください。)

レスポンスボディー

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

Job

{
        "instanceID":"...",
        "created":"...",
        "updated":"...",
        "completed":"...",
        "state":"...",
        "affectedResource":["...", ...],
        "result":["...", ...]
}

Job (Type: Job)

属性

データ型

説明

instanceID

string

インスタンスのIDを示します。

created

string

オブジェクトの生成日付を示します。ISO8601形式です。

updated

string

オブジェクトが更新された時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

completed

string

処理が完了した時刻を示します。createdと同時刻が設定されます。ISO8601形式です。

state

string

以下の値が設定されます。

“failed”: 操作が正常終了しなかったことを示します。

“success”: 操作が正常終了したことを示します。

affectedResource

string[]

操作の結果，作成または更新されたAPIのリソースのURLを示します。リソースが存在しない場合、このパラメータは空欄です。

result

anyType[]

実行結果の CsvData のコレクション。 CsvData の詳細は以下の表を参照ください。

CsvData

{
        "data":"..."
}

CsvData (Type: CsvData)

属性

データ型

説明

data

string

CSVデータが格納されます。

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

400

Bad Request

リクエストボディ形式不正

401

Unauthorized

ログイン権限がない

403

Forbidden

実行権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
POST /Analytics/v1/services/PerfComponents/actions/getNodesGraphDataCSV/invoke HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Content-Type: application/json
Accept-Language: ja
Content-Length: 296

[Request Body]
{
  "name" : "getNodesGraphDataCSV",
  "href" : "http://localhost:22015/Analytics/v1/services/PerfComponents/actions/getNodesGraphDataCSV/invoke",
  "method" : "POST",
  "type" : "application/json",
  "parameters" : [{
      "basePointNodes": [{
          "nodeID": 1,
          "nodeType": "VIRTUAL_MACHINE"
        }],
      "selectedNodes": [{
          "nodeID": 1,
          "nodeType": "VIRTUAL_MACHINE"
        }],
      "baseTime": "2016-11-28T16:03:02.592+09:00"
  } ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Fri, 27 Nov 2015 09:22:28 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 284045794595c1ed7a98d2184419b8656e48a15_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
  "instanceID" : "0052a2e2-713c-4cfb-892c-e9aaefb32b50",
  "created" : "2016-11-22T11:53:42.188+09:00",
  "updated" : "2016-11-22T11:53:42.354+09:00",
  "completed" : "2016-11-22T11:53:42.354+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ {
    "data": ""#JP1/Operations Analytics","111000","UTF-8 (BOM)"¥n"#Latest Performance Information"¥n..."
  } ]
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

2.18　情報管理に関するAPI一覧

JP1/OAおよびAPIのバージョン情報を取得するための操作を説明します。

2.18.1　バージョン情報の取得

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

権限

Admin, Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/configuration/version

リクエストボディー

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

レスポンスボディー

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

Version

{
        "productName":"...",
        "productVersion":"...",
        "apiVersion":"..."
}

Version (Type: Version)

属性

データ型

説明

productName

string

製品名

productVersion

string

製品のバージョン情報

apiVersion

string

APIのバージョン情報

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET /Analytics/v1/configuration/version HTTP/1.1
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
User-Agent: curl/7.33.0
Host: localhost:22015
Accept: application/json
Accept-Language: ja

[Response Header]
HTTP/1.1 200 OK
Date: Mon, 30 Nov 2015 09:11:45 GMT
289
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 184593e47ca3e5ff4e150cc8dc32f4f756218e_WVlGcHsLfg5ffg0I_V0810
X-Frame-Options: SAMEORIGIN
Transfer-Encoding: chunked
Content-Type: application/json

[Response Body]
{
"productName" : "JP1/Operations Analytics",
"productVersion" : "11.00.01",
"apiVersion" : "01.00.00"
}

関連項目

1.3　リソースのメンバー

1.6　列挙型一覧

付録

付録A　各バージョンの変更内容

付録A.1　11-50の変更内容

探索範囲（IPAddrRangeリソース）のメンバーにdeviceClassificationLabelを追加した。

コレクター（Collectorsリソース）のメンバーにproductName，providerNameおよびrefreshDateForAppを追加した。

ホスト（Hostsリソース）のメンバーにdeviceClassificationLabelを追加した。

アプリケーション（Applicationsリソース）のメンバーについて，次のとおり追加または削除した。

applicationDetailTypeおよびapplicationHostsを追加した。

resourceIDおよびresourceTypeを削除した。

アプリケーションのリソース情報（ApplicationHostリソース）のメンバーについての説明を追加した。

列挙型一覧にCUSTOMおよびAPPLICATION_CUSTOMを追加した。

次に示すAPIのIPAddrRange (Type: IPAddrRange)オブジェクトにdeviceClassificationLabel属性を追加した。

探索範囲の一覧の取得

探索範囲の情報取得

探索範囲の作成

探索範囲の更新

次に示すAPIのステータスコード400についての説明を変更した。

コレクターの作成

コレクターの更新

次に示すAPIにステータスコード400を追加した。

コレクターの削除

次に示すAPIのApplication (Type: Application)オブジェクトにapplicationDetailType属性を追加した。

アプリケーションの一覧の取得

次に示すAPIのHost (Type: Host)オブジェクトにdeviceClassificationLabel属性を追加した。

ホストの一覧の取得

索引

A

API の概要[1]

APIによるJP1/OAの操作[1]

APIの記述形式[1]

APIの共通仕様[1]

E

［E2Eビュー］画面に関するAPI一覧[1]

F

FCスイッチに関するAPI一覧[1]

I

IPスイッチに関するAPI一覧[1]

あ

アプリケーションに関するAPI一覧[1]

い

イベント情報に関するAPI一覧[1]

か

仮想マシンに関するAPI一覧[1]

管理対象探索に関するAPI一覧[1]

こ

コレクターに関するAPI一覧[1]

コンシューマーに関するAPI一覧[1]

し

システムプロファイルに関するAPI一覧[1]

情報管理に関するAPI一覧[1]

す

ストレージシステムに関するAPI一覧[1]

せ

性能情報に関するAPI一覧[1]

に

認証情報に関するAPI一覧[1]

は

ハイパーバイザーに関するAPI一覧[1]

ほ

ホストに関するAPI一覧[1]

ボリュームに関するAPI一覧[1]

ゆ

ユーザープロファイルに関するAPI一覧[1]

り

リソースのメンバー[1]

マニュアル発行元

株式会社 日立製作所

〒100-8280　東京都千代田区丸の内一丁目6番6号