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の表を参照してください。) 以下に示す値のみ指定可能です。
|
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" : [ ] }