getTaskStatus — даалгаврын төлөв авах
Энэ хуудсыг AI-аар орчуулж, автоматаар шалгасан. Нарийн тохиргоо хийхээсээ өмнө англи эхтэй тулгаж болно.
Энэ арга нь ID-аар нь тодорхойлсон тухайн даалгаврын төлөвийн талаарх мэдээллийг авна.
Параметрүүд
- `taskId` — Төрөл: String; Заавал: Тийм; Төлөвийг нь авах гэж буй даалгаврын ID.
- `options` — Төрөл: Object; Заавал биш; Хүсэлтэд ямар мэдээлэл орохыг удирдах сонголтуудын багц. Энэ параметрийг ашиглахын тулд хүсэлтэд
returnSubtasksорсон байх баtrueутгатай байх ёстой. - `returnSubtasks` — Төрөл: Boolean; Заавал биш; Хариунд тус тусын дэд даалгаврын (subtask) мэдээлэл орох эсэхийг тодорхойлно. Зөвлөмж: даалгавар олон endpoint-д зориулж үүсгэгдэх үед endpoint бүрт дэд даалгавар үүснэ.
- `page` — Төрөл: Number; Заавал биш; Үр дүнгийн хуудасны дугаар. Анхдагч утга:
1. - `perPage` — Төрөл: Number; Заавал биш; Нэг хуудсанд буцаах зүйлийн тоо. Боломжит утгууд:
1-1000. Анхдагч утга:30. - `subtaskFilters` — Төрөл: Object; Заавал биш; Хариунд аль дэд даалгаврын мэдээлэл орохыг тодорхойлно. Энэ параметрийг ашиглахын тулд хүсэлтэд
returnSubtasksорсон байх баtrueутгатай байх ёстой. - `status` — Төрөл: Number; Заавал биш; Хүсэлтэд орсон үед одоогийн төлвөөр нь аль дэд даалгавруудыг хариунд оруулахыг тодорхойлно. Боломжит утгууд:
- 0 - Pending
- 1 - Processing
- 2 - Stopped (Failed)
- 3 - Processed (Finished)
- 4 - Retrying
- 5 - Stopped by user
- 6 - Downloading
- Тэмдэглэл: Эдгээр утга зөвхөн 1.1 хувилбарт боломжтой.
- `endedAfter` — Төрөл: String; Заавал биш; Ашигласан үед хариунд зөвхөн тодорхой огноо, цагаас хойш дууссан даалгавруудын мэдээлэл орно.
- `endedBefore` — Төрөл: String; Заавал биш; Ашигласан үед хариунд зөвхөн тодорхой огноо, цагаас өмнө дууссан даалгавруудын мэдээлэл орно.
Буцаах утга
Энэ арга нь даалгавруудын мэдээллийг агуулсан Object буцаана. Буцаах объект дараахыг агуулна:
name, даалгаврын нэр.
startDate, даалгавар эхэлсэн огноо.
status, даалгаврын төлөв. Боломжит утгууд:
- 1 - Pending
- 2 - In progress
- 3 - Finished
type, даалгаврын төрөл. Боломжит утгууд:
- 1 - Scan task.
- 7 - Reconfigure task
- 16 - Isolate task
- 17 - Restore from isolation task
- 9 - Remove quarantine task
- 18 - Remove quarantine exchange task
- 14 - Remove all quarantine task
- 15 - Remove all quarantine exchange task
- 10 - Restore quarantine task
- 19 - Restore quarantine exchange task
- 20 - Add quarantine task
owner, даалгаврын эзний тухай дараах мэдээллийг агуулсан Object:
- id, даалгаврыг үүсгэсэн дансны ID.
- userName, даалгаврыг үүсгэсэн дансанд өгсөн нэр.
company, даалгавар гүйцэтгэгдсэн компани. Объект дараах талбаруудтай:
- id, компанийн ID.
- name, компанийн нэр.
hasMoreSubtasks, дэд даалгаврын мэдээлэл агуулсан өөр хуудас байгаа эсэхийг заасан Boolean.
subtasks, дэд даалгавруудын мэдээллийг агуулсан Object:
> Тэмдэглэл: Энэ шинж чанар зөвхөн hasMoreSubtasks нь true утгатай үед харагдана.
- endpointId, даалгавар ажилласан endpoint-ийн ID.
- endpointName, даалгавар ажилласан endpoint-ийн нэр.
- endpointType, даалгавар ажилласан endpoint-ийн төрөл. Боломжит утгууд:
- 265 - Endpoint нь Amazon AWS (EC2)-аас импортлогдсон.
- 262 - Bitdefender агент энэ endpoint дээр энгийнээр суулгагдсан.
- 260 - Endpoint нь Active Directory-оос импортлогдсон.
- startDate, даалгавар энэ endpoint дээр ажиллаж эхэлсэн огноо, цаг.
> Тэмдэглэл: Энэ шинж чанар зөвхөн hasMoreSubtasks нь true утгатай үед харагдана.
- status, энэ endpoint дахь даалгаврын одоогийн төлвийг заасан бүхэл тоо. Боломжит утгууд:
- 0 - Pending
- 1 - Processing
- 2 - Stopped (Failed)
- 3 - Processed (Finished)
- 4 - Retrying
- 5 - Stopped by user
- 6 - Downloading
> Тэмдэглэл: Энэ шинж чанар зөвхөн hasMoreSubtasks нь true утгатай үед харагдана.
>
> Эдгээр утга зөвхөн 1.1 хувилбарт боломжтой.
- s3FileLocation - клиентийн S3 bucket-д байршуулсан архивын харьцангуй объект түлхүүрийг (<companyId>/<endpointId>/<filename>) заасан тэмдэгт мөр.
Зөвхөн storageType: 3 ашиглан runGatherLogsTask-аар эхлүүлсэн, алдаа засах лог цуглуулах даалгавар дууссан (status нь 3) үед буцна.
Дэлгэрэнгүйг доорх жишээнүүд болон runGatherLogsTask-аас үзнэ үү.
- endDate, даалгавар энэ endpoint дээр ажиллаж дууссан огноо, цаг.
- subTaskId, string, дэд даалгаврын өвөрмөц тодорхойлогч. Буцаасан дэд даалгавар бүрт байна.
- scanType, number, шалгалтын төрлийн тодорхойлогч. Зөвхөн шалгалтын даалгаварт байна. Шалгалт биш даалгаварт орхигдоно.
Боломжит утгууд:
- 257 - Quick Scan
- 258 - Full Scan
- 259 - Custom Scan
- 260 - Network Scan
- 517 - Memory Scan
- 518 - Yara Scan
totalTargetsCount- даалгавар ажилласан endpoint-уудын нийт тоо.
runGatherLogsTask зэрэг аргууд ганц endpoint-ийг зорилтот болгодог бол бусад төрлийн даалгавар (жишээ нь network scan) нэг эцэг даалгавар дор олон endpoint-ийг зорилтот болгож болно.- Ганц endpoint-ийн даалгаварт (жишээ нь
runGatherLogsTask) гүйцэтгэлийг шалгаж, s3FileLocation зэрэг дэлгэрэнгүйг авахын тулд "returnSubtasks": true-тэй Жишээ 1-ийг ашиглана.- Олон endpoint-ийн даалгаварт дэд даалгавруудаар хуудаслаж, төлөв эсвэл дууссан хугацаагаар шүүхийн тулд Жишээ 2-г ашиглана.
Жишээ 1 - Энгийн хүсэлт
storageType: 3 буюу өөрийн S3 хадгалалттай runGatherLogsTask-аар үүсгэсэн лог цуглуулах даалгаварт options параметрт "returnSubtasks": true гэж тохируулна.
Дэд даалгаврын status нь 3 (Finished) болоход s3FileLocation шинж чанар нь таны тохируулсан S3 bucket доторх архивын харьцангуй объект түлхүүрийг (<companyId>/<endpointId>/<filename>) өгнө.
Хүсэлт
{
"params": {
"taskId": "6ac788334821a5c67403b232",
"options": {
"returnSubtasks": true
}
},
"jsonrpc": "2.0",
"method": "getTaskStatus",
"id": "7d2864e9-c67b-48a2-9ba3-0a11d47e83c"
}Хариу
{
"id": "7d2864e9-c67b-48a2-9ba3-0a11d47e83c",
"jsonrpc": "2.0",
"result": {
"name": "Gather Existing Logs 2026-10-08",
"startDate": "2026-10-08T11:39:12",
"status": 3,
"type": 28,
"owner": {
"id": "6a3a824660761c7dc703c2a1",
"userName": "user@example.com"
},
"company": {
"id": "6a3a824660761c7dc703c222",
"name": "Bitdefender"
},
"hasMoreSubtasks": false,
"subtasks": [
{
"subTaskId": "6a6a0cad638779f96c07020",
"endpointId": "6a70aa3f48c6aa0a644d690",
"endpointName": "ubuntu-test-vm",
"endpointType": 1,
"startDate": "2026-10-08T11:39:12",
"status": 3,
"endDate": "2026-10-08T11:42:05",
"s3FileLocation":
"6a3a824660761c7dc703c222/6a70aa3f48c6aa0a644d690f/ST_ubuntu-test-vm_2026_10_08_11_39.tar.gz"
}
],
"totalTargetsCount": 1
}
}Жишээ 2 - Дэд даалгавар ба шүүлтүүртэй дэвшилтэт хүсэлт
Хүсэлт
{
"params": {
"taskId" : "65f46d08c6d2865b32048ba3",
"options": {
"returnSubtasks": true,
"page":5,
"perPage": 1
},
"subtaskFilters": {
"status": 3,
"endedAfter": "2024-03-14T19:45:10",
"endedBefore": "2024-03-16T19:45:00"
}
},
"jsonrpc": "2.0",
"method": "getTaskStatus",
"id": "7d2864e9-c67b-48a2-9ba3-0a11d47e83c8"
}Хариу
{
"id": "7d2864e9-c67b-48a2-9ba3-0a11d47e83c8",
"jsonrpc": "2.0",
"result": {
"name": "Quick Scan 2026-08-15",
"startDate": "2026-08-15T17:45:13",
"status": 3,
"type": 1,
"owner": {
"id": "65f17fcddb53ec33e302****",
"userName": "owner@example.email.com"
},
"company": {
"id": "65f17fcddb53ec33e30****",
"name": "Bitdefender"
},
"hasMoreSubtasks": false,
"subtasks": [
{
"endpointId": "65f466d8c9dd23034805****",
"endpointName": "Computer 10-L9OWIy",
"endpointType": 262,
"startDate": "2024-03-15T17:45:13",
"status": 3,
"taskId": "6a4f93e3cca158e0810050a0",
"endDate": "2024-03-15T17:55:12",
"subTaskId": "683ee75b6c9598ab03098f93",
"scanType": 257
},
{
"endpointId": "660c1d628bd2f47cae59****",
"endpointName": "bdvm-virtual-machine",
"endpointType": 262,
"startDate": "2026-08-15T14:16:16",
"status": 2,
"subTaskId": "6a4f93e3cca158e0810050a0",
"endDate": "2026-08-15T14:16:17",
"errorCode": "1",
"errorMessage": "Endpoint client has lost connection with Security Server [1]"
}
],
"totalTargetsCount": 5
}
}Хувилбар 1.0
Параметрүүд
- `taskId` — Төрөл: String; Заавал: Тийм; Төлөвийг нь авах гэж буй даалгаврын ID.
Буцаах утга
Энэ арга нь даалгавруудын мэдээллийг агуулсан Object буцаана. Буцаах объект дараахыг агуулна:
name, даалгаврын нэр.
startDate, даалгавар эхэлсэн огноо.
status, даалгаврын төлөв. Боломжит утгууд:
- 1 - Pending
- 2 - In progress
- 3 - Finished
type, даалгаврын төрөл. Боломжит утгууд:1- Scan task.
owner, даалгаврын эзний тухай дараах мэдээллийг агуулсан Object:
- id, даалгаврыг үүсгэсэн дансны ID.
- userName, даалгаврыг үүсгэсэн дансанд өгсөн нэр.
company, даалгавар гүйцэтгэгдсэн компани. Объект дараах талбаруудтай:
- id, компанийн ID.
- name, компанийн нэр.
Жишээ
Хүсэлт
{
"params": {
"taskId": "21a295eeb1a43d8b497b23b7"
},
"jsonrpc": "2.0",
"method": "getTaskStatus",
"id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f"
}Хариу
{
"id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
"jsonrpc": "2.0",
"result": {
"name": "task",
"startDate": "2023-10-27T12:08:42",
"status": 1,
"type": 1,
"owner": {
"id": "21a295eeb1a43d8b497b23ba",
"userName": "owner@example.email.com"
},
"company": {
"id": "21a295eeb1a43d8b497b23bb",
"name": "Example"
}
}
}Энэ хуудсанд гарсан нэр томъёо
- Endpoint
- Хамгаалж буй компьютер, сервер, виртуал машин
- Network
- Таны байгууллагын бүх төхөөрөмжийн жагсаалт (Inventory)
- Quarantine
- Хорио: сэжигтэй файлыг тусгаарлаж хадгалдаг газар
