• 製品
  • 使用を開始する
  • 関連ドキュメント
  • リソース

Marid のスクリプト プロキシ

Marid は廃止予定で、2022 年 11 月 21 日に完全に廃止されます。詳細はコミュニティの投稿をご覧ください。

アトラシアンの拡張性プラットフォームをこれまでご利用になられたことがない場合は「拡張性プラットフォームとしての Opsgenie Edge Connector」をご参照のうえ、Opsgenie アカウントで実行する方法をご確認ください。

Marid をご利用で Opsgenie Edge Connector に移行する場合は「Opsgenie Edge Connector に移行する必要がある理由」をご参照ください。

Marid は Opsgenie が提供するオープンソースツールで、Groovy および Ruby スクリプトをサポートしています。通常、Opsgenie Java API メソッドは、Marid スクリプト内で直接使用できます。Opsgenie は、Opsgenie Web API に対して簡単にアクションを実行するための特別なプロキシも提供します。

  • opsgenie という名前の特別な変数を、Marid スクリプトで使用できます。

  • opsgenie に対する呼び出しは Java API 呼び出しに変換され、Java API 呼び出しは Web API と通信します。

  • Opsgenieは、Java APIメソッドよりはるかに簡単に使用できます。コードは少なくて済みますが、作業量が多くなります。

  • ScriptProxy で利用可能なほぼすべての Web API 機能

  • opsgenie は Groovy および Ruby スクリプトの両方で使用できます。

  • opsgenie 変数は com.ifountain.opsgenie.client.script.util.ScriptProxy のインスタンスです。

  • ScriptProxy のソース コードは、OpsGenieClient Github ページにあります。

  • メモリ共有データに格納するには、com.ifountain.opsgenie.client.marid.MemoryStore クラスの静的メソッドを使用します。詳細については、メモリ ストアのセクションをご参照ください。

スクリプトプロキシを使用する場合、user パラメーターはオプションです。指定しない場合は、conf ファイル内のユーザーが使用されます。

その他の API リクエスト

アラート作成リクエスト

アラートの作成リクエストは、Opsgenieでアラートを作成するために使用されます。ここでは、次のパラメーターを使用します。

必須パラメーター

パラメーター

制限事項

message

アラートテキストは130文字に制限されています。

オプション パラメーター

パラメーター

説明

teams

アラートに対応するチームのリスト。チームエスカレーションポリシーが実行され、どのユーザーが通知を受信するかが計算されます。

エイリアス

アラートのユーザー定義の識別子。同じエイリアスで持つことができるオープンステータスのアラートは 1 つのみです。既知の ID を割り当てて、後でこの ID を使用して、同じアラートのログの記録、クローズ、添付などの追加アクションを実行できるようにします。

description

アラートに関する詳細情報を、最大15000文字で提供します。

操作

実行可能なアクションのカンマ区切りのリスト。カスタムアクションを定義して、ユーザーが各アラートに対してアクションを実行できるようにすることができます。顧客の設定ページでアクションコールバック URL が指定されている場合は、アクションの実行時にそのコールバック URL が呼び出されます。

ソース

アラートのソースを指定するフィールド。既定では、受信リクエストのIPアドレスに割り当てられます。

tags

アラートに添付されるラベルのカンマ区切りのリスト。OverwriteQuietHours タグを追加することで、緊急アラートの待機時間設定を上書きできます。

詳細

ユーザー定義プロパティのセット。これは、次のようなネストされたマップとして指定されます。"details" : { "prop1":"prop1Value" "prop2":"prop2Value" }

エンティティ

アラートが関連付けられているエンティティ。

ユーザー

実行のデフォルト所有者。userが指定されない場合、アカウントの所有者が使用されます。

注意

追加のアラートメモ。

リクエストの例

groovy

1 opsgenie.createAlert(["message":"Sample Alert","note":"Alert note"])

詳細リクエストのサンプル

groovy

1 2 3 4 5 6 7 8 opsgenie.createAlert([ "message":"Sample Alert", "teams":[["id":"4513b7ea-3b91-438f-b7e4-e3e54af9147c"],["name":"rocket_team"]], "description":"for demo usage", "alias":"demo", "tags":["demo","sample"], "actions":["ping"] ])

リクエストステータスの取得リクエスト

リクエストステータスの取得リクエストは、Opsgenieに対して行われたリクエストのステータスをクエリするために使用されます。一部のリクエスト (アラートの作成など) は非同期で行われるため、これを使用してリクエストを行った後にそのリクエストのステータスをクエリできます。ここでは、次のパラメーターを使用します。

必須パラメーター

パラメーター

説明

リクエスト ID

クエリするリクエストの応答で指定されているリクエストのID。

リクエストの例

groovy

1 opsgenie.getRequestStatus(["id":"8418d193-2dab-4490-b331-8c02cdd196b7"])

応答 (Groovyマップ):

groovy

1 2 3 4 5 6 7 8 9 10 11 12 13 14 [ "data": [ "success": true, "action": "Create", "processedAt": "2017-05-24T14:24:20.844Z", "integrationId": "c9cec2cb-e782-4ebb-bc1d-1b2fa703cf03", "isSuccess": true, "status": "Created alert", "alertId": "8743a1b2-11da-480e-8493-744660987bef", "alias": "8743a1b2-11da-480e-8493-744660987bef" ], "took": 0.022, "requestId": "ec7e1d8e-1c75-442e-a271-731070a7fa4d" ]

アラートのクローズリクエスト

アラートのクローズリクエストは、Opsgenieでオープンしているアラートをクローズするために使用されます。ここでは、次のパラメーターを使用します。

必須パラメーター

パラメーター

説明

ID

クローズされるアラートの ID。

エイリアス

クローズされるアラートのエイリアス。

tinyId

アラートに割り当てられている短い ID。

id、alias、または tinyId パラメーターのいずれかを、アラートのクローズリクエストで指定する必要があります。エイリアス オプションは、オープン アラートに対してのみ使用できます。

オプション パラメーター

パラメーター

説明

ユーザー

実行のデフォルト所有者。userが指定されない場合、アカウントの所有者が使用されます。

注意

追加のアラートメモ。

ソース

クローズ アクションのソースを指定するユーザー定義フィールド。

リクエストの例

groovy

1 opsgenie.closeAlert(["id":"123"])

詳細リクエスト

groovy

1 opsgenie.closeAlert(["alias":"demo","user":"user1@yourdomain.com","note":"closing demo alert"])

アラートの削除リクエスト

アラートの削除リクエストは、Opsgenieでアラートを削除するために使用されます。ここでは、次のパラメーターを使用します。

必須パラメーター

パラメーター

説明

ID

削除されるアラートの ID。

エイリアス

削除されるアラートのエイリアス。

tinyId

アラートに割り当てられている短い ID。

id、alias、または tinyId パラメーターのいずれかを、アラートの削除リクエストで指定する必要があります。エイリアス オプションは、オープン アラートに対してのみ使用できます。

オプション パラメーター

パラメーター

説明

ユーザー

実行のデフォルト所有者。userが指定されない場合、アカウントの所有者が使用されます。

ソース

削除アクションのソースを指定するユーザー定義フィールド。

リクエストの例

groovy

1 opsgenie.deleteAlert(["id":"123"])

アラート取得リクエスト

アラートの取得リクエストは、Opsgenieでアラートを検索および取得するために使用されます。ここでは、次のパラメーターを使用します。

必須パラメーター

パラメーター

説明

ID

取得するアラートのID。

エイリアス

取得するアラートのエイリアス。

tinyId

アラートに割り当てられている短い ID。

id、alias、または tinyId パラメーターのいずれかを、アラートの取得リクエストで指定する必要があります。エイリアス オプションは、オープン アラートに対してのみ使用できます。

単一のアラートを取得するリクエストのサンプル

groovy

1 opsgenie.getAlert(["id":"123"])

groovy

1 opsgenie.getAlert(["alias":"demo"])

応答 (Groovyマップ):

groovy

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 [ "id": "70413a06-38d6-4c85-92b8-5ebc900d42e2", "tinyId": "1791", "alias": "event_573", "message": "Our servers are in danger", "status": "closed", "acknowledged": false, "isSeen": true, "tags": [ "OverwriteQuietHours", "Critical" ], "snoozed": true, "snoozedUntil": "2017-04-03T20:32:35.143Z", "count": 79, "lastOccurredAt": "2017-04-03T20:05:50.894Z", "createdAt": "2017-03-21T20:32:52.353Z", "updatedAt": "2017-04-03T20:32:57.301Z", "source": "Isengard", "owner": "morpheus@opsgenie.com", "priority": "P5", "teams": [ [ "id": "8418d193-2dab-4490-b331-8c02cdd196b7" ], [ "id": "43a29c5c-3dbf-4fa4-9c26-f4f71023e120" ] ], "integration": [ "id": "4513b7ea-3b91-438f-b7e4-e3e54af9147c", "name": "Nebuchadnezzar", "type": "API" ], "report": [ "ackTime": 15702, "closeTime": 60503, "acknowledgedBy": "agent_smith@opsgenie.com", "closedBy": "neo@opsgenie.com" ], "actions": ["Restart", "Ping"], "entity": "EC2", "description": "Example description", "details": [ "serverName": "Zion", "region": "Oregon" ] ]

アラートのリストリクエスト

アラートのリストリクエストは、Opsgenieでアラートをリストするために使用されます。ここでは、次のパラメーターを使用します。

必須パラメーター

パラメーター

必須パラメーターはありません。

オプション パラメーター

パラメーター

説明

クエリ

アラートをフィルターする際に適用する検索クエリ。検索クエリの詳細については、アラート検索クエリのヘルプを参照してください。

searchIdentifier

アラートをフィルターする際に適用する、保存済み検索クエリの識別子。

searchIdentifierType

保存済み検索クエリの識別子タイプ。指定できる値は、id および name です。既定値は id です。searchIdentifier が指定されない場合、この値は無視されます。

offset

(ページネーションを適用するための) 結果セットの開始インデックス。最小値 (かつデフォルト値) は 0 です。

limit

結果で表示する項目の最大数。正の整数値である必要があります。デフォルト値は 20 で、最大値は 100 です。

並べ替え

結果セットのソート基準となるフィールドの名前。既定値は createdAt です。指定できる値を以下に示します:
createdAt
updatedAt
tinyId
alias
message
status
acknowledged
isSeen
snoozed
snoozedUntil
count
lastOccurredAt
source
owner
integration.name
integration.type
report.ackTime
report.closeTime
report.acknowledgedBy
report.closedBy

注文

結果セットのソート順です。指定できる値は、desc および asc です。既定値は desc です。
desc: 結果セットを降順でソートします。
asc: 結果セットを昇順でソートします。

**アラートのリストを取得するリクエストのサンプル

直近の20個のアラートを取得します (limitの既定値は20、limitの最大値は100)**

groovy

1 2 3 opsgenie.listAlerts([:]).each{ alert -> logger.warn("Found alert ${alert.message}"); }

最後にクローズした10個のアラートを取得する

groovy

1 opsgenie.listAlerts(["limit":10,"query":"status:open"])

応答 (Groovyマップのリスト):

groovy

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 [ [ "id": "70413a06-38d6-4c85-92b8-5ebc900d42e2", "tinyId": "1791", "alias": "event_573", "message": "Our servers are in danger", "status": "closed", "acknowledged": false, "isSeen": true, "tags": [ "OverwriteQuietHours", "Critical" ], "snoozed": true, "snoozedUntil": "2017-04-03T20:32:35.143Z", "count": 79, "lastOccurredAt": "2017-04-03T20:05:50.894Z", "createdAt": "2017-03-21T20:32:52.353Z", "updatedAt": "2017-04-03T20:32:57.301Z", "source": "Isengard", "owner": "morpheus@opsgenie.com", "priority": "P4", "teams": [ [ "id": "8418d193-2dab-4490-b331-8c02cdd196b7" ], [ "id": "43a29c5c-3dbf-4fa4-9c26-f4f71023e120" ] ], "integration": [ "id": "4513b7ea-3b91-438f-b7e4-e3e54af9147c", "name": "Nebuchadnezzar", "type": "API" ], "report": [ "ackTime": 15702, "closeTime": 60503, "acknowledgedBy": "agent_smith@opsgenie.com", "closedBy": "neo@opsgenie.com" ] ], [ "id": "70413a06-38d6-4c85-92b8-5ebc900d42e2", "tinyId": "1791", "alias": "event_573", "message": "Life is too short for shitty software", "status": "open", "acknowledged": false, "isSeen": false, "tags": [ "RandomTag" ], "snoozed": false, "count": 1, "lastOccurredAt": "2017-03-21T20:32:52.353Z", "createdAt": "2017-03-21T20:32:52.353Z", "updatedAt": "2017-04-03T20:32:57.301Z", "source": "Zion", "owner": "", "priority": "P5", "teams": [], "integration": [ "id": "4513b7ea-3b91-b7e4-438f-e3e54af9147c", "name": "My_Lovely_Amazon", "type": "CloudWatch" ] ] ]

アラートログのリストリクエスト

アラートログのリストリクエストは、Opsgenie でアラートログを取得するために使用されます。ここでは、次のパラメーターを使用します。

必須パラメーター

パラメーター

説明

ID

取得するアラートのID。

エイリアス

取得するアラートのエイリアス。

tinyId

アラートの tinyId。

id、alias、または tinyId パラメーターのいずれかを、アラートログのリストリクエストで指定する必要があります。エイリアス オプションは、オープン アラートに対してのみ使用できます。

オプション パラメーター

パラメーター

説明

offset

offset プロパティの開始値です。

direction

指定されたオフセットに適用されるページ方向。指定できる値は、next、および prev です。既定値は next です。
next: 提供されたログのオフセット値は、指定されたオフセットより大きい必要があります。
prev: 提供されたログのオフセット値は、指定されたオフセットより小さい必要があります。

limit

結果で表示する項目の最大数。正の整数値である必要があります。デフォルト値は 20 で、最大値は 100 です。

注文

結果セットのソート順です。指定できる値は、desc、および asc です。既定値は desc です。
desc: 結果セットを降順でソートします。
asc: 結果セットを昇順でソートします。

* 単一のアラートを取得するリクエストのサンプル

groovy

1 opsgenie.listAlertLogs(["id":"123"])

応答:

groovy

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 [ "logs": [ [ "log": "Alert acknowledged via web", "type": "system", "owner": "neo@opsgenie.com", "createdAt": "2017-04-12T12:27:52.838Z", "offset": "1492000072838_1492000072838234593" ], [ "log": "Viewed on [web]", "type": "alertRecipient", "owner": "trinity@opsgenie.com", "createdAt": "2017-04-12T12:27:46.379Z", "offset": "1492000066378_1492000066379000127" ] ], "requestId": "174abe1b-e2a8-48d6-a747-05f012760988", "took": 0.456, "paging": [ "next": "https://api.opsgenie.com/v2/alerts/ee624ed0-3ee0-45be-9c9d-e7667eaf21e5/logs?identifierType=id&offset=1492000072838_1492000072838234593&direction=next&limit=2&order=desc", "first": "https://api.opsgenie.com/v2/alerts/ee624ed0-3ee0-45be-9c9d-e7667eaf21e5/logs?identifierType=id&limit=2&order=desc" ] ]

アラート受信者のリスト化リクエスト

アラート受信者のリスト化リクエストは、Opsgenie でアラート受信者を取得するために使用されます。これでは、次のパラメーターを使用します。

必須パラメーター

パラメーター

説明

ID

取得するアラートのID。

エイリアス

取得するアラートのエイリアス。

tinyId

アラートの tinyId。

id、alias、または tinyId パラメーターのいずれかを、アラートの取得リクエストで指定する必要があります。エイリアス オプションは、オープン アラートに対してのみ使用できます。

単一のアラートを取得するリクエストのサンプル

groovy

1 opsgenie.listAlertRecipients(["id":"123"])

応答:

groovy

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 [ "users": [ [ "user": [ "id": "2503a523-8ba5-4158-a4bd-7850074b5cca", "username": "neo@opsgenie.com" ], "state": "action", "method": "Acknowledge", "createdAt": "2017-04-12T12:27:28.52Z", "updatedAt": "2017-04-12T12:27:52.86Z" ], [ "user": [ "id": "0966cfd8-fc9a-4f5c-a013-7d1f9318aef8", "username": "trinity@opsgenie.com" ], "state": "notactive", "method": "", "createdAt": "2017-04-12T12:27:28.571Z", "updatedAt": "2017-04-12T12:27:28.589Z" ] ], "took": 0.306, "requestId": "d90a7fb5-f5b6-4e1a-a1d1-0a37bded6a32" ]

アラートメモのリストリクエスト

アラートメモのリストリクエストは、Opsgenie でアラートメモを取得するために使用されます。ここでは、次のパラメーターを使用します。

必須パラメーター

パラメーター

説明

ID

取得するアラートのID。

エイリアス

取得するアラートのエイリアス。

tinyId

アラートに割り当てられている短い ID。すべてのリクエストが tinyId をサポートしていますが、このフィールドは変動するため、使用はお勧めしません。

id、alias、または tinyId パラメーターのいずれかを、アラートメモのリストリクエストで指定する必要があります。エイリアス オプションは、オープン アラートに対してのみ使用できます。

オプション パラメーター

パラメーター

説明

offset

offset プロパティの開始値です。

direction

指定されたオフセットに適用されるページ方向。指定できる値は、next、および prev です。既定値は next です。
next: 提供されたログのオフセット値は、指定されたオフセットより大きい必要があります。
prev: 提供されたログのオフセット値は、指定されたオフセットより小さい必要があります。

limit

結果で表示する項目の最大数。正の整数値である必要があります。既定値は 20 で、最大値は 100 です。

注文

結果セットのソート順です。指定できる値は、desc、および asc です。既定値は desc です。desc: 結果セットを降順でソートします。
asc: 結果セットを昇順でソートします。

リクエストの例

groovy

1 opsgenie.listAlertNotes(["id" : "123"])

応答:

groovy

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 [ "notes": [ [ "note": "This is your last chance. After this, there is no turning back. You take the blue pill—the story ends, you wake up in your bed and believe whatever you want to believe. You take the red pill—you stay in Wonderland and I show you how deep the rabbit-hole goes.", "owner": "morpheus@opsgenie.com", "createdAt": "2017-04-12T13:36:21.874Z", "offset": "1492004181874000155" ], [ "note": "You see there is only one constant. One universal. It is the only real truth: Causality. Action, reaction. Cause and effect.", "owner": "merovingian@opsgenie.com", "createdAt": "2017-04-12T13:36:18.098Z", "offset": "1492004178098000065" ] ], "requestId": "fbbd807d-6024-4572-8d51-bd4a047617d0", "took": 0.278, "paging": [ "next": "https://api.opsgenie.com/v2/alerts/ee624ed0-3ee0-45be-9c9d-e7667eaf21e5/notes?identifierType=id&offset=1492004181874000155&direction=next&limit=2&order=desc", "first": "https://api.opsgenie.com/v2/alerts/ee624ed0-3ee0-45be-9c9d-e7667eaf21e5/notes?identifierType=id&limit=2&order=desc" ] ]

承認リクエスト

承認リクエストは、Opsgenie でアラートを承認するために使用されます。ここでは、次のパラメーターを使用します。

必須パラメーター

パラメーター

説明

ID

承認されるアラートのID。

エイリアス

承認されるアラートのエイリアス。

tinyId

アラートの tinyId。

id、alias、または tinyId パラメーターのいずれかを、アラートの取得リクエストで指定する必要があります。エイリアス オプションは、オープン アラートに対してのみ使用できます。

オプション パラメーター

パラメーター

説明

ユーザー

実行のデフォルト所有者。userが指定されない場合、アカウントの所有者が使用されます。

注意

追加のアラートメモ。

ソース

承認アクションのソースを指定するユーザー定義フィールド。

リクエストの例

groovy

1 opsgenie.acknowledge(["id":"123", "user":"user1@yourdomain.com"])

承認解除リクエスト

承認解除リクエストは、アラートの状態を未承認に戻すために使用されます。ここでは、次のパラメーターを使用します。

必須パラメーター

パラメーター

説明

ID

承認解除されるアラートの ID。

エイリアス

再承認されるアラートのエイリアス。

tinyId

アラートに割り当てられている短い ID。すべてのリクエストが tinyId をサポートしていますが、このフィールドは変動するため、使用はお勧めしません。

idalias、または tinyId パラメーターのいずれかを、アラートの承認解除リクエストで指定する必要があります。

オプション パラメーター

パラメーター

説明

ユーザー

実行のデフォルト所有者。user が指定されない場合、システムが実行の所有者になります。

注意

追加のアラートメモ。

ソース

承認解除アクションのソースを指定するユーザー定義フィールド。

リクエストの例

groovy

1 opsgenie.unAcknowledge(["id" : "123"])

スヌーズリクエスト

スヌーズリクエストは Opsgenie でアラートをスヌーズするために使用されます。ここでは、次のパラメーターを使用します。

必須パラメーター

パラメーター

説明

ID

スヌーズするアラートの ID。

エイリアス

スヌーズされるアラートのエイリアス。

tinyId

アラートに割り当てられている短いID。すべてのリクエストが tinyId をサポートしていますが、このフィールドは変動するため、使用はお勧めしません。

終了日

スヌーズが終了する日時。

id、alias、または tinyId パラメーターのいずれかを、アラートのスヌーズリクエストで指定する必要があります。エイリアス オプションは、オープン アラートに対してのみ使用できます。

オプション パラメーター

パラメーター

説明

ユーザー

実行のデフォルト所有者。user が指定されない場合、システムが実行の所有者になります。

注意

追加のアラートメモ。

ソース

スヌーズ アクションのソースを指定するユーザー定義フィールド。

リクエストの例

groovy

1 opsgenie.snooze(["id" : "123", "endDate" : new Date("11/16/2016 08:00")])

再通知リクエスト

再通知リクエストは、Opsgenie で指定されたアラートについて受信者に再通知するために使用されます。ここでは、次のパラメーターを使用します。

必須パラメーター

ID

承認されるアラートのID。

エイリアス

承認されるアラートのエイリアス。

tinyId

アラートの tinyId。

ID、エイリアス、または tinyId パラメーターのいずれかを、再通知アラート リクエストで指定する必要があります。エイリアス オプションは、未処理のアラートに対してのみ使用できます。

オプション パラメーター

パラメーター

説明

recipients

個々のユーザーまたはグループのユーザー名。指定しない場合、アラートの受信者に再通知されます。

ユーザー

実行のデフォルト所有者。userが指定されない場合、アカウントの所有者が使用されます。

注意

追加のアラートメモ。

ソース

再通知アクションのソースを指定するユーザー定義フィールド。

リクエストの例

groovy

1 opsgenie.renotify(["id":"123"])

所有権の保有リクエスト

所有権の保有リクエストは、Opsgenie でアラートの所有権を保有するために使用されます。ここでは、次のパラメーターを使用します。

必須パラメーター

ID

所有権を保有するアラートのID。

エイリアス

所有権を保有するアラートのエイリアス。

tinyId

アラートの tinyId。

id、alias、または tinyId パラメーターのいずれかを、所有権の保有リクエストで指定する必要があります。エイリアス オプションは、オープン アラートに対してのみ使用できます。

オプション パラメーター

パラメーター

説明

ユーザー

実行のデフォルト所有者。userが指定されない場合、アカウントの所有者が使用されます。

注意

追加のアラートメモ。

ソース

所有権の保有アクションのソースを指定するユーザー定義フィールド。

リクエストの例

groovy

1 opsgenie.takeOwnership(["id":"123", "user":"user2@yourdomain.com"])

アラートのカウントリクエスト

アラートのカウントリクエストは、Opsgenieでアラートをカウントするために使用されます。ここでは、次のパラメーターを使用します。

必須パラメーター

パラメーター

説明

API キー

API キーは、API リクエストの認証に使用されます。

オプション パラメーター

パラメーター

説明

以下の日付以降に作成されたタスク

ナノ秒に変換される UNIX タイムスタンプ値。リクエストは、指定された時間より後に作成されたすべてのアラートを返します。

createdBefore

ナノ秒に変換される UNIX タイムスタンプ値。リクエストは、指定された時間より前に作成されたすべてのアラートを返します。

updatedAfter

ナノ秒に変換される UNIX タイムスタンプ値。リクエストは、指定された時間より後にアップデートされたすべてのアラートを返します。

updatedBefore

ナノ秒に変換される UNIX タイムスタンプ値。リクエストは、指定された時間より前にアップデートされたすべてのアラートを返します。

limit

パフォーマンス上の理由から、望ましい結果はその件数を制限することです。最大:100000、デフォルト:100000

status

指定されたステータスのアラートをクエリするために使用されます。open、acked、unacked、seen、notseen、closed のいずれかを指定できます。

tags

"tag1, tag2"のような、アラートに添付されるラベルのカンマ区切りのリスト

tagsOperator

タグは、フィルタリングされると「tag1 and tag2」などの tagsOperator と結合されます。許可される値: and/or、既定: and。

リクエストの例

groovy

1 opsgenie.countAlerts(["status":"open"])

割り当てリクエスト

割り当てリクエストは、Opsgenie でアラートの所有権を割り当てるために使用されます。これは、次のパラメーターを取ります:

必須パラメーター

パラメーター

説明

ID

割り当てられるアラートの ID。

エイリアス

割り当てられるアラートのエイリアス。

tinyId

アラートの tinyId。

owner

アラートが割り当てられるユーザー。ユーザーの id または username を指定する必要があります。

id、alias、または tinyId パラメーターのいずれかを、アラートの割り当てリクエストで指定する必要があります。エイリアス オプションは、オープン アラートに対してのみ使用できます。

オプション パラメーター

パラメーター

説明

ユーザー

実行のデフォルト所有者。userが指定されない場合、アカウントの所有者が使用されます。

注意

追加のアラートメモ。

ソース

割り当てアクションのソースを指定するユーザー定義フィールド。

リクエストの例

groovy

1 opsgenie.assign(["id":"123", "owner":["id":"4513b7ea-3b91-438f-b7e4-e3e54af9147c"]])

チームの追加リクエスト

チームの追加リクエストは、Opsgenie でアラートに新しいチームを追加するために使用されます。ここでは、次のパラメーターを使用します。

必須パラメーター

パラメーター

説明

ID

新しいチームが追加されるアラートの ID。

エイリアス

新しいチームが追加されるアラートのエイリアス。

tinyId

アラートの tinyId。

team

アラートをルーティングするチーム。チームの id または name を指定する必要があります。

id、alias、または tinyId パラメーターのいずれかを、チームの追加リクエストで指定する必要があります。エイリアス オプションは、オープン アラートに対してのみ使用できます。

オプション パラメーター

パラメーター

説明

ユーザー

実行のデフォルト所有者。userが指定されない場合、アカウントの所有者が使用されます。

注意

追加のアラートメモ。

ソース

チーム追加アクションのソースを指定するユーザー定義フィールド。

リクエストの例

groovy

1 opsgenie.addTeam(["id":"123", "team":["id":"4513b7ea-3b91-438f-b7e4-e3e54af9147c"]])

受信者追加リクエスト

受信者の追加リクエストは、Opsgenie で新しい受信者 (ユーザーまたはグループ) をアラートに追加するために使用されます。ここでは、次のパラメーターを使用します。

必須パラメーター

パラメーター

説明

ID

新しい受信者が追加されるアラートのID。

エイリアス

新しい受信者が追加されるアラートのエイリアス。

tinyId

アラートの tinyId。

受信者

追加される新しい受信者。

id、alias、または tinyId パラメーターのいずれかを、REQUEST_NAME アラート リクエストで指定する必要があります。エイリアス オプションは、オープン アラートに対してのみ使用できます。

オプション パラメーター

パラメーター

説明

ユーザー

実行のデフォルト所有者。userが指定されない場合、アカウントの所有者が使用されます。

注意

追加のアラートメモ。

ソース

受信者の追加アクションのソースを指定するユーザー定義フィールド。

リクエストの例

groovy

1 opsgenie.addRecipient(["id":"123", "recipient":"newRecipient@yourdomain.com"])

タグの追加リクエスト

タグ追加リクエストは、Opsgenie でアラートに新しいタグを追加するために使用されます。これでは、次のパラメーターを使用します。

必須パラメーター

パラメーター

説明

ID

新しいタグが追加されるアラートのID。

エイリアス

新しいタグが追加されるアラートのエイリアス。

tinyId

アラートの tinyId。

tags

タグのリストがアラートに追加されます。

id、alias、または tinyId パラメーターのいずれかを、タグの追加リクエストで指定する必要があります。エイリアス オプションは、オープン アラートに対してのみ使用できます。

オプション パラメーター

パラメーター

説明

ユーザー

実行のデフォルト所有者。userが指定されない場合、アカウントの所有者が使用されます。

注意

追加のアラートメモ。

ソース

タグの追加アクションのソースを指定するユーザー定義フィールド。

リクエストの例

groovy

1 opsgenie.addTags(["id":"123", "tags":["autoClose", "support"]])

タグの削除リクエスト

タグの削除リクエストは、Opsgenie でアラートからタグを削除するために使用されます。ここでは、次のパラメーターを使用します。

必須パラメーター

パラメーター

説明

ID

指定されたタグが削除されるアラートのID。

エイリアス

指定されたタグが削除されるアラートのエイリアス。

tinyId

アラートの tinyId。

tags

タグのリストがアラートから削除されます。

id、alias、または tinyId パラメーターのいずれかを、タグの削除リクエストで指定する必要があります。エイリアス オプションは、オープン アラートに対してのみ使用できます。

オプション パラメーター

パラメーター

説明

ユーザー

実行のデフォルト所有者。userが指定されない場合、アカウントの所有者が使用されます。

注意

追加のアラートメモ。

ソース

タグの削除アクションのソースを指定するユーザー定義フィールド。

リクエストの例

groovy

1 opsgenie.removeTags(["id":"123", "tags":["autoClose", "support"]])

詳細の追加リクエスト

詳細の追加リクエストは、Opsgenieでアラートの詳細にプロパティを追加するために使用されます。既存のアラートプロパティのキーを送信すると、既存のキーが上書きされます。ここでは、次のパラメーターを使用します。

必須パラメーター

パラメーター

説明

ID

詳細が追加されるアラートのID。

エイリアス

詳細が追加されるアラートのエイリアス。

tinyId

アラートに割り当てられている短い ID。すべてのリクエストが tinyId をサポートしていますが、このフィールドは変動するため、使用はお勧めしません。

詳細

アラートの詳細に追加されるプロパティのセット。

id、alias、または tinyId パラメーターのいずれかを、詳細の追加リクエストで指定する必要があります。エイリアス オプションは、オープン アラートに対してのみ使用できます。

オプション パラメーター

パラメーター

説明

ユーザー

実行のデフォルト所有者。user が指定されない場合、システムが実行の所有者になります。

ソース

詳細の追加アクションのソースを指定するユーザー定義フィールド。

注意

追加のアラートメモ。

リクエストの例

groovy

1 opsgenie.addDetails(["id" : "123", "details" : ["prop1" : "val1", "prop2" : "val2"]])

詳細の削除リクエスト

詳細の削除リクエストは、Opsgenie のアラートの詳細からプロパティを削除するために使用されます。ここでは、次のパラメーターを使用します。

必須パラメーター

パラメーター

説明

ID

詳細プロパティが削除されるアラートのID。

エイリアス

詳細プロパティが削除されるアラートのエイリアス。

tinyId

アラートに割り当てられている短い ID。すべてのリクエストが tinyId をサポートしていますが、このフィールドは変動するため、使用はお勧めしません。

キー

アラート詳細プロパティのキーのリスト。

id、alias、または tinyId パラメーターのいずれかを、詳細の削除リクエストで指定する必要があります。エイリアス オプションは、オープン アラートに対してのみ使用できます。

オプション パラメーター

パラメーター

説明

ユーザー

実行のデフォルト所有者。user が指定されない場合、システムが実行の所有者になります。

ソース

詳細の削除アクションのソースを指定するユーザー定義フィールド。

注意

追加のアラートメモ。

リクエストの例

groovy

1 opsgenie.removeDetails(["id" : "123", "keys" : ["key1", "key2"]])

ノート追加リクエスト

メモの追加リクエストは、Opsgenie でアラートにメモを追加するために使用されます。ここでは、次のパラメーターを使用します。

必須パラメーター

パラメーター

説明

ID

メモが追加されるアラートのID。

エイリアス

メモが追加されるアラートのエイリアス。

tinyId

アラートの tinyId。

注意

メモのテキスト。

id、alias、または tinyId パラメーターのいずれかを、メモの追加リクエストで指定する必要があります。エイリアス オプションは、オープン アラートに対してのみ使用できます。

オプション パラメーター

パラメーター

説明

ユーザー

実行のデフォルト所有者。userが指定されない場合、アカウントの所有者が使用されます。

ソース

メモの追加アクションのソースを指定するユーザー定義フィールド。

リクエストの例

groovy

1 opsgenie.addNote(["id":"123", "note":"Sample Note"]);

アクションの実行リクエスト

アクションの実行リクエストは、Opsgenieでアラートに対して事前定義されたアクションを実行するために使用されます。ここでは、次のパラメーターを使用します。

必須パラメーター

パラメーター

説明

ID

アクションが実行されるアラートの ID。

エイリアス

アクションが実行されるアラートのエイリアス。

tinyId

アラートの tinyId。

操作

実行するアクション。

id、alias、または tinyId パラメーターのいずれかを、アクションの実行リクエストで指定する必要があります。エイリアス オプションは、オープン アラートに対してのみ使用できます。

オプション パラメーター

パラメーター

説明

ユーザー

実行のデフォルト所有者。userが指定されない場合、アカウントの所有者が使用されます。

注意

追加のアラートメモ。

ソース

アクションの実行のソースを指定するユーザー定義フィールド。

リクエストの例

groovy

1 opsgenie.executeAlertAction(["id":"123", "action":"ping"])

ファイルの添付リクエスト

ファイルの添付リクエストは、Opsgenie でアラートにファイルを添付するために使用されます。これは、マルチパート HTTP リクエストとして送信する必要があります。ここでは、次のパラメーターを使用します。

必須パラメーター

パラメーター

説明

ID

添付ファイルが追加されるアラートのID。

エイリアス

添付ファイルが追加されるアラートのエイリアス。

tinyId

アラートの tinyId。

attachment

添付ファイルの内容。

id、alias、または tinyId パラメーターのいずれかを、ファイルの添付リクエストで指定する必要があります。エイリアス オプションは、オープン アラートに対してのみ使用できます。

オプション パラメーター

パラメーター

説明

ユーザー

実行のデフォルト所有者。userが指定されない場合、アカウントの所有者が使用されます。

ソース

添付アクションのソースを指定するユーザー定義フィールド。

indexFile

UI上で添付ファイルがクリックされたときに表示されるHTMLファイルの名前。
指定しない場合、インデックスファイル名を決定するために、次のルールが記載されている順序で適用されます。
zip ファイルでない場合は、添付ファイルの名前が割り当てられます。
zip ファイルの場合は、
添付ファイル名と同じ名前の HTML ファイルが割り当てられます。
index.htm または index.html ファイル
ZIP で最初に見つかった HTML ファイル
HTML ファイルが存在しない場合は、添付の zip ファイル名が割り当てられ、添付ファイルをクリックすると、Opsgenie Web サイトから直接 zip ファイルがダウンロードされます。

注意

追加のアラートメモ。

リクエストの例

groovy

1 opsgenie.attach(["id":"123", "attachment":"sample.txt"])

次へエスカレートリクエスト

次へエスカレートリクエストは、指定されたエスカレーションで次に使用可能なルールをすぐに処理するために使用されます。ここでは、次のパラメーターを使用します。

詳細については、次へエスカレートのドキュメントページを参照してください。
必須パラメーター

パラメーター

説明

ID

詳細が追加されるアラートのID。

エイリアス

詳細が追加されるアラートのエイリアス。

tinyId

アラートに割り当てられている短い ID。すべてのリクエストが tinyId をサポートしていますが、このフィールドは変動するため、使用はお勧めしません。

エスカレーション

アラートがエスカレートされるエスカレーション。エスカレーションの id またはnameを指定する必要があります。

id、alias、または tinyId パラメーターのいずれかを、次へエスカレートリクエストで指定する必要があります。エイリアス オプションは、オープン アラートに対してのみ使用できます。

オプション パラメーター

パラメーター

説明

ユーザー

実行のデフォルト所有者。user が指定されない場合、システムが実行の所有者になります。

注意

追加のアラートメモ。

ソース

承認解除アクションのソースを指定するユーザー定義フィールド。

リクエストの例

groovy

1 opsgenie.escalateToNext(["id" : "123", "escalation":["name":"Operations_Escalation"]])

保存済み検索の作成リクエスト

保存済み検索の作成リクエストは、Opsgenie で保存済み検索クエリを新規に作成するために使用されます。これは、次のパラメーターを取ります:
必須パラメーター

パラメーター

説明

name

保存済み検索の一意の名前。最大文字数は 100 文字です。

クエリ

アラートをフィルタリングする際に使用する検索クエリ。最大文字数は 1,000 文字です。

owner

保存済み検索の所有者として割り当てられるユーザー。所有者は常に保存済み検索にアクセスできます。

オプション パラメーター

パラメーター

説明

description

保存済み検索の情報を示す説明です。最大文字数は 15,000 文字です。

teams

保存済み検索が割り当てられるチーム。保存済み検索が少なくとも 1 つのチームに割り当てられている場合、保存済み検索には、割り当てられているチームの所有者とメンバーのみがアクセスできます。保存済み検索は、最大20チームに割り当てることができます。

リクエストの例

groovy

1 opsgenie.addSavedSearch(["name":"New Saved Search", "query":"status=Open", "owner":["username":"owner@opsgenie.com"]])

保存済み検索の削除リクエスト

保存済み検索の削除リクエストは、Opsgenie で保存済み検索クエリを削除するために使用されます。ここでは、次のパラメーターを使用します。

必須パラメーター

パラメーター

説明

name

保存済み検索の一意の名前。最大文字数は 100 文字です。

ID

保存済み検索の一意の ID。

id または name パラメーターのいずれかを、保存済み検索の削除リクエストで指定する必要があります。

リクエストの例

groovy

1 opsgenie.deleteSavedSearch(["name":"My Saved Search"]])

保存済み検索取得リクエスト

保存済み検索の取得リクエストは、Opsgenie で保存済み検索クエリを取得するために使用されます。ここでは、次のパラメーターを使用します。

必須パラメーター

パラメーター

説明

name

保存済み検索の一意の名前。最大文字数は 100 文字です。

ID

保存済み検索の一意の ID。

id または name パラメーターのいずれかを、保存済み検索の取得リクエストで指定する必要があります。

リクエストの例

groovy

1 opsgenie.getSavedSearch(["id":"8418d193-2dab-4490-b331-8c02cdd196b7"]])

保存済み検索のリストリクエスト

保存済み検索のリストリクエストは、Opsgenie で保存済み検索クエリをリストするために使用されます。ここでは、次のパラメーターを使用します。

必須パラメーター

パラメーター

必須パラメーターはありません。

リクエストの例

groovy

1 opsgenie.listSavedSearch([:]])

応答 (Groovyマップ):

groovy

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 [ "data": [ [ "id": "62dca743-bddc-4d17-99ab-6d8e0c066d1c", "name": "unacked alerts query" ], [ "id": "3155ddd1-8d6c-438e-9cdd-28b31edca301", "name": "team apollo alerts" ], [ "id": "d8b16789-3b71-48e4-9ff2-48a76a789137", "name": "Critical_Open_Alerts" ] ], "requestId": "fbd4a99d-aa05-4549-870d-02fa3d6395e5" ]

メモリストア

データをメモリにロードして後でアクションを実行するために使用します。Opsgenie Marid では、これらのニーズを満たすために com.ifountain.opsgenie.client.marid.MemoryStore クラスを提供します。
メモリ ストア クラスには、次のヘルパー メソッドがあります。

Store

Store メソッドは、key,value ペアとしてメモリにデータを追加します。

使用例

groovy

1 2 3 import com.ifountain.opsgenie.client.marid.MemoryStore MemoryStore.store("prop1","val1")

Lookup

Lookup メソッドは、メモリをチェックして、データが存在する場合は指定されたキーで取得します。

使用例

groovy

1 2 3 import com.ifountain.opsgenie.client.marid.MemoryStore def prop = MemoryStore.lookup("prop1")

削除

Remove メソッドは、データが存在する場合は指定されたキーで削除します。

使用例

groovy

1 2 3 import com.ifountain.opsgenie.client.marid.MemoryStore MemoryStore.remove("prop1")

リセット

Resetメソッドは、メモリ内のデータストアをクリアします。

使用例

groovy

1 2 3 import com.ifountain.opsgenie.client.marid.MemoryStore MemoryStore.reset()



その他のヘルプ