2.25.4 サービスインスタンスの監視状態の変更
サービスインスタンスの監視状態を変更します。
権限
Admin, Modify
APIのバージョン
v1
リクエスト形式
POST http[s]://host:port/Analytics/version/services/ServiceInstances/actions/changeManagedType/invoke
リクエストボディー
リクエストボディーの構造とオブジェクトの属性を次に示します。{ "name":"...", "href":"...", "method":"...", "type":"...", "parameters":[{ "newMonitoringOperationType":"...", "ids":["...", ...] }, : ] }
Action (Type: Action)
属性 |
データ型 |
説明 |
---|---|---|
name |
string |
操作名です。 |
href |
string |
操作の実行先URLです。 |
method |
string |
メソッド名です。 |
type |
string |
データのデータ形式です。 |
parameters |
ChangeManagedTypeParamForComp[] |
操作実行時に必要なChangeManagedTypeParamForCompのコレクション。ChangeManagedTypeParamForCompの詳細は以下の表を参照ください。 |
parameters (Type: ChangeManagedTypeParamForComp)
属性 |
データ型 |
説明 |
---|---|---|
newMonitoringOperationType |
enum |
変更したい監視状態を指定します。 (指定可能な値は「列挙型一覧」のMonitoringOperationTypeの表を参照してください。) 以下に示す値のみ指定可能です。
|
ids |
long[] |
コンポーネントを特定するIDを指定します。複数同時に指定する場合は,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 |
リソースが存在しない |
412 |
Precondition Failed |
サーバーが起動していない |
500 |
Internal Server Error |
サーバーサイドエラー |
使用例
[Request Header] POST /Analytics/v1/services/ServiceInstances/actions/changeManagedType/invoke HTTP/1.1 Authorization: HSSO f36f244d152c256938defdfd90206399c0a8956_Vlo8Y30KeAYCfyNKC3cJZCEEbAQ=_V0810 User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.75 Safari/537.36 Host: localhost:8080 Accept: application/json Accept-Language: ja [Request Body] { "name": "changeManagedType", "href": "http://10.210.177.133:22015/Analytics/v1/services/ServiceInstances/actions/changeManagedType/invoke", "method": "POST", "type": "application/json", "parameters": [ { "newMonitoringOperationType": "Monitor", "ids": [ 1000001 ] } ] } [Response Header] HTTP/1.1 200 OK Date: Wed, 21 Oct 2020 00:35:33 GMT Server: Cosminexus HTTP Server Access-Control-Expose-Headers: WWW-Authenticate, Content-Type, Warning, Content-Language Cache-Control: no-cache Access-Control-Allow-Origin: http://localhost:8080 WWW-Authenticate: HSSO f36f244d152c256938defdfd90206399c0a8956_Vlo8Y30KeAYCfyNKC3cJZCEEbAQ=_V0810 X-Frame-Options: SAMEORIGIN X-XSS-Protection: 1; mode=block X-Content-Type-Options: nosniff Keep-Alive: timeout=5, max=97 Connection: Keep-Alive Transfer-Encoding: chunked Content-Type: application/json [Response Body] { "instanceID" : "58d4757a-2e9e-44cd-9aaf-2cbc54a5de9c", "created" : "2020-10-21T09:35:33.956+09:00", "updated" : "2020-10-21T09:35:34.128+09:00", "completed" : "2020-10-21T09:35:34.128+09:00", "state" : "success", "affectedResource" : [ ], "result" : [ ] }