createReport — шуурхай эсвэл хуваарьт тайлан үүсгэх
Энэ хуудсыг AI-аар орчуулж, автоматаар шалгасан. Нарийн тохиргоо хийхээсээ өмнө англи эхтэй тулгаж болно.
Энэ арга нь хүлээн авсан параметрүүдэд үндэслэн шуурхай (instant) эсвэл хуваарьт (scheduled) шинэ тайлан үүсгээд, шинээр үүссэн тайлангийн ID-г буцаана.
Шуурхай тайлан API дуудлагын үед нэг л удаа үүсч ажиллана.
Хуваарьт тайлан хожим үүсэх бөгөөд өмнө нь тодорхойлсон хуваарийн дагуу үе үе ажиллана.
Үйлчилгээнүүд
Энэ арга нь API URL-д {service} нэрийг оруулахыг шаарддаг. Зөвшөөрөгдсөн үйлчилгээнүүд:
computers— "Computers and Virtual Machines"virtualmachines— "Virtual Machines"
Жишээ нь virtualmachines үйлчилгээний хүсэлтийн URL:
https://YOUR-HOSTNAME/api/v1.0/jsonrpc/reports/virtualmachines
Параметрүүд
| Параметр | Төрөл | Заавал эсэх | Тайлбар |
|---|---|---|---|
name | String | Заавал | Тайлангийн нэр. |
type | Number | Заавал | Тайлангийн төрөл (дугаараар). Хүчинтэй төрлийн дугааруудыг getReportsList хуудасны type параметрийн жагсаалтаас үзнэ үү. |
targetIds | Array | Заавал | Тайлан үүсгэх зорилтуудын ID-ийн жагсаалт. Зорилт нь тайлангийн төрлөөс хамаарна. Дараах тайлангуудад зорилт нь зөвхөн хэрэглэгчийн компанийн ID эсвэл түүний шатлал доторх хүүхэд компаниудын ID байж болно (endpoint, бүлэг, container хүчингүй): Customer Status Overview, AWS Monthly Usage, Top 10 Infected Companies. Бусад тайлангийн төрөлд зорилтын ID нь ямар ч төрлийнх байж болно: бүлэг, компани, container, endpoint. |
scheduledInfo | Object | Заавал биш | Тайлан ажиллах хуваарийг тодорхойлсон объект. Параметрийг орхивол шуурхай тайлан үүснэ. Дэлгэрэнгүйг доорх scheduledInfo объектын хэсгээс үзнэ үү. |
options | Object | Заавал биш | Тайлан үүсгэх сонголтуудыг тодорхойлсон объект. Дараах тайлангуудад options объектыг тохируулах ёсгүй: Endpoint Modules Status, Policy Compliance, Security Server Status, Upgrade Status. Дэлгэрэнгүйг доорх options объектын хэсгээс үзнэ үү. |
emailList | Array | Заавал биш | Тайланг хүргэх и-мэйл хаягуудын жагсаалт. Шуурхай тайланд emailList-ийг тохируулах ёсгүй. Энэ параметрийг зөвхөн хүсэлтэд scheduledInfo параметр орсон үед ашиглаж болно. |
Объектууд
scheduledInfo
Энэ объектыг createReport дуудлагад ашиглах бөгөөд тайлан ажиллах хуваарийг тодорхойлно.
Объект нь тайлангийн давтамжаас (occurrence) хамаарч хувьсах тооны гишүүдийг агуулна:
| Нэр | Төрөл | Тайлбар |
|---|---|---|
occurrence | integer | Гишүүн заавал байна. Боломжит утгууд: 1 - шуурхай тайлан (Тэмдэглэл: Энэ утга зөвхөн хүсэлтэд scheduledInfo параметр байхгүй үед боломжтой); 2 - цаг тутмын тайлан; 3 - өдөр тутмын тайлан; 4 - долоо хоног тутмын тайлан; 5 - сар тутмын тайлан; 6 - жил тутмын тайлан. |
interval | integer | Гишүүнийг зөвхөн occurrence нь 2 үед тохируулна. Боломжит утгууд: 1-ээс 24 хүртэлх дурын бүхэл тоо, тайлан ажиллах интервалыг (цагаар) илэрхийлнэ. |
startHour | integer | Гишүүнийг зөвхөн occurrence нь 3, 4 эсвэл 5 үед тохируулна. Боломжит утгууд: 0-ээс 23 хүртэлх дурын бүхэл тоо. |
startMinute | integer | Гишүүнийг зөвхөн occurrence нь 3, 4 эсвэл 5 үед тохируулна. Боломжит утгууд: 0-ээс 59 хүртэлх дурын бүхэл тоо. |
days | array | Гишүүнийг зөвхөн occurrence нь 4 үед тохируулна. Массивын элементүүдийн боломжит утгууд: 0-ээс 6 хүртэлх бүхэл тоо, долоо хоногийн өдрүүдийг илэрхийлнэ (0 - Ням гараг, 6 - Бямба гараг). |
day | integer | Гишүүнийг зөвхөн occurrence нь 5 эсвэл 6 үед тохируулна. Боломжит утгууд: 1-ээс 31 хүртэлх бүхэл тоо, сарын өдрийг илэрхийлнэ. |
month | integer | Гишүүнийг зөвхөн occurrence нь 6 үед тохируулна. Боломжит утгууд: 1-ээс 12 хүртэлх бүхэл тоо, жилийн сарыг илэрхийлнэ. |
options
Энэ объектыг createReport дуудлагад ашиглах бөгөөд тайлангийн төрлөөс хамаарч хувьсах тооны гишүүдийг агуулна.
Доорх тайлан бүрийн жагсаалтад "Тайлангийн давтамжаас хамаарна" гэсэн тэмдэглэл нь reportingInterval гишүүний утга тайлангийн давтамжаас (occurrence) хамаарахыг заана. Дэлгэрэнгүйг доорх "Тайлагналын интервал ба давтамжийн хамаарал" хэсгээс үзнэ үү.
Antiphishing Activity — объект дараах гишүүдийг агуулах ёстой:
reportingInterval(integer) — Гишүүн заавал байна. Тайлангийн давтамжаас хамаарна.filterType(integer) — Гишүүн заавал байна. Боломжит утгууд:0- бүх endpoint;1- зөвхөн хориглогдсон вэб сайттай endpoint-ууд.
Blocked Applications — объект дараах гишүүдийг агуулах ёстой:
reportingInterval(integer) — Гишүүн заавал байна. Тайлангийн давтамжаас хамаарна.
Blocked Websites — объект дараах гишүүдийг агуулах ёстой:
reportingInterval(integer) — Гишүүн заавал байна. Тайлангийн давтамжаас хамаарна.filterType(integer) — Гишүүн заавал байна. Боломжит утгууд:0- бүх endpoint;1- зөвхөн хориглогдсон вэб сайттай endpoint-ууд.
Data Protection — объект дараах гишүүдийг агуулах ёстой:
reportingInterval(integer) — Гишүүн заавал байна. Тайлангийн давтамжаас хамаарна.filterType(integer) — Гишүүн заавал байна. Боломжит утгууд:0- бүх endpoint;1- зөвхөн хориглогдсон аюултай удирдагдаж буй компьютерууд.blockedEmails(boolean) — Гишүүнийг зөвхөнfilterTypeнь 1 үед тохируулна. Боломжит утгууд:True,False.blockedWebsites(boolean) — Гишүүнийг зөвхөнfilterTypeнь 1 үед тохируулна. Боломжит утгууд:True,False.
Device Control Activity — объект дараах гишүүдийг агуулах ёстой:
reportingInterval(integer) — Гишүүн заавал байна. Тайлангийн давтамжаас хамаарна.
Endpoint Protection Status — объект дараах гишүүдийг агуулах ёстой:
filterType(integer) — Гишүүн заавал байна. Боломжит утгууд:0- бүх endpoint;1- зөвхөн доор тайлбарласан гишүүдээр шүүсэн endpoint-ууд.antivirusOn(boolean) — Гишүүнийг зөвхөнfilterTypeнь 1 үед тохируулна.True- antimalware хамгаалалт идэвхтэй endpoint-уудыг тайланд оруулна.False- antimalware хамгаалалт идэвхтэй endpoint-уудыг тайлангаас хасна.antivirusOff(boolean) — Гишүүнийг зөвхөнfilterTypeнь 1 үед тохируулна.True- antimalware хамгаалалт идэвхгүй endpoint-уудыг тайланд оруулна.False- antimalware хамгаалалт идэвхгүй endpoint-уудыг тайлангаас хасна.updated(boolean) — Гишүүнийг зөвхөнfilterTypeнь 1 үед тохируулна.True- шинэчлэгдсэн endpoint-уудыг тайланд оруулна.False- шинэчлэгдсэн endpoint-уудыг тайлангаас хасна.disabled(boolean) — Гишүүнийг зөвхөнfilterTypeнь 1 үед тохируулна.True- шинэчлэлт идэвхгүй болгосон endpoint-уудыг тайланд оруулна.False- шинэчлэлт идэвхгүй болгосон endpoint-уудыг тайлангаас хасна.outdated(boolean) — Гишүүнийг зөвхөнfilterTypeнь 1 үед тохируулна.True- хуучирсан endpoint-уудыг тайланд оруулна.False- хуучирсан endpoint-уудыг тайлангаас хасна.online(boolean) — Гишүүнийг зөвхөнfilterTypeнь 1 үед тохируулна.True- онлайн endpoint-уудыг тайланд оруулна.False- онлайн endpoint-уудыг тайлангаас хасна.offline(boolean) — Гишүүнийг зөвхөнfilterTypeнь 1 үед тохируулна.True- офлайн endpoint-уудыг тайланд оруулна.False- офлайн endpoint-уудыг тайлангаас хасна.
Firewall Activity — объект дараах гишүүдийг агуулах ёстой:
reportingInterval(integer) — Гишүүн заавал байна. Тайлангийн давтамжаас хамаарна.filterType(integer) — Гишүүн заавал байна. Боломжит утгууд:0- бүх endpoint;1- зөвхөн дараах хориглогдсон аюултай endpoint-ууд: traffic attempts болон port scans.trafficAttempts(boolean) — Гишүүнийг зөвхөнfilterTypeнь 1 үед тохируулна.True- port scan хориглогдсон endpoint-уудыг тайланд оруулна.False- port scan хориглогдсон endpoint-уудыг тайлангаас хасна.
Malware Status — объект дараах гишүүдийг агуулах ёстой:
reportingInterval(integer) — Гишүүн заавал байна. Тайлангийн давтамжаас хамаарна.filterType(integer) — Гишүүн заавал байна. Боломжит утгууд:0- бүх endpoint;1- зөвхөн одоо хүртэл халдвартай endpoint-ууд.detailedExport(array) — Гишүүн заавал биш. Боломжит утга:1- Endpoint Malware Status-ийг PDF файлд оруулна.
Network Status — объект дараах гишүүдийг агуулах ёстой:
filterType(integer) — Гишүүн заавал байна. Боломжит утгууд:0- бүх endpoint;1- зөвхөн асуудалтай endpoint-ууд;2- зөвхөн төлөв нь тодорхойгүй endpoint-ууд.
On demand scanning — объект дараах гишүүдийг агуулах ёстой:
reportingInterval(integer) — Гишүүн заавал байна. Тайлангийн давтамжаас хамаарна.
Security Audit — объект дараах гишүүдийг агуулах ёстой:
reportingInterval(integer) — Гишүүн заавал байна. Тайлангийн давтамжаас хамаарна.
Top 10 Detected Malware — объект дараах гишүүдийг агуулах ёстой:
reportingInterval(integer) — Гишүүн заавал байна. Тайлангийн давтамжаас хамаарна.
Top 10 Infected Endpoints — объект дараах гишүүдийг агуулах ёстой:
reportingInterval(integer) — Гишүүн заавал байна. Тайлангийн давтамжаас хамаарна.
Update Status — объект дараах гишүүдийг агуулах ёстой:
updated(boolean) —True- шинэчлэгдсэн endpoint-уудыг тайланд оруулна.False- шинэчлэгдсэн endpoint-уудыг тайлангаас хасна.disabled(boolean) —True- шинэчлэлт идэвхгүй болгосон endpoint-уудыг тайланд оруулна.False- шинэчлэлт идэвхгүй болгосон endpoint-уудыг тайлангаас хасна.outdated(boolean) —True- хуучирсан endpoint-уудыг тайланд оруулна.False- хуучирсан endpoint-уудыг тайлангаас хасна.pendingRestart(boolean) —True- дахин асаах (restart) шаардлагатай endpoint-уудыг тайланд оруулна.False- дахин асаах шаардлагатай endpoint-уудыг тайлангаас хасна.
VM Network Protection Status — объект дараах гишүүдийг агуулах ёстой:
filterType(integer) — Гишүүн заавал байна. Боломжит утгууд:0- бүх endpoint;1- зөвхөн хамгаалагдсан endpoint-ууд.
HyperDetect Activity — объект дараах гишүүдийг агуулах ёстой:
reportingInterval(integer) — Гишүүн заавал байна. Тайлангийн давтамжаас хамаарна.
Network Patch Status — объект дараах гишүүдийг агуулах ёстой:
filterType(integer) — Боломжит утгууд:0- боломжит бүх патч;1- зөвхөн Patch Inventory-д харагдах патчууд.
Sandbox Analyzer Failed Submissions — объект дараах гишүүдийг агуулах ёстой:
reportingInterval(integer) — Гишүүн заавал байна. Тайлангийн давтамжаас хамаарна.
Network Incidents — объект дараах гишүүдийг агуулах ёстой:
reportingInterval(integer) — Гишүүн заавал байна. Тайлангийн давтамжаас хамаарна.
Integrity Monitoring Activity — объект дараах гишүүдийг агуулах ёстой:
reportingInterval(integer) — Гишүүн заавал байна. Тайлангийн давтамжаас хамаарна.
Integrity Monitoring Configuration Changes — объект дараах гишүүдийг агуулах ёстой:
reportingInterval(integer) — Гишүүн заавал байна. Тайлангийн давтамжаас хамаарна.
Чухал
Дараах тайлангуудад options объектыг тохируулж болохгүй (эсвэл хоосон объект {} болгон дамжуулна): Endpoint Modules Status, Policy Compliance, Security Server Status, Endpoint Encryption Status.
Тайлагналын интервал ба давтамжийн хамаарал
Давтамж (occurrence) | reportingInterval-ийн боломжит утгууд |
|---|---|
| 2 - Цаг тутмын тайлан | 0 - Today |
| 3 - Өдөр тутмын тайлан | 0 - Today; 1 - Last day; 2 - This Week |
| 4 - Долоо хоног тутмын тайлан | 0 - Today; 1 - Last day; 2 - This Week; 3 - Last Week; 4 - This Month |
| 5 - Сар тутмын тайлан | 0 - Today; 1 - Last day; 2 - This week; 3 - Last week; 4 - This month; 5 - Last month; 6 - Last 2 months; 7 - Last 3 months; 8 - This year |
| 6 - Жил тутмын тайлан | 8 - This year; 9 - Last year |
Буцаах утга
Энэ арга нь String буцаана: үүсгэсэн тайлангийн ID.
Жишээ
Хүсэлт:
{
"params": {
"name": "My Report hourly",
"type": 1,
"targetIds": ["559bd17ab1a43d241b7b23c6", "559bd17ab1a43d241b7b23c7"],
"scheduledInfo": {
"occurrence": 2,
"interval": 4
},
"emailList": ["user@company.com", "user2@company.com"]
},
"jsonrpc": "2.0",
"method": "createReport",
"id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f"
}Хүсэлт:
{
"params": {
"name": "My Report daily",
"type": 8,
"targetIds": ["559bd17ab1a43d241b7b23c6", "559bd17ab1a43d241b7b23c7"],
"scheduledInfo": {
"occurrence": 3,
"startHour": 10,
"startMinute": 30
},
"options": {
"filterType": 1,
"antivirusOn": true,
"antivirusOff": false,
"updated": true,
"disabled": false,
"outdated": false,
"online": false,
"offline": true
}
},
"jsonrpc": "2.0",
"method": "createReport",
"id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f"
}Хариу:
{
"id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
"jsonrpc":"2.0",
"result": "563c78e2b1a43d4043d60413"
}Энэ хуудсанд гарсан нэр томъёо
- Endpoint
- Хамгаалж буй компьютер, сервер, виртуал машин
- Policy
- Хамгаалалтын тохиргооны багц; төхөөрөмж эсвэл бүлэгт оноодог
- Network
- Таны байгууллагын бүх төхөөрөмжийн жагсаалт (Inventory)
- Reports
- Тайлан; хугацаагаар илгээх боломжтой
- Incidents
- Илэрсэн халдлага, түүний алхмуудын бүртгэл (EDR/XDR)
- Sandbox Analyzer
- Сэжигтэй файлыг тусгаарлагдсан орчинд ажиллуулж шалгах
