Hitachi

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


2.4.7 探索履歴の取得

最後に探索を実行した際の結果を取得します。

権限

Modify

APIのバージョン

v1

リクエスト形式

GET http[s]://host:port/Analytics/version/objects/DiscoveryLogs

リクエストボディー

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

レスポンスボディー

レスポンスボディーの構造とオブジェクトの属性を次に示します。
{
        "data":[{
            "status":"...",
            "autoManage":"...",
            "startTime":"...",
            "completionTime":"...",
            "elapsedTime":"...",
            "discoveredResources":"...",
            "failedProtocols":"...",
            "noResponseIpAddresses":"...",
            "skippedResources":"...",
            "denominatorForProgress":"...",
            "numeratorForProgress":"...",
            "lastTime":"...",
            "discoverdLogTargetIPRange":[{
                "name":"..."
            },
            :
            ]
        },
        :
        ],
        "pagination":{
            "page":"...",
            "pageSize":"...",
            "numPages":"...",
            "totalCount":"..."
        },
        "count":"..."
}

Collections (Type: Collections)

属性

データ型

説明

data

DiscoveryLog[]

DiscoveryLogのコレクション。DiscoveryLogの詳細は以下の表を参照ください。

pagination

Pagination

ページ情報。リソースが存在しない場合、このパラメータは表示されません。

count

int

条件に合致したデータの個数

data (Type: DiscoveryLog)

属性

データ型

説明

status

enum

探索の実行状況。探索が未実施の場合はstatus以外のプロパティは出力されません。

(指定可能な値は「列挙型一覧」のDiscoveryStatusTypeの表を参照してください。)

以下に示す値のみ指定可能です。

  • Running
  • Completed
  • Canceled
  • Unexecuted
  • Error

autoManage

boolean

探索により発見したリソースを自動的に管理対象にする場合true

startTime

dateTime

探索の開始時間

completionTime

dateTime

探索の完了時間。実行中の場合は,null が設定される。

elapsedTime

int

探索の経過時間(秒)

discoveredResources

int

探索で見つかったリソース数

failedProtocols

int

探索に失敗したリソース数

noResponseIpAddresses

int

応答がなかったリソース数

skippedResources

int

スキップされたリソース数

denominatorForProgress

int

進捗計算用の分母

numeratorForProgress

int

進捗計算用の分子。探索実行対象のうち、処理が完了したIPアドレス数。

lastTime

dateTime

探索の状況を確認した最後の時間

discoverdLogTargetIPRange

DiscoveryLogTargetIPRange[]

探索結果に含まれる探索範囲のリスト

discoverdLogTargetIPRange (Type: DiscoveryLogTargetIPRange)

属性

データ型

説明

name

string

探索範囲の名称

pagination (Type: Pagination)

属性

データ型

説明

page

integer

ページ

pageSize

integer

ページサイズ

numPages

integer

ページの数

totalCount

integer

オブジェクトの数

ステータスコード

HTTPステータスコード

Reason phrase

説明

200

OK

正常終了

401

Unauthorized

ログイン権限がない

412

Precondition Failed

サーバーが起動していない

500

Internal Server Error

サーバーサイドエラー

使用例

[Request Header]
GET http://localhost:22015/Analytics/v1/objects/DiscoveryLogs/ HTTP/1.1
Host: localhost:22015
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=

[Response Header]
HTTP/1.1 200 OK
Date: Mon, 25 May 2020 02:37:51 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO eed864e1af108faf58e4f486be419a1f45fca74_Vlo8Y30IFF0IHk4SCAJcHgUXDVg=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block 
X-Content-Type-Options: nosniff
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Content-Type: application/json
Content-Length: 816

[Response Body]
{
  "data" : [ {
    "status" : "Canceled",
    "autoManage" : true,
    "startTime" : "2020-05-25T10:41:56.389+09:00",
    "completionTime" : "2020-05-25T10:42:03.365+09:00",
    "elapsedTime" : 6,
    "discoveredResources" : 0,
    "failedProtocols" : 0,
    "noResponseIpAddresses" : 0,
    "skippedResources" : 1,
    "denominatorForProgress" : 100,
    "numeratorForProgress" : 12,
    "nextDiscoveryTime" : "2000-01-01T09:00:00.000+09:00",
    "lastTime" : "2020-05-25T11:37:51.529+09:00",
    "discoverdLogTargetIPRange" : [ {
      "name" : "192.168.11.1"
    }, {
      "name" : "test.com"
    }, {
      "name" : "test"
    } ]
  } ],
  "count" : 1
}