CreateOrUpdateIMRobot - Application Real-Time Monitoring Service

Membuat atau memperbarui robot IM.

Coba sekarang

Coba API ini di OpenAPI Explorer tanpa perlu penandatanganan manual. Panggilan yang berhasil akan secara otomatis menghasilkan contoh kode SDK sesuai dengan parameter Anda. Unduh kode tersebut dengan kredensial bawaan yang aman untuk penggunaan lokal.

Test

RAM authorization

Tidak ada otorisasi untuk operasi ini. Jika Anda mengalami masalah saat menjalankan operasi ini, hubungi dukungan teknis.

Parameter permintaan

Parameter	Type	Required	Description	Example
RobotId	integer	No	ID robot IM. Kosongkan untuk membuat robot IM baru. Berikan nilai untuk memperbarui robot IM yang ditentukan.	123
RobotName	string	Yes	Nama robot IM.	robot名称
Type	string	Yes	Tipe robot IM: `dingding`: Robot DingTalk. `wechat`: Robot WeCom (Enterprise WeChat). `feishu`: Robot Lark (Feishu).	dingding
RobotAddress	string	Yes	Alamat webhook robot IM.	https://oapi.dingtalk.com/robot/send?access_token=e1a049121******
DailyNoc	boolean	No	Apakah akan mengirim statistik harian. `false` (default): Tidak mengirim statistik. `true`: Mengirim statistik. Jika diatur ke `true`, parameter DailyNocTime wajib diisi.	true
DailyNocTime	string	No	Pengatur waktu pengiriman statistik harian. Pisahkan beberapa pengatur waktu dengan koma (,). Format waktu adalah HH:SS. Manajemen alert ARMS mengirimkan jumlah total alert yang dihasilkan hari ini, jumlah alert yang diselesaikan, dan jumlah alert yang belum diselesaikan pada pengatur waktu yang ditentukan.	09:30,17:00
DingSignKey	string	No	Kunci rahasia tanda tangan DingTalk. Jika kunci rahasia dikonfigurasi, otentikasi DingTalk dilakukan melalui penandatanganan. Jika tidak ada kunci rahasia yang dikonfigurasi, daftar kata kunci yang diizinkan digunakan untuk otentikasi secara default, dan kata kunci dalam daftar izinkan adalah 告警 (alert).	******
Token	string	No	Token yang diperlukan untuk mengaktifkan mekanisme Outgoing.	1656558719183be1245ab44********
EnableOutgoing	boolean	No	Apakah akan mengaktifkan mekanisme Outgoing.	true
CardTemplate	string	No	Konfigurasi templat kartu alert. Untuk arti setiap parameter dalam templat, lihat catatan tambahan di bawah.	{ "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 } ] }

Catatan parameter CardTemplate

Contoh templat:

{
    "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: Nama bidang dalam kartu alert. Bidang yang didukung:
- notificationPolicy: Kebijakan notifikasi
- alarmName: Nama alert
- alarmContent: Konten alert
- alarmTime: Waktu alert
- includeEvent: Jumlah event yang disertakan
- assigned: Penerima notifikasi
- operator: Penangan alert
- similarAlarm: Alert serupa terakhir
- seriesChart: Grafik tren metrik alert
visible: Apakah konten bidang terkait terlihat pada kartu alert yang dikirim.
- true: Terlihat
- false: Tersembunyi
button: Tombol yang dikonfigurasi pada kartu. Urutan parameter sesuai dengan urutan tombol pada kartu. Tombol yang tersedia adalah:
- claim: Tombol klaim alert
- close: Tombol selesaikan alert
- follow: Tombol ikuti alert
- send_itsm: Tombol dorong alert
- block: Tombol blokir alert
- unResolvedIncident: Tombol alert belum diselesaikan.

Elemen respons

Element	Type	Description	Example
	object	Skema Respons.
RequestId	string	ID permintaan.	16AF921B-8187-489F-9913-43C808B4****
AlertRobot	object	Objek AlertRobot yang dikembalikan.
RobotId	number	ID robot IM. Berikan parameter ini untuk memodifikasi informasi robot.	123
RobotName	string	Nama robot IM.	robot名称
Type	string	Tipe robot IM: `dingding`: Robot DingTalk. `wechat`: Robot WeCom (Enterprise WeChat).	dingding
RobotAddress	string	Alamat webhook robot IM.	https://oapi.dingtalk.com/robot/send?access_token=e1a049121******
DailyNoc	boolean	Apakah akan mengirim statistik harian. `false` (default): Tidak mengirim statistik. `true`: Mengirim statistik.	true
DailyNocTime	string	Pengatur waktu pengiriman statistik harian. Manajemen alert ARMS mengirimkan jumlah total alert yang dihasilkan hari ini, jumlah alert yang diselesaikan, dan jumlah alert yang belum diselesaikan pada pengatur waktu yang ditentukan.	09:30,17:00
Token	string	Token yang diperlukan untuk mengaktifkan mekanisme Outgoing.	1656558719183be1245ab44********
EnableOutgoing	boolean	Apakah akan mengaktifkan mekanisme Outgoing.	true
CardTemplate	string	Konfigurasi templat kartu alert.	{ "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 } ] }

Contoh

Respons sukses

JSONformat

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

Kode kesalahan

Lihat Error Codes untuk daftar lengkap.

Catatan rilis

Lihat Release Notes untuk daftar lengkap.