2.4.4 探索の停止に必要な情報の取得
探索を停止するために必要な情報を取得します。
権限
Admin
APIのバージョン
v1
リクエスト形式
GET http[s]://host:port/Analytics/version/services/Discoveries/actions/stop
リクエストボディー
リクエストボディーには何も設定しません。
レスポンスボディー
レスポンスボディーの構造とオブジェクトの属性を次に示します。{
"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 http://localhost:22015/Analytics/v1/services/Discoveries/actions/stop/ 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:48:17 GMT
Server: Cosminexus HTTP Server
Cache-Control: no-cache
WWW-Authenticate: HSSO 8145f2e5623a6863f92284d7419ab4fa89b138_Vlo8Y30IFF0IHk4SCAJcHgUXDVg=_V0810
X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
Content-Type: application/json
Content-Length: 192
[Response Body]
{
"name" : "stop",
"href" : "http://localhost:22015/Analytics/v1/services/Discoveries/actions/stop/invoke",
"method" : "POST",
"type" : "application/json",
"parameters" : [ ]
}