2.4.3　探索の実行

探索を実行します。

権限

Admin

APIのバージョン

リクエスト形式

POST http[s]://host:port/Analytics/version/services/Discoveries/actions/submit/invoke

リクエストボディー

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

{
        "name":"...",
        "href":"...",
        "method":"...",
        "type":"...",
        "parameters":[{
            "autoManage":"...",
            "ipAddrRangeID":["...", ...]
        },
        :
        ]
}

Action (Type: Action)

属性	データ型	説明
name	string	操作名です。
href	string	操作の実行先URLです。
method	string	メソッド名です。
type	string	データのデータ形式です。
parameters	DiscoveryParam[]	操作実行時に必要なDiscoveryParamのコレクション。DiscoveryParamの詳細は以下の表を参照ください。

parameters (Type: DiscoveryParam)

属性	データ型	説明
autoManage	boolean	探索により発見したリソースを自動的に管理対象にする場合true
ipAddrRangeID	long[]	探索する探索範囲のインスタンスIDのリスト

レスポンスボディー

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

{
        "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	リソースが存在しない
409	Conflict	実行中
412	Precondition Failed	サーバーが起動していない
500	Internal Server Error	サーバーサイドエラー

使用例

[Request Header]
POST http://localhost:22015/Analytics/v1/services/Discoveries/actions/submit/invoke HTTP/1.1
Host: localhost:22015
Accept: application/json
Accept-Language: ja
Content-Type: application/json
Authorization: Basic c3lzdGVtOm1hbmFnZXI=
Content-Length: 154



[Request Body]
{
  "name":"submit",
  "href":"v1/services/Discoveries/actions/submit/invoke",
  "method":"POST",
  "parameters":[
    {
      "ipAddrRangeID":[3,2,1,4,5,50],
      "autoManage":true
    }
  ]
}

[Response Header]
HTTP/1.1 200 OK
Date: Mon, 25 May 2020 02:53:26 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 765ce3a1aa398ad2f383653ce37491ea3744085_Vlo8Y30IFF0IHk4SCAJcHgUXDVg=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block 
X-Content-Type-Options: nosniff
Content-Type: application/json
Content-Length: 279


[Response Body]
{
  "instanceID" : "ef724ea9-41ad-49d3-afe0-e174f534b846",
  "created" : "2020-05-25T11:53:26.350+09:00",
  "updated" : "2020-05-25T11:53:26.350+09:00",
  "completed" : "2020-05-25T11:53:26.350+09:00",
  "state" : "success",
  "affectedResource" : [ ],
  "result" : [ ]
}

2.4.3 探索の実行

2.4.3　探索の実行