接口功能介绍
检测设置旨在对文件完整性的进行设置包括关键文件监控、监控文件设置和服务器生效范围设置。
接口约束
此功能为收费功能。确认已经购买服务器配额，并且开启服务器防护。如果没有购买配额，可按照页面提示进行购买。如果没有开启防护，请在服务器列表页开启机器防护。
URI
POST /v1/integrityProtection/config/setUp
路径参数
无
Query参数
无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| userid | 是 | String | 用户id | 3416ab34d51e43bd97bc32b23ffbb443 | |
| accountid | 是 | String | 账户id | 9e471e00e1c6485192b4478c96a14254 | |
| regionid | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 | |
| accessKey | 是 | String | 鉴权公钥(安全卫士系统提供) | 18ee9b6b63e411e8b4a7186590d96509 | |
| contentMD5 | 是 | String | 参数MD5值。默认使用空字符（""）计算 | 1B2M2Y8AsgTpgAmY7PhCfg== | |
| requestDate | 是 | String | 请求时间 | Mon, 29 Aug 2022 00:59:26 UTC | |
| hmac | 是 | String | 使用HMAC算法生成信息摘要。HMAC原始信息中需要的字段：使用HMAC加密是，需要密钥和待加密消息。 1.密钥使用接口方提供的secretKey，作为加密密钥。 2.待加密消息：contentMD5、requestDate 、servicePath；三个部分通过""进行连接。连接顺序contentMD5requestDateservicePath： | mTOyK30c+4Poit2857iXCb8N7Qc= | |
| urlType | 否 | String | 请求地址类型。EOPAPI（默认），CTAPI，API | EOPAPI |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| secureStatus | 是 | Boolean | 是否启用文件变更，true:是；false:否 | true | |
| userId | 是 | String | 用户id | ||
| effectiveScope | 是 | String | 设置服务器生效范围，ALL 全部服务器；OPTIONAL 部分服务器 | ALL | |
| agentGuidList | 否 | Array of Strings | 服务器列表 | ["4F6G-G8U5"] | |
| extInfo | 否 | String | 额外信息 | ||
| id | 否 | String | 配置编号 | ||
| excludeConfigList | 否 | Array of Objects | 目录 | excludeConfigListDO | |
| secureConfigList | 否 | Array of Objects | 目录 | secureConfigListDO |
表 secureConfigListDO
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| filePath | 否 | String | 目录 |
表 excludeConfigListDO
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| filePath | 否 | String | 目录 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 状态码 200-成功 | ||
| error | String | 返回码CTCSSCN_000000 :成功;CTCSSCN_000001:失败;CTCSSCN_000003：用户未签署协议，安全卫士系统无法正常使用;CTCSSCN_000004：鉴权错误;CTCSSCN_000005：用户没有付费版配额，功能不可用 | CTCSSCN_000000 | |
| message | String | 返回信息 | 成功 | |
| returnObj | Object | 返回对象 |
枚举参数
无
请求示例
请求url
无
请求头header
{
"userid": "3416ab34d51e43bd97bc32b23ffbb443",
"accountid": "9e471e00e1c6485192b4478c96a14254",
"regionid": "100054c0416811e9a6690242ac110002",
"accessKey": "18ee9b6b63e411e8b4a7186590d96509",
"contentMD5": "1B2M2Y8AsgTpgAmY7PhCfg==",
"hmac": "mTOyK30c+4Poit2857iXCb8N7Qc=",
"requestDate": "Mon, 29 Aug 2022 00:59:26 UTC"
}
请求体body
{
"secureStatus": true,
"secureConfigList": [
{
"filePath": "bWV0c3lTXHN3b2RuaVdcOkM="
},
{
"filePath": "MjNtZXRzeVNcc3dvZG5pV1w6Qw=="
},
{
"filePath": "cmVuaW1fbml3XHJlbmltXHNkYW9sbndvRFxkbGVpaFNlXHNyZXNVXDpD"
},
{
"filePath": "dG9vci8="
}
],
"excludeConfigList": [
{
"filePath": "dHNldC9pbG5laGMvdmVkLw=="
}
],
"effectiveScope": "OPTIONAL",
"agentGuidList": [
"9247D2DE-6E21-0CA4-85EA-CCA8C62831F6",
"715E1D2D-0CFF-4603-B169-D9D9B4ED940C"
],
"id": "IPC202401300219510000000000013371",
"extInfo": null,
"userId": "c07960e2659b486e8d48ab7e6022645d"
}
响应示例
{
"statusCode": "200",
"error": "CTCSSCN_000000",
"message": "查询成功!",
"returnObj":{}
}
状态码
请参考 状态码
错误码
请参考 错误码
