接口功能介绍
查询检测任务运行状态。
接口约束
此功能为收费功能。确认已经购买系统配额，并且开启基线扫描配置。如果没有购买配额，可按照页面提示进行购买。如果没有开启防护，请在服务器列表页开启机器防护
URI
POST /v1/sca/event/isrun/check
路径参数
无
Query参数
无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionid | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 | |
| urlType | 是 | String | 请求地址类型。CTAPI | CTAPI | |
| Content-Type | 是 | String | Content-Type | application/json |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| scaRuleId | 是 | Integer | 基线策略Id | 1 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 状态码 200-成功 | ||
| error | String | 返回码 CTCSSCN_000000：成功 CTCSSCN_000001：失败 CTCSSCN_000003：用户未签署协议，安全卫士系统无法正常使用 CTCSSCN_000004：鉴权错误 CTCSSCN_000005：用户没有付费版配额，功能不可用 |
CTCSSCN_000000 | |
| message | String | 返回信息 | 成功 | |
| returnObj | Object | 返回对象 | RefreshTaskMongoDto |
表 RefreshTaskMongoDto
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| taskId | String | 任务id | 1c6485192b4478c96a142547 | |
| policy | String | 基线策略ID | 20 | |
| agentGuid | Array of Strings | agentGuid | [ "564DE7A9-7BD2-E605-3115-BD5863BF9F1C", "72603142-5C6F-01B9-1843-52AAC2375539" ] |
|
| flag | Boolean | 检测执行是否结束 true-结束 false-未结束 | true | |
| created | String | 最后检测时间 | 2022-05-26 16:55:50 | |
| taskStatus | Integer | 检测状态 0：未执行 1：执行中 2：执行完毕 3：取消执行 4：超时取消执行 5：失败 |
1 | |
| taskStatusDesc | String | 检测状态说明 | 执行中 |
枚举参数
无
请求示例
请求url
无
请求头header
{"regionid": "100054c0416811e9a6690242ac110002","Content-Type":"application/json","urlType": "CTAPI"}
请求体body
{"scaRuleId":"230"}
响应示例
{"statusCode": "200","error": "CTCSSCN_000000","message": "查询成功!","returnObj":{"taskStatus": 2,"taskStatusDesc": "执行完毕","executionPolicy": "immediate_scan","taskId": "202205051443109e471e00e1c6485192b4478c96a142547","type": "sca","policy": 7,"osType": "Linux","execution": null,"agentGuid": ["564DE7A9-7BD2-E605-3115-BD5863BF9F1C","72603142-5C6F-01B9-1843-52AAC2375539","9AED95AE-D9CB-40A1-A8CD-895A03C1595F","B663F8A4-AEAB-4F2C-843F-DE5462AACFFC","F5283205-CB2C-45E6-8629-9D5DB63D3AC3"],"created": "2022-05-05T06:43:10.132+00:00","adminId": null,"ctyunUserId": "9e471e00e1c6485192b4478c96a14254","zoneId": 0,"flag": true,"data": null,"time": 180}}
状态码
请参考 状态码
错误码
请参考 错误码
