runGatherLogsTask аргаар endpoint-оос лог цуглуулах даалгавар үүсгэх

Энэ аргыг ашиглан онлайн endpoint-оос оношилгооны лог цуглуулах даалгавар үүсгэнэ. Даалгавар нь зорилтот endpoint-оос лог файлуудыг авч, заасан хадгалалтын тохиргооны дагуу endpoint дээр локалаар, сүлжээний хавтас (network share) дээр эсвэл S3-тэй нийцтэй bucket-д хадгална.

Лог цуглуулах талаар дэлгэрэнгүйг Endpoint-ийн дэлгэрэнгүй мэдээллийг харах хуудасны Troubleshooting tab хэсгээс үзнэ үү.

Хэрэв үр дүнг S3 bucket (AWS) руу байршуулахаар сонговол AWS үүлэн платформоо урьдчилан тохируулсан байх шаардлагатай. Алхам алхмаар заавартай Live Search, runLiveSearchQuery болон runGatherLogsTask-д зориулж AWS тохируулах хуудсыг үзнэ үү.

Параметрүүд

• endpointId — Лог цуглуулах зорилтот endpoint-ийн ID; Хүсэлтэд заавал; Төрөл: String; Утга: Удирдлагад буй хүчинтэй endpoint ID байх ёстой.
• logType — Endpoint-ээс цуглуулах логийн төрөл; Хүсэлтэд заавал; Төрөл: Integer; Утга: 1, 2 эсвэл 3. Доорх logType утгуудыг үзнэ үү.
• storageOptions — Цуглуулсан логийг хаана хадгалахыг тодорхойлно; Хүсэлтэд заавал; Төрөл: Object; Утга: Доорх storageOptions-ийг үзнэ үү.

logType утгууд:

• 1 — Product general issues (Бүтээгдэхүүний ерөнхий асуудал). Support-tool буюу бүтээгдэхүүний оношилгооны логийг (тохиргоо, модуль, бодлого, ерөнхий саатал засалт) цуглуулна. Асуудлын шалтгаан тодорхойгүй эсвэл бүтээгдэхүүнтэй холбоотой үед ашиглана.
• 2 — Malware infection (no cloud services) (Хортой программын халдвар, үүлэн үйлчилгээгүй). Халдвар эсвэл халдлагын сэжигтэй үед BDSyslog forensic архивыг Bitdefender Cloud-тай холбогдохгүйгээр (үүлэн аюулын тагнуул, hash, DNS шалгалтгүй) цуглуулна.
• 3 — Malware infection (Хортой программын халдвар). Ижил BDSyslog forensic цуглуулалтыг аюулын тагнуулын зорилгоор Bitdefender Cloud Services идэвхтэйгээр хийнэ.

storageOptions

• storageType — Хадгалах байрлалын төрөл; Хүсэлтэд заавал; Төрөл: Integer
• localCopyPath — Логийг хадгалах endpoint дээрх локал зам; storageType-ээс хамаарна; Төрөл: String
• networkSharePath — Сүлжээний хавтасны UNC зам; Заавал (хэрэв storageType = 2); Төрөл: String
• username — Сүлжээний хавтасны нэвтрэлтийн хэрэглэгчийн нэр; Заавал (хэрэв storageType = 2); Төрөл: String
• password — Сүлжээний хавтасны нэвтрэлтийн нууц үг; Заавал (хэрэв storageType = 2); Төрөл: String
• s3UploadConfig — S3 байршуулалтын тохиргоо; Заавал (хэрэв storageType = 3); Төрөл: Object

storageType утгууд:

• 1 — Endpoint дээрх локал хадгалалт; localCopyPath: шаардлагатай.
• 2 — Сүлжээний хавтас; localCopyPath: заавал биш (зөвхөн хавтасны хувьд бол орхино).
• 3 — Өөрийн S3 bucket (AWS эсвэл OVH); localCopyPath: шаардлагатай.

s3UploadConfig

storageType = 3 үед хэрэглэнэ. Үүлэн үйлчилгээ үзүүлэгчээс хамаарч нэвтрэх хоёр горим байна.

AWS (Security Token Service - assume role):

• bucket — Өгөгдлийг хадгалах S3 bucket-ийн нэр; Заавал; Төрөл: String
• region — Bucket байрлаж буй AWS бүс; Заавал; Төрөл: String
• roleArn — Bucket-д хандахдаа GravityZone-ийн авах IAM role-ийн Amazon Resource Name (ARN); Заавал; Төрөл: String
• externalId — Role-ийн итгэлцлийн бодлогод (trust policy) заасан давтагдашгүй тодорхойлогч. Хүсэлт гаргагч IAM role-ийг авах эрхтэйг шалгаж, данс хоорондын аюулгүй хандалтыг хангахад ашиглана; Заавал; Төрөл: String

OVH (presigned PUT - access keys):

• bucket — S3-тэй нийцтэй bucket-ийн нэр; Заавал; Төрөл: String
• region — OVH бүс (жишээ нь: gra); Заавал; Төрөл: String
• accessKey — OVH S3 access key; Заавал; Төрөл: String
• secretKey — OVH S3 secret key; Заавал; Төрөл: String

Буцаах утга

• result — Хүсэлтээр үүссэн даалгаврын ID; Төрөл: String

S3 хадгалалтаас цуглуулсан логийг авах

runGatherLogsTask нь асинхрон (asynchronous) арга юм. result талбар нь эх даалгаврын ID-г буцаадаг бөгөөд үүгээр даалгаврын явцыг хянаж, байршсан архивыг олно.

1. 1Result талбарт буцсан даалгаврын ID-г хадгална.

2. 2getTaskStatus-г taskId-д энэ утгыг өгч, "options": { "returnSubtasks": true } тохируулан дуудна.

3. 3Эх даалгавар болон endpoint-ийн дэд даалгавар хоёулаа төлөв 3 (Finished) болтол даалгаврын төлөвийг шалгана.

4. 4Дууссаны дараа зорилтот дэд даалгаврын объектоос s3FileLocation шинж чанарыг уншина:

```
"subtasks": [
{
"subTaskId": "65f1d8c0b1a43d4043d60414",
"endpointId": "559bd152b1a43d291b7b23d8",
"status": 3,
"s3FileLocation": "559bd152b1a43d291b7b23c6/559bd152b1a43d291b7b23d8/ST_WS-PROD-SRV01_2026_10_13_16_20.tar.gz"
}
]
```

5. 5s3FileLocation нь таны тохируулсан S3 bucket доторх объектын харьцангуй түлхүүрийг (<companyId>/<endpointId>/<filename>) заана. Архивыг байгууллагынхаа AWS CLI, SDK эсвэл үүлэн хадгалалтын удирдлагын журмаар хандаж татаж авч болно.

getTaskStatus API аргын талаар getTaskStatus хуудсыг үзнэ үү.

Жишээ 1 - Локал хадгалалт (storageType: 1)

Хүсэлт:

{
    "jsonrpc": "2.0",
    "method": "runGatherLogsTask",
    "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
    "params": {
        "endpointId": "559bd152b1a43d291b7b23d8",
        "logType": 1,
        "storageOptions": {
            "storageType": 1,
            "localCopyPath": "C:\\Bitdefender\\SupportLogs"
        }
    }
}

Хариу:

{
    "id": "123-456-789-1011",
    "jsonrpc": "2.0",
    "result": "000000000000000000000000"
}

Жишээ 2 - Сүлжээний хавтас (storageType: 2)

Хүсэлт:

{
    "jsonrpc": "2.0",
    "method": "runGatherLogsTask",
    "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
    "params": {
        "endpointId": "559bd152b1a43d291b7b23d8",
        "logType": 2,
        "storageOptions": {
            "storageType": 2,
            "networkSharePath": "\\\\10.17.20.70\\MyShareFile",
            "username": "bdvm",
            "password": "12wq!@WQ"
        }
    }
}

Хариу:

{
    "id": "123-456-789-1011",
    "jsonrpc": "2.0",
    "result": "000000000000000000000000"
}

Локал хуулбартай (заавал биш) бол:

Хүсэлт:

{
    "jsonrpc": "2.0",
    "method": "runGatherLogsTask",
    "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
    "params": {
        "endpointId": "559bd152b1a43d291b7b23d8",
        "logType": 2,
        "storageOptions": {
            "storageType": 2,
            "networkSharePath": "\\\\10.17.20.70\\MyShareFile",
            "username": "bdvm",
            "password": "12wq!@WQ",
            "localCopyPath": "C:\\Logs"
        }
    }
}

Хариу:

{
    "id": "123-456-789-1011",
    "jsonrpc": "2.0",
    "result": "000000000000000000000000"
}

Жишээ 3 - Өөрийн S3, AWS (storageType: 3, STS)

Хүсэлт:

{
    "jsonrpc": "2.0",
    "method": "runGatherLogsTask",
    "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
    "params": {
        "endpointId": "559bd152b1a43d291b7b23d8",
        "logType": 1,
        "storageOptions": {
            "storageType": 3,
            "localCopyPath": "C:\\Logs",
            "s3UploadConfig": {
                "bucket": "my-company-logs-bucket",
                "region": "eu-west-1",
                "roleArn": "arn:aws:iam::123456789012:role/GravityZoneLogsUpload",
                "externalId": "my-external-id-12345"
            }
        }
    }
}

Хариу:

{
    "id": "123-456-789-1011",
    "jsonrpc": "2.0",
    "result": "000000000000000000000000"
}

Жишээ 4 - Өөрийн S3, OVH (storageType: 3, presigned PUT)

Хүсэлт:

{
    "jsonrpc": "2.0",
    "method": "runGatherLogsTask",
    "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
    "params": {
        "endpointId": "559bd152b1a43d291b7b23d8",
        "logType": 1,
        "storageOptions": {
            "storageType": 3,
            "localCopyPath": "C:\\Logs",
            "s3UploadConfig": {
                "bucket": "my-ovh-logs-bucket",
                "region": "gra",
                "accessKey": "my-ovh-access-key",
                "secretKey": "my-ovh-secret-key"
            }
        }
    }
}

Хариу:

{
    "id": "123-456-789-1011",
    "jsonrpc": "2.0",
    "result": "000000000000000000000000"
}