检测设置
更新时间 2025-12-24 17:19:20
最近更新时间: 2025-12-24 17:19:20
接口功能介绍
检测设置旨在对文件完整性的进行设置包括关键文件监控、监控文件设置和服务器生效范围设置。
接口约束
此功能为收费功能。确认已经购买服务器配额，并且开启服务器防护。如果没有购买配额，可按照页面提示进行购买。如果没有开启防护，请在服务器列表页开启机器防护。
URI
POST /v1/integrityProtection/config/setUp
路径参数 无
Query参数 无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| Content-Type | 是 | String | Content-Type | application/json |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| secureStatus | 是 | Boolean | 文件保护配置防护状态 true-开启 false-关闭 | true | |
| effectiveScope | 是 | String | 生效范围 OPTIONAL-自选机器 ALL-所有机器 | OPTIONAL | |
| agentGuidList | 否 | Array of Strings | 主机guid列表 | [] | |
| secureConfigList | 是 | Array of Objects | 保护目录 | 表 secureConfigList | |
| excludeConfigList | 否 | Array of Objects | 排除目录 | 表 excludeConfigList | |
| 表 secureConfigList |
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| filePath | 否 | String | 文件路径,字符串反转后进行base64编码,如abc，变成 cba后，用base64编码 | /path | |
| 表 excludeConfigList |
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| filePath | 否 | String | 文件路径,字符串反转后进行base64编码,如abc，变成 cba后，用base64编码 | /path |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| error | String | 返回码 | ||
| CTCSSCN_000000：成功 | ||||
| CTCSSCN_000001：失败 | ||||
| CTCSSCN_000003：用户未签署协议，安全卫士系统无法正常使用 | ||||
| CTCSSCN_000004：鉴权错误 | ||||
| CTCSSCN_000005：用户没有付费版配额，功能不可用 | CTCSSCN_000000 | |||
| message | String | 返回信息 | success | |
| returnObj | Object | 返回对象 | ||
| traceId | String | traceId | asaadasd11111 | |
| statusCode | String | 状态码 200-成功 | 200 |
枚举参数
无
请求示例
请求url
无
请求头header
{"Content-Type": "application/json"}
请求体body
{"secureStatus": "true", "effectiveScope": "OPTIONAL", "agentGuidList": [], "secureConfigList": [{"filePath": "/path"}], "excludeConfigList": [{"filePath": "/path"}]}
响应示例
{"message": "success", "traceId": "asaadasd11111", "statusCode": "200", "error": "CTCSSCN_000000", "returnObj": ""}
状态码
请参考 状态码
错误码
请参考 错误码
