2.2.1　探索範囲の一覧の取得

JP1/OAが監視対象の探索で使用する探索範囲の一覧を取得します。

権限

Admin

APIのバージョン

リクエスト形式

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
}

2.2.1 探索範囲の一覧の取得

2.2.1　探索範囲の一覧の取得