createReport — шуурхай эсвэл хуваарьт тайлан үүсгэх

Энэ арга нь хүлээн авсан параметрүүдийн дагуу шинэ шуурхай (instant) эсвэл хуваарьт (scheduled) тайлан үүсгэж, шинээр үүссэн тайлангийн ID-г буцаана.

Шуурхай тайлан нь API дуудлага хийх үед нэг л удаа үүсч, ажиллана.

Хуваарьт тайлан нь дараа нь үүсэж, урьдчилан тодорхойлсон хуваарийн дагуу тогтмол ажиллана.

Параметрүүд

• name — төрөл: String; заавал; тайлангийн нэр.
• type — төрөл: Number; заавал; тайлангийн төрөл. Дараах утгуудын аль нэгийг дамжуулж болно:

- 1 - Antiphishing Activity
- 2 - Blocked Applications
- 3 - Blocked Websites
- 4 - Customer Status Overview
- 5 - Data Protection
- 6 - Device Control Activity
- 7 - Endpoint Modules Status
- 8 - Endpoint Protection Status
- 9 - Firewall Activity
- 10 - License Status
- 12 - Malware Status
- 13 - Monthly License Usage
- 14 - Network Status
- 15 - On demand scanning
- 16 - Policy Compliance
- 17 - Security Audit
- 18 - Security Server Status
- 19 - Top 10 Detected Malware
- 20 - Top 10 Infected Companies
- 21 - Top 10 Infected Endpoints
- 22 - Update Status
- 23 - Upgrade Status
- 24 - AWS Monthly Usage
- 30 - Endpoint Encryption Status
- 31 - HyperDetect Activity
- 32 - Network Patch Status
- 33 - Sandbox Analyzer Failed Submissions
- 34 - Network Incidents
- 35 - MDR Service Status
- 36 - Integrity Monitoring Activity
- 37 - Integrity Monitoring Configuration Changes
- 38 - Mobile Security Monthly License Usage
- 39 - Data Insights License Usage
- 40 - Extended Email Security Usage

• targetIds — төрөл: Array; заавал; тайлан үүсгэх объектуудын ID-н жагсаалт. Объект нь тайлангийн төрлөөс хамаарна. Дараах тайлангуудын хувьд объект нь зөвхөн хэрэглэгчийн компанийн ID эсвэл түүний шатлал дахь хүү компаниудын ID байж болно (endpoint, бүлэг, контейнер нь хүчинтэй объект биш):

- Customer Status Overview
- License Status
- Monthly License Usage
- AWS Monthly Usage
- Top 10 Infected Companies
- MDR Service Status
- Extended Email Security Usage
- Mobile Security Monthly License Usage

Бусад тайлангийн төрлийн хувьд объектын ID нь бүлэг, компани, контейнер, endpoint зэрэг дурын төрлийнх байж болно.

• scheduledInfo — төрөл: Object; заавал биш; тайлан ажиллах хуваарийг тодорхойлох объект. Энэ параметрийг орхивол шуурхай тайлан үүснэ. Дэлгэрэнгүйг scheduledInfo объектын тайлбараас үзнэ үү.
• options — төрөл: Object; заавал биш; тайлан үүсгэх сонголтуудыг тодорхойлох объект. Дараах тайлангуудын хувьд options объектыг тохируулж болохгүй:

- Endpoint Modules Status
- License Status
- Policy Compliance
- Security Server Status
- Upgrade Status
- MDR Service Status

Дэлгэрэнгүйг options объектын тайлбараас үзнэ үү.

• emailList — төрөл: Array; заавал биш; тайланг хүргэх и-мэйл хаягуудын жагсаалт. Шуурхай тайлангийн хувьд emailList-ийг тохируулж болохгүй. Энэ параметрийг зөвхөн хүсэлтэд scheduledInfo параметр орсон үед ашиглаж болно.

Объектууд

scheduledInfo

Энэ объектыг createReport дуудлагад ашигладаг бөгөөд тайлан ямар хуваарийн дагуу ажиллахыг тодорхойлно.

Объектын гишүүдийн тоо нь тайлангийн давтамжаас (occurrence) хамаарч өөр өөр байна:

• occurrence — төрөл: integer; заавал байх гишүүн. Боломжит утгууд:

- 1 - шуурхай тайлан
> Тэмдэглэл: Энэ утга нь хүсэлтэд scheduledInfo параметр ороогүй үед л боломжтой.
- 2 - цаг тутмын тайлан
- 3 - өдөр тутмын тайлан
- 4 - долоо хоног тутмын тайлан
- 5 - сар тутмын тайлан
- 6 - жил тутмын тайлан

13 - Monthly License Usage болон 24 - AWS Monthly Usage тайлангийн хувьд зөвхөн 4 - weekly report (долоо хоног тутмын) болон 5 - monthly report (сар тутмын) утгууд боломжтой.

40 - Extended Email Security Usage болон 38 - Mobile Security Monthly License Usage тайлангийн хувьд зөвхөн 5 - monthly report (сар тутмын) болон 6 - yearly report (жил тутмын) утгууд боломжтой.

• 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 дуудлагад ашигладаг бөгөөд тайлангийн төрлөөс хамаарч гишүүдийн тоо өөр өөр байна:

• Antiphishing Activity

Объект нь дараах гишүүдийг агуулсан байх ёстой:

- reportingInterval — төрөл: integer; заавал байх гишүүн. Энэ утга нь тайлангийн occurrence-ээс хамаарна. Дэлгэрэнгүйг Тайлангийн интервал ба давтамжийн хамаарал-аас үзнэ үү.
- filterType — төрөл: integer; заавал байх гишүүн. Боломжит утгууд:
- 0 - All endpoints
- 1 - Only endpoints with blocked websites

• Blocked Applications

Объект нь дараах гишүүдийг агуулсан байх ёстой:

- reportingInterval — төрөл: integer; заавал байх гишүүн. Энэ утга нь тайлангийн occurrence-ээс хамаарна. Дэлгэрэнгүйг Тайлангийн интервал ба давтамжийн хамаарал-аас үзнэ үү.

• Blocked Websites

Объект нь дараах гишүүдийг агуулсан байх ёстой:

- reportingInterval — төрөл: integer; заавал байх гишүүн. Энэ утга нь тайлангийн occurrence-ээс хамаарна. Дэлгэрэнгүйг Тайлангийн интервал ба давтамжийн хамаарал-аас үзнэ үү.
- filterType — төрөл: integer; заавал байх гишүүн. Боломжит утгууд:
- 0 - All endpoints
- 1 - Only endpoints with blocked websites

• Data Protection

Объект нь дараах гишүүдийг агуулсан байх ёстой:

- reportingInterval — төрөл: integer; заавал байх гишүүн. Энэ утга нь тайлангийн occurrence-ээс хамаарна. Дэлгэрэнгүйг Тайлангийн интервал ба давтамжийн хамаарал-аас үзнэ үү.
- filterType — төрөл: integer; заавал байх гишүүн. Боломжит утгууд:
- 0 - All endpoints
- 1 - Only managed computers with blocked threats
- blockedEmails — төрөл: boolean; зөвхөн filterType-ийн утга 1 үед тохируулна. Боломжит утгууд: True, False.
- blockedWebsites — төрөл: boolean; зөвхөн filterType-ийн утга 1 үед тохируулна. Боломжит утгууд: True, False.

• Device Control Activity

Объект нь дараах гишүүдийг агуулсан байх ёстой:

- reportingInterval — төрөл: integer; заавал байх гишүүн. Энэ утга нь тайлангийн occurrence-ээс хамаарна. Дэлгэрэнгүйг Тайлангийн интервал ба давтамжийн хамаарал-аас үзнэ үү.

• Endpoint Protection Status

Объект нь дараах гишүүдийг агуулсан байх ёстой:

- filterType — төрөл: integer; заавал байх гишүүн. Боломжит утгууд:
- 0 - All endpoints
- 1 - Only endpoints filtered by the members described hereinafter.
- antivirusOn — төрөл: boolean; зөвхөн filterType-ийн утга 1 үед тохируулна. Боломжит утгууд:
- True — вирусээс хамгаалалт (antimalware) идэвхтэй endpoint-уудыг тайланд оруулна.
- False — вирусээс хамгаалалт идэвхтэй endpoint-уудыг тайлангаас хасна.
- antivirusOff — төрөл: boolean; зөвхөн filterType-ийн утга 1 үед тохируулна. Боломжит утгууд:
- True — вирусээс хамгаалалт идэвхгүй endpoint-уудыг тайланд оруулна.
- False — вирусээс хамгаалалт идэвхгүй 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; заавал байх гишүүн. Энэ утга нь тайлангийн occurrence-ээс хамаарна. Дэлгэрэнгүйг Тайлангийн интервал ба давтамжийн хамаарал-аас үзнэ үү.
- filterType — төрөл: integer; заавал байх гишүүн. Боломжит утгууд:
- 0 - All endpoints
- 1 - Only endpoints with the following blocked threats: traffic attempts and port scans.
- trafficAttempts — төрөл: boolean; зөвхөн filterType-ийн утга 1 үед тохируулна. Боломжит утгууд:
- True — блоклогдсон порт шалгалттай (port scan) endpoint-уудыг тайланд оруулна.
- False — блоклогдсон порт шалгалттай endpoint-уудыг тайлангаас хасна.

• Malware Status

Объект нь дараах гишүүдийг агуулсан байх ёстой:

- reportingInterval — төрөл: integer; заавал байх гишүүн. Энэ утга нь тайлангийн occurrence-ээс хамаарна. Дэлгэрэнгүйг Тайлангийн интервал ба давтамжийн хамаарал-аас үзнэ үү.
- filterType — төрөл: integer; заавал байх гишүүн. Боломжит утгууд:
- 0 - All endpoints
- 1 - Only endpoints still infected
- detailedExport — төрөл: array; заавал биш гишүүн. Боломжит утга:
- 1 - Include Endpoint Malware Status in PDF file

• Monthly License Usage

Объект нь дараах гишүүдийг агуулсан байх ёстой:

- reportingInterval — төрөл: integer; заавал байх гишүүн. Энэ утга нь тайлангийн occurrence-ээс хамаарна. Дэлгэрэнгүйг Тайлангийн интервал ба давтамжийн хамаарал-аас үзнэ үү.
- skipSummary — төрөл: boolean; заавал биш гишүүн. Monthly License Usage тайлангийн (type = 13) CSV файлд Summary хэсэг орох эсэхийг тодорхойлох сонголт. Анхдагчаар False байх бөгөөд CSV файлд Summary орно гэсэн үг.

• AWS Monthly Usage

Объект нь дараах гишүүдийг агуулсан байх ёстой:

- reportingInterval — төрөл: integer; заавал байх гишүүн. Энэ утга нь тайлангийн occurrence-ээс хамаарна. Дэлгэрэнгүйг Тайлангийн интервал ба давтамжийн хамаарал-аас үзнэ үү.

• Network Status

Объект нь дараах гишүүдийг агуулсан байх ёстой:

- filterType — төрөл: integer; заавал байх гишүүн. Боломжит утгууд:
- 0 - All endpoints
- 1 - Only endpoints with issues
- 2 - Only endpoints with unknown status

• On demand scanning

Объект нь дараах гишүүдийг агуулсан байх ёстой:

- reportingInterval — төрөл: integer; заавал байх гишүүн. Энэ утга нь тайлангийн occurrence-ээс хамаарна. Дэлгэрэнгүйг Тайлангийн интервал ба давтамжийн хамаарал-аас үзнэ үү.

• Security Audit

Объект нь дараах гишүүдийг агуулсан байх ёстой:

- reportingInterval — төрөл: integer; заавал байх гишүүн. Энэ утга нь тайлангийн occurrence-ээс хамаарна. Дэлгэрэнгүйг Тайлангийн интервал ба давтамжийн хамаарал-аас үзнэ үү.

• Top 10 Detected Malware

Объект нь дараах гишүүдийг агуулсан байх ёстой:

- reportingInterval — төрөл: integer; заавал байх гишүүн. Энэ утга нь тайлангийн occurrence-ээс хамаарна. Дэлгэрэнгүйг Тайлангийн интервал ба давтамжийн хамаарал-аас үзнэ үү.

• Top 10 Infected Endpoints

Объект нь дараах гишүүдийг агуулсан байх ёстой:

- reportingInterval — төрөл: integer; заавал байх гишүүн. Энэ утга нь тайлангийн occurrence-ээс хамаарна. Дэлгэрэнгүйг Тайлангийн интервал ба давтамжийн хамаарал-аас үзнэ үү.

• Update Status

Объект нь дараах гишүүдийг агуулсан байх ёстой:

- updated — төрөл: boolean. Боломжит утгууд:
- True — шинэчлэгдсэн endpoint-уудыг тайланд оруулна.
- False — шинэчлэгдсэн endpoint-уудыг тайлангаас хасна.
- disabled — төрөл: boolean. Боломжит утгууд:
- True — шинэчлэлт идэвхгүй болгосон endpoint-уудыг тайланд оруулна.
- False — шинэчлэлт идэвхгүй болгосон endpoint-уудыг тайлангаас хасна.
- outdated — төрөл: boolean. Боломжит утгууд:
- True — хуучирсан endpoint-уудыг тайланд оруулна.
- False — хуучирсан endpoint-уудыг тайлангаас хасна.
- pendingRestart — төрөл: boolean. Боломжит утгууд:
- True — дахин асаах шаардлагатай endpoint-уудыг тайланд оруулна.
- False — дахин асаах шаардлагатай endpoint-уудыг тайлангаас хасна.

• VM Network Protection Status

Объект нь дараах гишүүдийг агуулсан байх ёстой:

- filterType — төрөл: integer; заавал байх гишүүн. Боломжит утгууд:
- 0 - All endpoints
- 1 - Only protected endpoints

• Extended Email Security Usage

Объект нь дараах гишүүдийг агуулсан байх ёстой:

- reportingInterval — төрөл: integer; заавал байх гишүүн. Энэ утга нь тайлангийн occurrence-ээс хамаарна. Дэлгэрэнгүйг Тайлангийн интервал ба давтамжийн хамаарал-аас үзнэ үү.

• HyperDetect Activity

Объект нь дараах гишүүдийг агуулсан байх ёстой:

- reportingInterval — төрөл: integer; заавал байх гишүүн. Энэ утга нь тайлангийн occurrence-ээс хамаарна. Дэлгэрэнгүйг Тайлангийн интервал ба давтамжийн хамаарал-аас үзнэ үү.

• Network Patch Status

Объект нь дараах гишүүдийг агуулсан байх ёстой:

- filterType — төрөл: integer. Боломжит утгууд:
- 0 - All available patches
- 1 - Only patches visible in Patch Inventory

• Sandbox Analyzer Failed Submissions

Объект нь дараах гишүүдийг агуулсан байх ёстой:

- reportingInterval — төрөл: integer; заавал байх гишүүн. Энэ утга нь тайлангийн occurrence-ээс хамаарна. Дэлгэрэнгүйг Тайлангийн интервал ба давтамжийн хамаарал-аас үзнэ үү.

• Network Incidents

Объект нь дараах гишүүдийг агуулсан байх ёстой:

- reportingInterval — төрөл: integer; заавал байх гишүүн. Энэ утга нь тайлангийн occurrence-ээс хамаарна. Дэлгэрэнгүйг Тайлангийн интервал ба давтамжийн хамаарал-аас үзнэ үү.

• Integrity Monitoring Activity

Объект нь дараах гишүүдийг агуулсан байх ёстой:

- reportingInterval — төрөл: integer; заавал байх гишүүн. Энэ утга нь тайлангийн occurrence-ээс хамаарна. Дэлгэрэнгүйг Тайлангийн интервал ба давтамжийн хамаарал-аас үзнэ үү.

• Integrity Monitoring Configuration Changes

Объект нь дараах гишүүдийг агуулсан байх ёстой:

- reportingInterval — төрөл: integer; заавал байх гишүүн. Энэ утга нь тайлангийн occurrence-ээс хамаарна. Дэлгэрэнгүйг Тайлангийн интервал ба давтамжийн хамаарал-аас үзнэ үү.

Тайлангийн интервал ба давтамжийн хамаарал

• 2 - Hourly report (цаг тутмын) — reportingInterval-ийн боломжит утга: 0 - Today
• 3 - Daily report (өдөр тутмын) — боломжит утгууд: 0 - Today; 1 - Last day; 2 - This Week
• 4 - Weekly report (долоо хоног тутмын) — боломжит утгууд: 0 - Today; 1 - Last day; 2 - This Week; 3 - Last Week; 4 - This Month. 13 - Monthly License Usage, 24 - AWS Monthly Usage болон 29 - Email Security Usage тайлангийн хувьд зөвхөн 4 - This Month утга боломжтой.
• 5 - Monthly report (сар тутмын) — боломжит утгууд: 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. 13 - Monthly License Usage болон 24 - AWS Monthly Usage тайлангийн хувьд зөвхөн 4 - weekly report болон 5 - monthly report. утгууд боломжтой. 29 - Email Security Usage тайлангийн хувьд зөвхөн 5 - monthly report болон 6 - yearly report утгууд боломжтой.
• 6 - Yearly report (жил тутмын) — боломжит утгууд: 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"
  }