getInvestigationFileUrl — шинжилгээний даалгаврын төлөв ба татах URL авах

Энэ method-оор collectInvestigationPackage, startCommandExecutionOnEndpoint эсвэл startRetrieveInvestigationFileFromEndpoint method-оор эхлүүлсэн даалгаврын төлөвийг шалгана. Даалгавар дууссаны дараа эдгээр method-оор GravityZone-д байршуулсан investigation package, лог файл эсвэл шинжилгээний файлын татах URL-ийг мөн авч болно.

API URL: CONTROL_CENTER_APIs_ACCESS_URL/v1.0/jsonrpc/investigation.

Parameters

• targetId — Заавал; төрөл: String. collectInvestigationPackage, startRetrieveInvestigationFileFromEndpoint эсвэл startCommandExecutionOnEndpoint-оор файл эсвэл багц цуглуулалтыг өмнө нь эхлүүлсэн endpoint-ийн ID. Удирдагдаж буй endpoint-ийн хүчинтэй ID байх ёстой бөгөөд яг 24 арван зургаатын (hexadecimal) тэмдэгт агуулна.
• activityId — Заавал; төрөл: String. startRetrieveInvestigationFileFromEndpoint, collectInvestigationPackage эсвэл startCommandExecutionOnEndpoint-оос буцсан шинжилгээний үйл ажиллагааны ID. targetId-д заасан endpoint-д өмнө нь эхлүүлсэн startRetrieveInvestigationFileFromEndpoint, collectInvestigationPackage эсвэл startCommandExecutionOnEndpoint даалгаврын хүчинтэй ID байх ёстой. Яг 24 арван зургаатын тэмдэгт агуулна.

General parameters

Эдгээр нь public API-ийн бүх method-д нийтлэг хэрэглэгддэг параметрүүд юм:

• id — Заавал; төрөл: String. Хүсэлтэд танигч нэмж, түүнийг хариутай холбоно. Хүлээн авагч хариунд ижил утгыг буцаадаг тул дуудлагыг хялбар мөрдөнө. Нэмэлт шаардлага байхгүй. Жишээ: "id": "ad12cb61-52b3-4209-a87a-93a8530d91cb"
• method — Заавал; төрөл: String. Хүсэлт илгээхэд ашиглаж буй method-ийн нэр. Хүчинтэй method-ийн нэр байх ёстой. Жишээ: "method": "methodName"
• jsonrpc — Заавал; төрөл: String. Хүсэлт болон хариуны ашигладаг JSON-RPC-ийн хувилбар. Цорын ганц боломжит утга нь 2.0. Жишээ: "jsonrpc": "2.0"
• params — Заавал; төрөл: Object. Хүсэлтийн тохиргоог агуулсан объект. Нэмэлт шаардлага байхгүй. Жишээ: "params": {...}

Return value

• result — төрөл: Object. collectInvestigationPackage, startRetrieveInvestigationFileFromEndpoint эсвэл startCommandExecutionOnEndpoint даалгаврын одоогийн төлөв. Даалгавар success төлөвтэй дууссан бол файл эсвэл багцын талаарх дэлгэрэнгүй болон GravityZone-ийн төвлөрсөн хадгалалт дахь байршлыг мөн өгнө. Энэ объект дахь параметрүүдийн дэлгэрэнгүй тайлбарыг доорх result хэсгээс үзнэ үү.

Objects

result

• status — төрөл: String. collectInvestigationPackage, startCommandExecutionOnEndpoint эсвэл startRetrieveInvestigationFileFromEndpoint даалгаврын одоогийн төлөв. Боломжит утгууд:

- pending: Даалгаврыг endpoint-д оноосон боловч гүйцэтгэл хараахан эхлээгүй.
- in_progress: Файл эсвэл багцыг endpoint-оос одоо цуглуулж байна.
- to_be_retrieved: Файлыг endpoint-оос цуглуулсан боловч төвлөрсөн хадгалалтад хараахан байршуулаагүй.
- failed: Цуглуулалт эсвэл байршуулалт амжилтгүй болсон.
- success: Архив GravityZone-ийн төвлөрсөн хадгалалтад бэлэн болсон.

> Чухал: result объект энэ атрибутыг үргэлж агуулна. Бусад бүх атрибут status-ын утгаас хамааран нөхцөлтэйгээр орно.

status нь failed үед:

• errorCode — төрөл: Integer. Алдааны шалтгааныг илтгэх алдааны код. Боломжит утгууд:

- -99999: Даалгаврыг хэрэглэгч цуцалсан.
- -99998, -1002, -317, -20001, -1004 эсвэл -1005: Серверийн дотоод алдаанаас болж файл эсвэл багц агуулсан архивыг байршуулж чадаагүй.
- -99997: Даалгавар зөвшөөрөгдсөн гүйцэтгэх хугацаанаас хэтэрсэн.
- -1130 эсвэл -329: Архивын хэмжээ серверийн санах ойн хязгаараас хэтэрсэн тул файл эсвэл багц агуулсан архивыг байршуулж чадаагүй.
- -112 эсвэл -311: Хүссэн үйлдлийг гүйцэтгэхэд endpoint дээр чөлөөт дискний зай хангалтгүй байсан.
- -1003 эсвэл -330: Proxy тохиргоо буруу байсан.

> Зөвлөмж: Энэ алдаа гарвал зорилтот endpoint-ийн policy-ийн General > Agent > Settings дахь тохиргоог шалгана.
- -161: Зорилтот endpoint дээрх security agent-ийг шинэчлэх шаардлагатай тул өгөгдөл цуглуулалтыг эхлүүлж чадаагүй.

> Зөвлөмж: Эдгээр алдаа үргэлжилж, тодорхой шалтгаан, шийдэл олдохгүй бол Bitdefender Enterprise Support-тэй холбогдоно.

status нь success үед:

• url — төрөл: String. Цуглуулсан шинжилгээний файл, лог файл эсвэл investigation package агуулсан архивын бүтэн HTTPS URL.
• bucket — төрөл: String. Хадгалалтын bucket-ийн нэр.
• fileId — төрөл: String. Bucket доторх файлын танигч.

Example

Request:

{
    "jsonrpc": "2.0",
    "method": "getInvestigationFileUrl",
    "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
    "params": {
        "targetId": "559bd17ab1a43d241b7b23c6",
        "activityId": "559bd17ab1a43d241b7b23c6"
    }
}

Response:

{
    "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
    "jsonrpc": "2.0",
    "result": {
        "status": "pending"
    }
}

{
    "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
    "jsonrpc": "2.0",
    "result": {
        "status": "in_progress"
    }
}

{
    "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
    "jsonrpc": "2.0",
    "result": {
        "status": "to_be_retrieved"
    }
}

{
    "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
    "jsonrpc": "2.0",
    "result": {
        "status": "success",
        "url": "https://console-url/storage/investigationFiles/678bd17ab1a43d241b7b23d7",
        "bucket": "investigationFiles",
        "fileId": "678bd17ab1a43d241b7b23d7"
    }
}

{
    "id": "787b5e36-89a8-4353-88b9-6b7a32e9c87f",
    "jsonrpc": "2.0",
    "result": {
        "status": "failed",
        "errorCode": -99997
    }
}