getTaskStatus
该方法通过任务ID获取指定任务的状态信息。
重要提示
此方法已更新至1.1版本。如需查看1.0版本相关信息，请参阅 本节内容 .
参数
|
参数 |
类型 |
可选 |
描述 |
|---|---|---|---|
|
|
字符串 |
否 |
要检索状态的任务ID。 |
|
|
对象 |
是 |
使用这组选项来控制请求中包含哪些信息。
要使用此参数，
|
|
|
布尔值 |
是 |
决定响应是否也包含单个子任务的信息。 提示当为多个端点创建任务时，会为每个单独端点创建一个子任务。 |
|
|
数字 |
是 |
结果页码。
默认值：
|
|
|
数字 |
是 |
指定每页返回的条目数量。
可选值：
默认值：
|
|
|
对象 |
是 |
决定响应中包含哪些子任务的信息。
使用此参数时，
|
|
|
数字 |
是 |
当包含在请求中时，此字段根据子任务当前状态决定哪些子任务被包含在请求中。 可选值：
|
|
|
字符串 |
是 |
使用时，响应仅包含在特定日期和时间之后结束的任务信息。 |
|
|
字符串 |
是 |
使用时，响应仅包含在特定日期和时间之前结束的任务信息。 |
返回值
此方法返回一个包含任务信息的对象。返回的对象包含：
-
name，任务的名称。 -
startDate，任务的开始日期。 -
status，任务的状态。可能的值：-
1- 待处理 -
2- 进行中 -
3- 已完成
-
-
type，任务的类型。可能的值：-
1- 扫描任务 -
7- 重新配置任务 -
16- 隔离任务 -
17- 从隔离恢复任务 -
9- 移除隔离任务 -
18- 移除隔离交换任务 -
14- 移除所有隔离任务 -
15- 移除所有隔离交换任务 -
10- 恢复隔离任务 -
19- 恢复隔离交换任务 -
20- 添加隔离任务
-
-
所有者，包含任务所有者以下信息的对象：-
ID，创建任务的账户ID。 -
用户名，创建任务时分配给账户的名称。
-
-
公司，执行任务的公司。该对象包含以下字段：-
ID，公司的ID。 -
名称，公司名称。
-
-
hasMoreSubtasks，一个布尔值，指示是否存在包含子任务信息的更多页面。 -
subtasks，一个包含子任务信息的对象：注意
此属性仅在
hasMoreSubtasks被赋值为true时可见。-
endpointId，任务运行的端点ID。 -
endpointName，任务运行的端点名称。 -
endpointType，任务运行的端点类型。可能取值：-
265- 该端点是从亚马逊AWS（EC2）导入的。 -
262- 此端点已正常安装BEST代理。 -
260- 该端点是从Active Directory导入的。
-
-
startDate，任务在此端点开始运行的日期和时间。注意
此属性仅在
hasMoreSubtasks被赋值为true时可见。 -
status，该特定端点任务的当前状态。可能取值：注意
此属性仅在
hasMoreSubtasks为true时可见。-
1- 待处理 -
2- 进行中 -
3- 已完成
-
-
endDate，任务在该端点停止运行的日期和时间。
-
-
totalTargetsCount- 任务运行的端点总数。
示例
请求 :
{
"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": "快速扫描 2024-03-15",
"startDate": "2024-03-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": "计算机 10-L9OWIy",
"endpointType": 262,
"startDate": "2024-03-15T17:45:13",
"status": 3,
"endDate": "2024-03-15T17:55:12"
},
{
"endpointId": "660c1d628bd2f47cae59****",
"endpointName": "bdvm-虚拟机",
"endpointType": 262,
"startDate": "2024-04-03T14:16:16",
"status": 2,
"endDate": "2024-04-03T14:16:17",
"errorCode": "1",
"errorMessage": "端点客户端已与安全服务器断开连接 [1]"
}
],
"totalTargetsCount": 5
}
}
版本 1.0
参数
|
参数 |
类型 |
可选 |
描述 |
|---|---|---|---|
|
|
字符串 |
否 |
您要获取状态的任务ID。 |
返回值
此方法返回一个包含任务信息的对象。返回的对象包含以下字段：
-
name任务的名称。 -
startDate任务的开始日期。 -
status任务的状态。可能取值：-
1- 待处理 -
2- 进行中 -
3- 已完成
-
-
type任务的类型。可能取值：1- 扫描任务 -
owner包含任务所有者信息的对象，其字段如下：-
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"
}
}
}