CreateOrUpdateIMRobot - Application Real-Time Monitoring Service - Alibaba Cloud ドキュメントセンター

IM チャットボットを作成または更新します。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RobotId	integer	任意	IM チャットボットの ID。説明このパラメーターを指定しない場合、新しい IM チャットボットが作成されます。	123
RobotName	string	必須	IM チャットボットの名前。	robot名称
Type	string	必須	IM チャットボットのタイプ。有効な値： `dingding`：DingTalk チャットボット `wechat`：WeCom チャットボット `feishu`：Lark チャットボット	dingding
RobotAddress	string	必須	IM チャットボットの Webhook URL。	https://oapi.dingtalk.com/robot/send?access_token=e1a049121******
DailyNoc	boolean	任意	日次統計を送信するかどうかを指定します。有効な値： `false` (デフォルト)：日次統計は送信されません。 `true`：日次統計が送信されます。値を `true` に設定した場合、DailyNocTime パラメーターが必須になります。	true
DailyNocTime	string	任意	日次統計が送信される時点。複数の時点はコンマ (,) で区切ります。時点は HH:SS 形式です。指定された時点で ARMS が送信する情報には、当日生成されたアラートの総数、解除済みのアラート数、および解除待ちのアラート数が含まれます。	09:30,17:00
DingSignKey	string	任意	DingTalk の署名キー。署名キーを指定すると、DingTalk 認証は署名キーを使用して実行されます。署名キーを指定しない場合、デフォルトでホワイトリストが認証に使用されます。ホワイトリストのキーワードは Alert です。	******
Token	string	任意	Outgoing 機能を有効にするために必要なトークン。	1656558719183be1245ab44********
EnableOutgoing	boolean	任意	Outgoing 機能を有効にするかどうかを指定します。	true
CardTemplate	string	任意	アラートカードテンプレートの設定。テンプレート内のパラメーターの詳細については、次のセクションをご参照ください。	{ "button": [ "claim", "close", "follow", "send_itsm", "block", "unResolvedIncident" ], "field": [ { "fieldName": "alarmName", "visible": true }, { "fieldName": "notificationPolicy", "visible": true }, { "fieldName": "alarmContent", "visible": true }, { "fieldName": "alarmTime", "visible": true }, { "fieldName": "seriesChart", "visible": true }, { "fieldName": "includeEvent", "visible": true }, { "fieldName": "assigned", "visible": true }, { "fieldName": "similarAlarm", "visible": true }, { "fieldName": "operator", "visible": true } ] }

CardTemplate パラメーターの説明

テンプレートの例：

{
    "field": [
        {
            "fieldName": "alarmName",
            "visible": false
        },
        {
            "fieldName": "notificationPolicy",
            "visible": true
        },
        {
            "fieldName": "alarmContent",
            "visible": true
        },
        {
            "fieldName": "alarmTime",
            "visible": true
        },
        {
            "fieldName": "seriesChart",
            "visible": true
        },
        {
            "fieldName": "includeEvent",
            "visible": true
        },
        {
            "fieldName": "assigned",
            "visible": true
        },
        {
            "fieldName": "similarAlarm",
            "visible": true
        },
        {
            "fieldName": "operator",
            "visible": true
        }
    ],
    "button": [
        "claim",
        "close",
        "block",
        "send_itsm",
        "unResolvedIncident",
        "follow"
    ]
}

fieldName：アラートカード内のフィールド名。次のフィールドが含まれます：
- notificationPolicy：通知ポリシー
- alarmName：アラート名
- alarmContent：アラート内容
- AlarmTime：アラートがトリガーされた時刻
- includeEvent：イベント数。
- assigned：通知の送信先ユーザー
- operator：アラートを処理するユーザー
- similarAlarm：最後の類似アラート
- seriesChart：アラートメトリクスの傾向チャート
visible：アラートカード上の対応するフィールドの内容を表示するかどうかを指定します。
- true：表示
- false：非表示
button：カード内の設定ボタン。パラメーターの順序はカードボタンの順序に対応します。次のボタンが利用可能です：
- claim：アラートをクレームする
- close：アラートをクリアする
- follow：アラートをフォローする
- send_itsm：アラートをプッシュする
- block：アラートをブロックする
- unResolvedIncident：アラートを未解決に戻す

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエスト ID。	16AF921B-8187-489F-9913-43C808B4****
AlertRobot	object	IM チャットボットに関する情報。
RobotId	number	IM チャットボットの ID。	123
RobotName	string	IM チャットボットの名前。	robot名称
Type	string	IM チャットボットのタイプ。有効な値： `dingding`：DingTalk チャットボット `wechat`：WeCom チャットボット	dingding
RobotAddress	string	IM チャットボットの Webhook URL。	https://oapi.dingtalk.com/robot/send?access_token=e1a049121******
DailyNoc	boolean	日次統計が送信されるかどうかを示します。有効な値： `false` (デフォルト)：日次統計は送信されません。 `true`：日次統計が送信されます。	true
DailyNocTime	string	日次統計が送信される時点。指定された時点で ARMS が送信する情報には、当日生成されたアラートの総数、解除済みのアラート数、および解除待ちのアラート数が含まれます。	09:30,17:00
Token	string	Outgoing 機能を有効にするために必要なトークン。	1656558719183be1245ab44********
EnableOutgoing	boolean	Outgoing 機能が有効になっているかどうかを示します。	true
CardTemplate	string	アラートカードテンプレートの設定。	{ "button": [ "claim", "close", "follow", "send_itsm", "block", "unResolvedIncident" ], "field": [ { "fieldName": "alarmName", "visible": true }, { "fieldName": "notificationPolicy", "visible": true }, { "fieldName": "alarmContent", "visible": true }, { "fieldName": "alarmTime", "visible": true }, { "fieldName": "seriesChart", "visible": true }, { "fieldName": "includeEvent", "visible": true }, { "fieldName": "assigned", "visible": true }, { "fieldName": "similarAlarm", "visible": true }, { "fieldName": "operator", "visible": true } ] }

例

成功レスポンス

JSONJSON

{
  "RequestId": "16AF921B-8187-489F-9913-43C808B4****",
  "AlertRobot": {
    "RobotId": 123,
    "RobotName": "robot名称",
    "Type": "dingding",
    "RobotAddress": "https://oapi.dingtalk.com/robot/send?access_token=e1a049121******",
    "DailyNoc": true,
    "DailyNocTime": "09:30,17:00",
    "Token": "1656558719183be1245ab44********\n",
    "EnableOutgoing": true,
    "CardTemplate": "{     \"button\": [         \"claim\",         \"close\",         \"follow\",         \"send_itsm\",         \"block\",         \"unResolvedIncident\"     ],     \"field\": [         {             \"fieldName\": \"alarmName\",             \"visible\": true         },         {             \"fieldName\": \"notificationPolicy\",             \"visible\": true         },         {             \"fieldName\": \"alarmContent\",             \"visible\": true         },         {             \"fieldName\": \"alarmTime\",             \"visible\": true         },         {             \"fieldName\": \"seriesChart\",             \"visible\": true         },         {             \"fieldName\": \"includeEvent\",             \"visible\": true         },         {             \"fieldName\": \"assigned\",             \"visible\": true         },         {             \"fieldName\": \"similarAlarm\",             \"visible\": true         },         {             \"fieldName\": \"operator\",             \"visible\": true         }     ] }"
  }
}

エラーコード

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。