Blackout

アラートのブラックアウトを管理します。ブラックアウトは、定義された期間、特定のエージェントまたはサーバーのアラートを抑制します。

get_blackout

コードサンプル

#  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

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())

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からアーカイブされたレコードも結果ます。

パラメーター

Name	In	Type	Required	Description
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の場合、アーカイブされたブラックアウトレコードも含めます

列挙値

Parameter	Value
object_type	100
object_type	200
source	manual
source	scheduled
source	auto

応答例

{
  "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"
    }
  ]
}

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	ブラックアウトレコードのリスト	Inline

レスポンススキーマ

ステータスコード 200

Name	Type	Required	Restrictions	Description
» blackouts	[oneOf]	false	none	アクティブなブラックアウトレコード。 include_history=trueの場合、追加のactual_end_timeおよびarchivedフィールドを備えたBlackoutHistoryオブジェクトも含まれる場合があります。

oneOf

Name	Type	Required	Restrictions	Description
»» _anonymous_	アラートブラックアウト管理	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

Name	Type	Required	Restrictions	Description
»» _anonymous_	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

列挙値

Property	Value
source	manual
source	scheduled
source	auto
source	manual
source	scheduled
source	auto

注釈

この操作には認証が必要ありません

post_blackout

コードサンプル

#  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

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())

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を指定できます。

ボディパラメーター

{
  "start_time": "2019-08-24T14:15:22Z",
  "duration": 1,
  "object_type": 100,
  "object_ids": [0]
}

パラメーター

Name	In	Type	Required	Description
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の配列

列挙値

Parameter	Value
» 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

応答例

{
  "ids": [0],
  "batch_id": "4da22c97-b7d5-4e31-8c3a-03870ebc7b20"
}

応答

Status	Meaning	Description	Schema
201	8.スケジュールされた停電が作成されましたダイアログ	ブラックアウトが正常に作成されました	Inline
428	Precondition Required	検証エラー 無効な入力、制約違反	None

レスポンススキーマ

ステータスコード 201

Name	Type	Required	Restrictions	Description
» ids	[integer]	false	none	なし
» batch_id	string(uuid)	false	none	なし

注釈

この操作には認証が必要ありません

get_blackout{blackout_id}

コードサンプル

#  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

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())

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を返します。

パラメーター

Name	In	Type	Required	Description
X-Auth-Token	header	string	true	認証用トークン
blackout_id	path	integer	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	ブラックアウトレコード。 pem.blackoutからのライブ行Blackoutスキーマ、またはidがpem.blackout_historyでのみ見つかった場合、アーカイブされた行archived=trueのBlackoutHistoryスキーマ。	Inline
404	Not Found	ブラックアウトが見つかりません	None

レスポンススキーマ

列挙値

Property	Value
source	manual
source	scheduled
source	auto
source	manual
source	scheduled
source	auto

注釈

この操作には認証が必要ありません

delete_blackout{blackout_id}

コードサンプル

#  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

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())

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}

停電の終了

ブラックアウトレコードを終了アーカイブし、履歴に移動します。

パラメーター

Name	In	Type	Required	Description
X-Auth-Token	header	string	true	認証用トークン
blackout_id	path	integer	true	なし

応答例

{
  "id": 0,
  "deleted": true,
  "warnings": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	ブラックアウトが終了およびアーカイブされた	Inline
404	Not Found	ブラックアウトが見つかりません	None

レスポンススキーマ

ステータスコード 200

Name	Type	Required	Restrictions	Description
» id	integer	false	none	終了したブラックアウトのID
» deleted	boolean	false	none	成功した場合は常にtrue
» warnings	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	なし

注釈

この操作には認証が必要ありません

get_blackout_server{sid}

コードサンプル

#  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

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())

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フラグと、指定されたサーバーのソース別アクティブレコードの内訳を結果ます。

パラメーター

Name	In	Type	Required	Description
X-Auth-Token	header	string	true	認証用トークン
sid	path	integer	true	サーバーID

応答例

{
  "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"
    }
  ]
}

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	サーバーのブラックアウトステータス。	ObjectBlackoutStatus
404	Not Found	指定されたIDのサーバーは存在しません。	None
428	Precondition Required	サーバーIDがパスに指定されませんでした。	None

注釈

この操作には認証が必要ありません

put_blackout_server{sid}

コードサンプル

#  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

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())

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によって適用されます。

パラメーター

Name	In	Type	Required	Description
X-Auth-Token	header	string	true	認証用トークン
sid	path	integer	true	サーバーID

応答例

{
  "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"
    }
  ]
}

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	トグル結果。最初に有効にしたときにChanged=true。べき等のno-opのChanged=false。	ObjectBlackoutToggleResult
404	Not Found	指定されたIDのオブジェクトは存在しません。	None

注釈

この操作には認証が必要ありません

delete_blackout_server{sid}

コードサンプル

#  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

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())

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にアーカイブされます。将来にスケジュールされたレコードは単に削除されます。

パラメーター

Name	In	Type	Required	Description
X-Auth-Token	header	string	true	認証用トークン
sid	path	integer	true	サーバーID

応答例

{
  "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"
    }
  ]
}

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	トグル結果。少なくとも1つのレコードが終了した場合、Changed=true。べき等のno-opのChanged=false。	ObjectBlackoutToggleResult
404	Not Found	指定されたIDのオブジェクトは存在しません。	None

注釈

この操作には認証が必要ありません

get_blackout_agent{aid}

コードサンプル

#  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

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())

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フラグと、指定されたエージェントのソース別アクティブレコードの内訳を返します。

パラメーター

Name	In	Type	Required	Description
X-Auth-Token	header	string	true	認証用トークン
aid	path	integer	true	エージェントID

応答例

{
  "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"
    }
  ]
}

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	エージェントのブラックアウトステータス。	ObjectBlackoutStatus
404	Not Found	指定されたIDのエージェントは存在しません。	None
428	Precondition Required	パスにエージェントIDが指定されませんでした。	None

注釈

この操作には認証が必要ありません

put_blackout_agent{aid}

コードサンプル

#  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

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())

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によって適用されます。

パラメーター

Name	In	Type	Required	Description
X-Auth-Token	header	string	true	認証用トークン
aid	path	integer	true	エージェントID

応答例

{
  "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"
    }
  ]
}

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	トグル結果。最初に有効にしたときにChanged=true。べき等のno-opのChanged=false。	ObjectBlackoutToggleResult
404	Not Found	指定されたIDのオブジェクトは存在しません。	None

注釈

この操作には認証が必要ありません

delete_blackout_agent{aid}

コードサンプル

#  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

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())

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にアーカイブされます。将来にスケジュールされたレコードは単に削除されます。

パラメーター

Name	In	Type	Required	Description
X-Auth-Token	header	string	true	認証用トークン
aid	path	integer	true	エージェントID

応答例

{
  "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"
    }
  ]
}

応答

Status	Meaning	Description	Schema
200	コマンドラインからのサーバーインストーラーの呼び出し	トグル結果。少なくとも1つのレコードが終了した場合、Changed=true。べき等のno-opのChanged=false。	ObjectBlackoutToggleResult
404	Not Found	指定されたIDのオブジェクトは存在しません。	None

注釈

この操作には認証が必要ありません