Blackout ======== アラートのブラックアウトを管理します。ブラックアウトは、定義された期間、特定のエージェントまたはサーバーのアラートを抑制します。 get\_\ *blackout* ----------------- **コードサンプル** .. code:: shell # You can also use wget curl -X GET https://PEM-SERVER-IP/pem/api/v17/blackout/ \ -H Accept: application/json \ -H X-Auth-Token: string .. code:: python import requests headers = { Accept: application/json, X-Auth-Token: string } r = requests.get(https://PEM-SERVER-IP/pem/api/v17/blackout/, headers = headers) print(r.json()) .. code:: javascript const headers = { Accept: "application/json", "X-Auth-Token": "string", }; fetch("https://PEM-SERVER-IP/pem/api/v17/blackout/", { method: "GET", headers: headers, }) .then(function (res) { return res.json(); }) .then(function (body) { console.log(body); }); ``GET /blackout/`` *リスト停電* pem.blackoutからブラックアウトレコードを返しますアクティブ+将来のスケジュール済み。オプションでobject_type、object_id、またはsourceでフィルターします。 include_history=trueを渡して、pem.blackout_historyからアーカイブされたレコードも結果ます。 パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: 11,7,7,7,17 :align: left :class: longtable X-Auth-Token,header,string,true,認証用トークン object_type,query,integer,false,オブジェクトタイプでフィルターします100エージェントまたは200サーバー object_id,query,integer,false,特定のオブジェクトIDでフィルタリング source,query,string,false,ソースによるフィルタリング手動、スケジュール、または自動 include_history,query,boolean,false,trueの場合、アーカイブされたブラックアウトレコードも含めます 列挙値 '''''' .. csv-table:: :header: Parameter,Value :widths: 25,25 :align: left :class: longtable object_type,100 object_type,200 source,manual source,scheduled source,auto **応答例** .. raw:: html
.. code:: json { "blackouts": [ { "id": 0, "start_time": "2019-08-24T14:15:22Z", "end_time": "2019-08-24T14:15:22Z", "object_type": 0, "object_id": 0, "source": "manual", "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20", "created_by": "string", "created_at": "2019-08-24T14:15:22Z" } ] } .. raw:: html
応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,ブラックアウトレコードのリスト,Inline レスポンススキーマ ^^^^^^^^^^^^^^^^^^ ステータスコード **200** .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable » blackouts,[oneOf],false,none,アクティブなブラックアウトレコード。 include_history=trueの場合、追加のactual_end_timeおよびarchivedフィールドを備えたBlackoutHistoryオブジェクトも含まれる場合があります。 *oneOf* .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable »» _anonymous_,:ref:`アラートブラックアウト管理<アラートブラックアウト管理>` ,false,none,なし »»» id,integer,false,none,なし »»» start_time,string(date-time),false,none,なし »»» end_time,string(date-time)¦null,false,none,なし »»» object_type,integer,false,none,100=エージェント、200=サーバー »»» object_id,integer,false,none,なし »»» source,string,false,none,なし »»» batch_id,string(uuid)¦null,false,none,なし »»» created_by,string,false,none,なし »»» created_at,string(date-time),false,none,なし *xor* .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable »» _anonymous_,:ref:`BlackoutHistory` ,false,none,アーカイブされたブラックアウトレコード。 GET /blackout/?include_history=trueライブ行と混合、およびIDがpem.blackout_historyでのみ見つかった場合にGET /blackout/{id}によって返されます。 »»» id,integer,false,none,なし »»» start_time,string(date-time),false,none,なし »»» scheduled_end_time,string(date-time)¦null,false,none,ブラックアウトが作成されたときの元のend_time »»» actual_end_time,string(date-time),false,none,実際に停電が終了したとき »»» object_type,integer,false,none,100=エージェント、200=サーバー »»» object_id,integer,false,none,なし »»» source,string,false,none,なし »»» batch_id,string(uuid)¦null,false,none,なし »»» created_by,string,false,none,なし »»» created_at,string(date-time),false,none,なし »»» archived,boolean,false,none,履歴レコードの場合は常にtrue .. _列挙値-1: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable source,manual source,scheduled source,auto source,manual source,scheduled source,auto .. Note:: この操作には認証が必要ありません post\_\ *blackout* ------------------ **コードサンプル** .. code:: shell # You can also use wget curl -X POST https://PEM-SERVER-IP/pem/api/v17/blackout/ \ -H Content-Type: application/json \ -H Accept: application/json \ -H X-Auth-Token: string .. code:: python import requests headers = { Content-Type: application/json, Accept: application/json, X-Auth-Token: string } r = requests.post(https://PEM-SERVER-IP/pem/api/v17/blackout/, headers = headers) print(r.json()) .. code:: javascript const inputBody = { "start_time": "2019-08-24T14:15:22Z", "duration": 1, "object_type": 100, "object_ids": [ 0 ] }; const headers = { Content-Type:application/json, Accept:application/json, X-Auth-Token:string }; fetch(https://PEM-SERVER-IP/pem/api/v17/blackout/, { method: POST, body: inputBody, headers: headers }) .then(function(res) { return res.json(); }).then(function(body) { console.log(body); }); ``POST /blackout/`` *1つ以上のブラックアウトを作成する* 指定されたオブジェクトのブラックアウトレコードを作成します。バッチを作成するために複数のobject_idを指定できます。 **ボディパラメーター** .. code:: json { "start_time": "2019-08-24T14:15:22Z", "duration": 1, "object_type": 100, "object_ids": [0] } .. _パラメーター-1: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: 11,7,7,7,17 :align: left :class: longtable X-Auth-Token,header,string,true,認証用トークン body,body,object,true,なし » start_time,body,string(date-time),true,ブラックアウトが始まるとき ISO 8601 » duration,body,integer,true,停電の時間単位。 1〜24の整数であり、RESTで作成されたブラックアウトがUIで正しくレンダリングされるように、[ Schedule Alert Blackout ]ダイアログが提供する値と一致する必要があります。 » object_type,body,integer,true,100 =エージェント、200 =サーバー » object_ids,body,[integer],true,エージェントまたはサーバーIDの配列 .. _列挙値-2: 列挙値 '''''' .. csv-table:: :header: Parameter,Value :widths: 25,25 :align: left :class: longtable » duration,1 » duration,2 » duration,3 » duration,4 » duration,5 » duration,6 » duration,7 » duration,8 » duration,9 » duration,10 » duration,11 » duration,12 » duration,13 » duration,14 » duration,15 » duration,16 » duration,17 » duration,18 » duration,19 » duration,20 » duration,21 » duration,22 » duration,23 » duration,24 » object_type,100 » object_type,200 **応答例** .. raw:: html
.. code:: json { "ids": [0], "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20" } .. raw:: html
.. _応答-1: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`8.スケジュールされた停電が作成されましたダイアログ<8.スケジュールされた停電が作成されましたダイアログ>` ,ブラックアウトが正常に作成されました,Inline 428, `Precondition Required `__ ,検証エラー 無効な入力、制約違反,None .. _レスポンススキーマ-1: レスポンススキーマ ^^^^^^^^^^^^^^^^^^ ステータスコード **201** .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable » ids,[integer],false,none,なし » batch_id,string(uuid),false,none,なし .. Note:: この操作には認証が必要ありません get\_\ *blackout*\ {blackout_id} -------------------------------- **コードサンプル** .. code:: shell # You can also use wget curl -X GET https://PEM-SERVER-IP/pem/api/v17/blackout/{blackout_id} \ -H Accept: application/json \ -H X-Auth-Token: string .. code:: python import requests headers = { Accept: application/json, X-Auth-Token: string } r = requests.get(https://PEM-SERVER-IP/pem/api/v17/blackout/{blackout_id}, headers = headers) print(r.json()) .. code:: javascript const headers = { Accept: "application/json", "X-Auth-Token": "string", }; fetch("https://PEM-SERVER-IP/pem/api/v17/blackout/{blackout_id}", { method: "GET", headers: headers, }) .then(function (res) { return res.json(); }) .then(function (body) { console.log(body); }); ``GET /blackout/{blackout_id}`` *特定のブラックアウトを取得する* ブラックアウトレコードを返します。 IDがpem.blackoutに存在しない場合、ハンドラーはpem.blackout_historyにフォールバックし、アーカイブされたレコードを結果ます”archived”:trueおよびactual_end_time / stable_end_timeフィールドの存在によって区別されます。 IDがどのテーブルでも見つからない場合、404を返します。 .. _パラメーター-2: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: 11,7,7,7,17 :align: left :class: longtable X-Auth-Token,header,string,true,認証用トークン blackout_id,path,integer,true,なし **応答例** .. raw:: html
.. code:: json { "id": 0, "start_time": "2019-08-24T14:15:22Z", "end_time": "2019-08-24T14:15:22Z", "object_type": 0, "object_id": 0, "source": "manual", "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20", "created_by": "string", "created_at": "2019-08-24T14:15:22Z" } .. raw:: html
.. _応答-2: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,ブラックアウトレコード。 pem.blackoutからのライブ行Blackoutスキーマ、またはidがpem.blackout_historyでのみ見つかった場合、アーカイブされた行archived=trueのBlackoutHistoryスキーマ。,Inline 404, `Not Found `__ ,ブラックアウトが見つかりません,None .. _レスポンススキーマ-2: レスポンススキーマ ^^^^^^^^^^^^^^^^^^ .. _列挙値-3: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 25,25 :align: left :class: longtable source,manual source,scheduled source,auto source,manual source,scheduled source,auto .. Note:: この操作には認証が必要ありません delete\_\ *blackout*\ {blackout_id} ----------------------------------- **コードサンプル** .. code:: shell # You can also use wget curl -X DELETE https://PEM-SERVER-IP/pem/api/v17/blackout/{blackout_id} \ -H Accept: application/json \ -H X-Auth-Token: string .. code:: python import requests headers = { Accept: application/json, X-Auth-Token: string } r = requests.delete(https://PEM-SERVER-IP/pem/api/v17/blackout/{blackout_id}, headers = headers) print(r.json()) .. code:: javascript const headers = { Accept: "application/json", "X-Auth-Token": "string", }; fetch("https://PEM-SERVER-IP/pem/api/v17/blackout/{blackout_id}", { method: "DELETE", headers: headers, }) .then(function (res) { return res.json(); }) .then(function (body) { console.log(body); }); ``DELETE /blackout/{blackout_id}`` *停電の終了* ブラックアウトレコードを終了アーカイブし、履歴に移動します。 .. _パラメーター-3: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: 11,7,7,7,17 :align: left :class: longtable X-Auth-Token,header,string,true,認証用トークン blackout_id,path,integer,true,なし **応答例** .. raw:: html
.. code:: json { "id": 0, "deleted": true, "warnings": [ { "code": "string", "message": "string" } ] } .. raw:: html
.. _応答-3: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,ブラックアウトが終了およびアーカイブされた,Inline 404, `Not Found `__ ,ブラックアウトが見つかりません,None .. _レスポンススキーマ-3: レスポンススキーマ ^^^^^^^^^^^^^^^^^^ ステータスコード **200** .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: 12,8,8,8,12 :align: left :class: longtable » id,integer,false,none,終了したブラックアウトのID » deleted,boolean,false,none,成功した場合は常にtrue » warnings,\ :ref:`Platform Compatibility ` ],false,none,オプションの非致命的な警告 — アーカイブのINSERTが影響した行が、DELETEが返した行よりも少ない場合にのみ存在しますたとえば、 pem.blackout_historyのRLSまたはトリガードリフト。各警告には、診断用のBlackoutId、ArchivedCount、およびExpectedArchivedが含まれます。 »» code,string,true,none,安定した警告識別子。既知のコード `manual_post_state_unavailable` COMMIT後にトグルレスポンス形状のSELECTが失敗した 、 `in_blackout_post_state_unavailable` 同期フラグの場合 、 `flag_select_failed` ステータスヘルパーはレコード派生のin_blackoutにフォールバック 、 `history_archive_incomplete` DELETEは予想よりも少ない行をアーカイブしました-RLS /トリガーを調査しますpem.blackout_historyで)。 »» message,string,true,none,なし .. Note:: この操作には認証が必要ありません get\_\ *blackout_server*\ {sid} ------------------------------- **コードサンプル** .. code:: shell # You can also use wget curl -X GET https://PEM-SERVER-IP/pem/api/v17/blackout/server/{sid} \ -H Accept: application/json \ -H X-Auth-Token: string .. code:: python import requests headers = { Accept: application/json, X-Auth-Token: string } r = requests.get(https://PEM-SERVER-IP/pem/api/v17/blackout/server/{sid}, headers = headers) print(r.json()) .. code:: javascript const headers = { Accept: "application/json", "X-Auth-Token": "string", }; fetch("https://PEM-SERVER-IP/pem/api/v17/blackout/server/{sid}", { method: "GET", headers: headers, }) .then(function (res) { return res.json(); }) .then(function (body) { console.log(body); }); ``GET /blackout/server/{sid}`` *サーバーのブラックアウトステータスの取得* 同期されたalert_blackoutフラグと、指定されたサーバーのソース別アクティブレコードの内訳を結果ます。 .. _パラメーター-4: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: 11,7,7,7,17 :align: left :class: longtable X-Auth-Token,header,string,true,認証用トークン sid,path,integer,true,サーバーID **応答例** .. raw:: html
.. code:: json { "object_type": 100, "object_id": 0, "in_blackout": true, "manual": { "id": 0, "start_time": "2019-08-24T14:15:22Z", "end_time": "2019-08-24T14:15:22Z", "object_type": 0, "object_id": 0, "source": "manual", "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20", "created_by": "string", "created_at": "2019-08-24T14:15:22Z" }, "scheduled": [ { "id": 0, "start_time": "2019-08-24T14:15:22Z", "end_time": "2019-08-24T14:15:22Z", "object_type": 0, "object_id": 0, "source": "manual", "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20", "created_by": "string", "created_at": "2019-08-24T14:15:22Z" } ], "auto": { "id": 0, "start_time": "2019-08-24T14:15:22Z", "end_time": "2019-08-24T14:15:22Z", "object_type": 0, "object_id": 0, "source": "manual", "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20", "created_by": "string", "created_at": "2019-08-24T14:15:22Z" }, "warnings": [ { "code": "string", "message": "string" } ] } .. raw:: html
.. _応答-4: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,サーバーのブラックアウトステータス。,:ref:`ObjectBlackoutStatus` 404, `Not Found `__ ,指定されたIDのサーバーは存在しません。,None 428, `Precondition Required `__ ,サーバーIDがパスに指定されませんでした。,None .. Note:: この操作には認証が必要ありません put\_\ *blackout_server*\ {sid} ------------------------------- **コードサンプル** .. code:: shell # You can also use wget curl -X PUT https://PEM-SERVER-IP/pem/api/v17/blackout/server/{sid} \ -H Accept: application/json \ -H X-Auth-Token: string .. code:: python import requests headers = { Accept: application/json, X-Auth-Token: string } r = requests.put(https://PEM-SERVER-IP/pem/api/v17/blackout/server/{sid}, headers = headers) print(r.json()) .. code:: javascript const headers = { Accept: "application/json", "X-Auth-Token": "string", }; fetch("https://PEM-SERVER-IP/pem/api/v17/blackout/server/{sid}", { method: "PUT", headers: headers, }) .then(function (res) { return res.json(); }) .then(function (body) { console.log(body); }); ``PUT /blackout/server/{sid}`` *サーバーの手動ブラックアウトを有効にする* 冪等。このサーバーに存在しない場合は、手動の不定レコードを挿入します。それ以外の場合は、Changed=falseを使用して既存のレコードを結果ます。オブジェクトごとに1つのアクティブな手動レコードのみが許可されますpem.idx_blackout_one_active_in individuallyによって適用されます。 .. _パラメーター-5: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: 11,7,7,7,17 :align: left :class: longtable X-Auth-Token,header,string,true,認証用トークン sid,path,integer,true,サーバーID **応答例** .. raw:: html
.. code:: json { "changed": true, "in_blackout": true, "manual": { "id": 0, "start_time": "2019-08-24T14:15:22Z", "end_time": "2019-08-24T14:15:22Z", "object_type": 0, "object_id": 0, "source": "manual", "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20", "created_by": "string", "created_at": "2019-08-24T14:15:22Z" }, "ended_records": [ { "id": 0, "source": "manual", "scheduled_end": "2019-08-24T14:15:22Z", "ended_early": true } ], "warnings": [ { "code": "string", "message": "string" } ] } .. raw:: html
.. _応答-5: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,トグル結果。最初に有効にしたときにChanged=true。べき等のno-opのChanged=false。,:ref:`ObjectBlackoutToggleResult` 404, `Not Found `__ ,指定されたIDのオブジェクトは存在しません。,None .. Note:: この操作には認証が必要ありません delete\_\ *blackout_server*\ {sid} ---------------------------------- **コードサンプル** .. code:: shell # You can also use wget curl -X DELETE https://PEM-SERVER-IP/pem/api/v17/blackout/server/{sid} \ -H Accept: application/json \ -H X-Auth-Token: string .. code:: python import requests headers = { Accept: application/json, X-Auth-Token: string } r = requests.delete(https://PEM-SERVER-IP/pem/api/v17/blackout/server/{sid}, headers = headers) print(r.json()) .. code:: javascript const headers = { Accept: "application/json", "X-Auth-Token": "string", }; fetch("https://PEM-SERVER-IP/pem/api/v17/blackout/server/{sid}", { method: "DELETE", headers: headers, }) .then(function (res) { return res.json(); }) .then(function (body) { console.log(body); }); ``DELETE /blackout/server/{sid}`` *サーバー上のすべての停電を終了する* 冪等。ソース手動+スケジュール+自動に関係なく、このサーバー上のすべてのアクティブなブラックアウトレコードを終了します。ダッシュボードのチェックボックスの既にアクティブな動作のチェックを解除すると一致します。ユーザーのインテントは「アラートをオンにします」です。開始されたレコードはpem.blackout_historyにアーカイブされます。将来にスケジュールされたレコードは単に削除されます。 .. _パラメーター-6: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: 11,7,7,7,17 :align: left :class: longtable X-Auth-Token,header,string,true,認証用トークン sid,path,integer,true,サーバーID **応答例** .. raw:: html
.. code:: json { "changed": true, "in_blackout": true, "manual": { "id": 0, "start_time": "2019-08-24T14:15:22Z", "end_time": "2019-08-24T14:15:22Z", "object_type": 0, "object_id": 0, "source": "manual", "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20", "created_by": "string", "created_at": "2019-08-24T14:15:22Z" }, "ended_records": [ { "id": 0, "source": "manual", "scheduled_end": "2019-08-24T14:15:22Z", "ended_early": true } ], "warnings": [ { "code": "string", "message": "string" } ] } .. raw:: html
.. _応答-6: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,トグル結果。少なくとも1つのレコードが終了した場合、Changed=true。べき等のno-opのChanged=false。,:ref:`ObjectBlackoutToggleResult` 404, `Not Found `__ ,指定されたIDのオブジェクトは存在しません。,None .. Note:: この操作には認証が必要ありません get\_\ *blackout_agent*\ {aid} ------------------------------ **コードサンプル** .. code:: shell # You can also use wget curl -X GET https://PEM-SERVER-IP/pem/api/v17/blackout/agent/{aid} \ -H Accept: application/json \ -H X-Auth-Token: string .. code:: python import requests headers = { Accept: application/json, X-Auth-Token: string } r = requests.get(https://PEM-SERVER-IP/pem/api/v17/blackout/agent/{aid}, headers = headers) print(r.json()) .. code:: javascript const headers = { Accept: "application/json", "X-Auth-Token": "string", }; fetch("https://PEM-SERVER-IP/pem/api/v17/blackout/agent/{aid}", { method: "GET", headers: headers, }) .then(function (res) { return res.json(); }) .then(function (body) { console.log(body); }); ``GET /blackout/agent/{aid}`` *エージェントのブラックアウトステータスの取得* 同期されたalert_blackoutフラグと、指定されたエージェントのソース別アクティブレコードの内訳を返します。 .. _パラメーター-7: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: 11,7,7,7,17 :align: left :class: longtable X-Auth-Token,header,string,true,認証用トークン aid,path,integer,true,エージェントID **応答例** .. raw:: html
.. code:: json { "object_type": 100, "object_id": 0, "in_blackout": true, "manual": { "id": 0, "start_time": "2019-08-24T14:15:22Z", "end_time": "2019-08-24T14:15:22Z", "object_type": 0, "object_id": 0, "source": "manual", "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20", "created_by": "string", "created_at": "2019-08-24T14:15:22Z" }, "scheduled": [ { "id": 0, "start_time": "2019-08-24T14:15:22Z", "end_time": "2019-08-24T14:15:22Z", "object_type": 0, "object_id": 0, "source": "manual", "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20", "created_by": "string", "created_at": "2019-08-24T14:15:22Z" } ], "auto": { "id": 0, "start_time": "2019-08-24T14:15:22Z", "end_time": "2019-08-24T14:15:22Z", "object_type": 0, "object_id": 0, "source": "manual", "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20", "created_by": "string", "created_at": "2019-08-24T14:15:22Z" }, "warnings": [ { "code": "string", "message": "string" } ] } .. raw:: html
.. _応答-7: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,エージェントのブラックアウトステータス。,:ref:`ObjectBlackoutStatus` 404, `Not Found `__ ,指定されたIDのエージェントは存在しません。,None 428, `Precondition Required `__ ,パスにエージェントIDが指定されませんでした。,None .. Note:: この操作には認証が必要ありません put\_\ *blackout_agent*\ {aid} ------------------------------ **コードサンプル** .. code:: shell # You can also use wget curl -X PUT https://PEM-SERVER-IP/pem/api/v17/blackout/agent/{aid} \ -H Accept: application/json \ -H X-Auth-Token: string .. code:: python import requests headers = { Accept: application/json, X-Auth-Token: string } r = requests.put(https://PEM-SERVER-IP/pem/api/v17/blackout/agent/{aid}, headers = headers) print(r.json()) .. code:: javascript const headers = { Accept: "application/json", "X-Auth-Token": "string", }; fetch("https://PEM-SERVER-IP/pem/api/v17/blackout/agent/{aid}", { method: "PUT", headers: headers, }) .then(function (res) { return res.json(); }) .then(function (body) { console.log(body); }); ``PUT /blackout/agent/{aid}`` *エージェントの手動ブラックアウトを有効にする* 冪等。このエージェントに存在しない場合、手動の不定レコードを挿入します。それ以外の場合は、Changed=falseを使用して既存のレコードを結果ます。オブジェクトごとに1つのアクティブな手動レコードのみが許可されますpem.idx_blackout_one_active_in individuallyによって適用されます。 .. _パラメーター-8: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: 11,7,7,7,17 :align: left :class: longtable X-Auth-Token,header,string,true,認証用トークン aid,path,integer,true,エージェントID **応答例** .. raw:: html
.. code:: json { "changed": true, "in_blackout": true, "manual": { "id": 0, "start_time": "2019-08-24T14:15:22Z", "end_time": "2019-08-24T14:15:22Z", "object_type": 0, "object_id": 0, "source": "manual", "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20", "created_by": "string", "created_at": "2019-08-24T14:15:22Z" }, "ended_records": [ { "id": 0, "source": "manual", "scheduled_end": "2019-08-24T14:15:22Z", "ended_early": true } ], "warnings": [ { "code": "string", "message": "string" } ] } .. raw:: html
.. _応答-8: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,トグル結果。最初に有効にしたときにChanged=true。べき等のno-opのChanged=false。,:ref:`ObjectBlackoutToggleResult` 404, `Not Found `__ ,指定されたIDのオブジェクトは存在しません。,None .. Note:: この操作には認証が必要ありません delete\_\ *blackout_agent*\ {aid} --------------------------------- **コードサンプル** .. code:: shell # You can also use wget curl -X DELETE https://PEM-SERVER-IP/pem/api/v17/blackout/agent/{aid} \ -H Accept: application/json \ -H X-Auth-Token: string .. code:: python import requests headers = { Accept: application/json, X-Auth-Token: string } r = requests.delete(https://PEM-SERVER-IP/pem/api/v17/blackout/agent/{aid}, headers = headers) print(r.json()) .. code:: javascript const headers = { Accept: "application/json", "X-Auth-Token": "string", }; fetch("https://PEM-SERVER-IP/pem/api/v17/blackout/agent/{aid}", { method: "DELETE", headers: headers, }) .then(function (res) { return res.json(); }) .then(function (body) { console.log(body); }); ``DELETE /blackout/agent/{aid}`` *エージェントのすべてのブラックアウトを終了する* 冪等。ソース手動+スケジュール+自動に関係なく、このエージェントのすべてのアクティブなブラックアウトレコードを終了します。ダッシュボードのチェックボックスの既にアクティブな動作のチェックを解除すると一致します。ユーザーのインテントは「アラートをオンにします」です。開始されたレコードはpem.blackout_historyにアーカイブされます。将来にスケジュールされたレコードは単に削除されます。 .. _パラメーター-9: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: 11,7,7,7,17 :align: left :class: longtable X-Auth-Token,header,string,true,認証用トークン aid,path,integer,true,エージェントID **応答例** .. raw:: html
.. code:: json { "changed": true, "in_blackout": true, "manual": { "id": 0, "start_time": "2019-08-24T14:15:22Z", "end_time": "2019-08-24T14:15:22Z", "object_type": 0, "object_id": 0, "source": "manual", "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20", "created_by": "string", "created_at": "2019-08-24T14:15:22Z" }, "ended_records": [ { "id": 0, "source": "manual", "scheduled_end": "2019-08-24T14:15:22Z", "ended_early": true } ], "warnings": [ { "code": "string", "message": "string" } ] } .. raw:: html
.. _応答-9: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`コマンドラインからのサーバーインストーラーの呼び出し<コマンドラインからのサーバーインストーラーの呼び出し>` ,トグル結果。少なくとも1つのレコードが終了した場合、Changed=true。べき等のno-opのChanged=false。,:ref:`ObjectBlackoutToggleResult` 404, `Not Found `__ ,指定されたIDのオブジェクトは存在しません。,None .. Note:: この操作には認証が必要ありません