檢測設置查詢
更新時間 2025-01-16 10:28:54
最近更新時間: 2025-01-16 10:28:54
分享文章
接口功能介紹
檢測設置查詢旨在查詢用戶對文件完整性的設置包括關鍵文件監控、監控文件設置和服務器生效范圍設置。
接口約束
此功能為收費功能。確認已經購買服務器配額，并且開啟服務器防護。如果沒有購買配額，可按照頁面提示進行購買。如果沒有開啟防護，請在服務器列表頁開啟機器防護。
URI
GET /v1/integrityProtection/config/list
路徑參數
無
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參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | String | 狀態碼 200-成功 | ||
| error | String | 返回碼CTCSSCN_000000 :成功;CTCSSCN_000001:失敗;CTCSSCN_000003：用戶未簽署協議，安全衛士系統無法正常使用;CTCSSCN_000004：鑒權錯誤;CTCSSCN_000005：用戶沒有付費版配額，功能不可用 | CTCSSCN_000000 | |
| message | String | 返回信息 | 成功 | |
| returnObj | Object | 返回對象 | map |
表 map
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| secureStatus | Boolean | 是否啟用文件變更，true:是；false:否 | true | |
| secureConfigList | Array of Strings | 關鍵文件監控 | ["/tmp/test/*.log"] | |
| excludeConfigList | Array of Strings | 監控排除設置 | [ "/tmp/test/*.log"] | |
| effectiveScope | String | 設置服務器生效范圍，ALL 全部服務器；OPTIONAL 部分服務器 | ALL | |
| agentGuidList | Array of Strings | agentGuid | ["4F6G-G8U5"] |
枚舉參數
無
請求示例
請求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
無
響應示例
{
"statusCode": "200",
"error": "CTCSSCN_000000",
"message": "查詢成功!",
"returnObj":{
"secureStatus" : true,
"secureConfigList" : ["/tmp/test/*.log"],
"excludeConfigList" : ["/tmp/test/*.log"],
"effectiveScope":"ALL",
"agentGuidList" : ["33d0ba33-3370-577b-b825-3e06","33d0ba33-3370-577b-b825-3fd5"]
}
}
狀態碼
請參考
錯誤碼
請參考
