カスタムアラート

言語:

カスタムアラートとは、カスタムイベントに対するアラートアクションのことです。category の値に custom を指定します。

カスタムイベントはワークフローで定義されます。事前定義されたイベントから選択するのではなく、ワークフローで定義されたイベントを説明する次のプロパティーを指定します。

表 10 カスタムアラートのプロパティー

プロパティー	型	説明
`severity`	String	オプション。警告の原因となったイベントの重要度。有効な値は、Minor、Major、または Critical です。
`description`	String	必須。アラートの原因となったイベントの説明。
`response`	String	オプション。このイベントの影響を軽減するためにシステムが実行するアクションの説明。
`impact`	String	オプション。このイベントのアプライアンスに対する影響の説明。
`recommended_action`	String	オプション。このイベントの影響を軽減するために管理者が実行するアクションの説明。

カスタムアラートを作成および送信するための承認の構成

カスタムアラートを作成するには、ユーザーは、alert スコープの allow_configure 承認が必要です。カスタムアラートを送信するには、ユーザーは、alert スコープの allow_post 承認が必要です。Oracle ZFS Storage Appliance 管理ガイド、Release OS8.8.x のカスタムアラートを使用するために必要な承認を参照してください。

カスタムアラートの作成

category の値に custom を指定し、表 10, カスタムアラートのプロパティーから少なくとも description プロパティーの値を設定します。

リクエストの例:

POST /api/alert/v1/actions
Accept: application/json
Content-Type: application/json

{"category": "custom", "severity": "Minor", "description": "Custom alert description",
"response": "What the system will do", "impact": "What happened to the appliance", 
"recommended_action": "What the administrator should do"}

結果例:

出力のアラートの uuid を書き留めておきます。これはアラートを送信する際に必要になります。

{
    "actions": {
        "href": "/api/alert/v1/actions/actions-004",
        "category": "custom",
        "severity": "Minor",
        "description": "Custom alert description",
        "response": "What the system will do",
        "impact": "What happened to the appliance",
        "recommended_action": "What the administrator should do",
        "uuid": "custom-alert-uuid"
    }
}

アラートアクションの変更で説明されているように、他のアラートを変更するのと同じ方法で、このカスタムアラートを変更し、severity、description、response、impact、または recommended_action プロパティーの値を追加または変更します。

イベントの応答の指定およびイベントの応答の変更で説明されているように、他のアラートへの応答を指定するのと同じ方法で、このカスタムアラートへの応答を指定します。

イベントの応答の削除およびアラートアクションの削除で説明されているように、他のアラートと同じ方法で、アラートの応答またはカスタムアラートを削除します。

カスタムアラートの送信

送信するカスタムアラートの UUID を指定する必要があります。UUID は、アラートを作成するとき、およびアラートを一覧表示するときに表示されます。カスタムアラートの作成および単一アラートアクションの一覧表示を参照してください。

category の値が custom であるアラートのみを送信できます。

アラートの UUID に加えて、表 10, カスタムアラートのプロパティーに一覧表示されているプロパティーのうち、アラートで指定されていないものを指定する必要があります。アラートで指定されたプロパティーには、アラートが送信されたときに新しい値を指定できます。

リクエストの例:

POST /api/alert/v1/postalert
Accept: application/json
Content-Type: application/json

{"uuid": "custom-alert-uuid"}

結果例:

{
    "uuid": "posted-alert-uuid"
}