接口功能介绍
防护配置列表查询
接口约束
此功能为收费功能。请您确认已经购买网页防篡改配额,并且开启防护。如果没有购买配额,可按照页面提示进行购买。如果没有开启防护,请在服务器列表页开启防护。
URI
POST /v1/tamperproof/config/{currentNum}/{pageSize}
路径参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
currentNum | 是 | Integer | 列表当前页 | 1 | |
pageSize | 是 | Integer | 列表每页记录数 | 10 |
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
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;三个部分通过"\n"进行连接。连接顺序contentMD5\nrequestDate\nservicePath: | mTOyK30c+4Poit2857iXCb8N7Qc= | |
urlType | 否 | String | 请求地址类型。EOPAPI(默认),CTAPI,API | EOPAPI |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
serverIp | 是 | String | 防护服务器IP | 166.0.0.2 |
响应参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
code | 是 | String | 返回码。取值范围: 0:成功。 -1:失败。 -3:用户未签署协议,安全卫士系统无法正常使用。 -4:鉴权错误。 -5:用户没有付费版配额,功能不可用。 | 0 | |
message | 是 | String | 返回信息 | 成功 | |
data | 是 | Object | 返回对象 | pageinfo |
表pageInfo
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
pageNum | 是 | Integer | 当前页 | 1 | |
pageSize | 是 | Integer | 每页记录数 | 10 | |
pages | 是 | Integer | 总页数 | 2 | |
total | 是 | Integer | 总记录数 | 20 | |
isFirstPage | 是 | boolean | 是否为首页 | false | |
isLastPage | 是 | boolean | 是否为末页 | false | |
list | 是 | Object | 列表 | list |
表list
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
id | 是 | Integer | 配置数据id | 1 | |
custName | 是 | String | 服务器名称 | CentOS76-az1-2 | |
agentGuid | 是 | String | 服务器id | F5283205-CB2C-45E6-8629-9D5DB63D3AC3 | |
serverIp | 是 | String | 服务器ip | 172.18.208.172 | |
serverPublicIp | 否 | String | 公网ip | ||
os | 是 | String | 服务器系统类型 | linux | |
secureStatus | 是 | Byte | 服务器防护状态,0:关闭防护、1:开启防护 | 1 | |
createTime | 是 | Date | 创建时间 | 2022-10-17T07:47:22.000+00:00 | |
updateTime | 是 | Date | 修改时间 | 2022-10-17T07:47:22.000+00:00 | |
tamperproofDirectoryConfigList | 是 | List | tamperproofDirectoryConfigList |
表tamperproofDirectoryConfigList
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
agentGuid | 是 | String | 服务器对应guid | 121212121212 | |
serverIp | 是 | String | 服务器ip | 166.0.0.2 | |
fileType | 是 | String | 文件类型,黑名单防护/白名单排除文件类型,各类型通过 | 分割,以结尾,例如:.log$ | ||
secureType | 是 | Byte | 防护类型,0:白名单、1:黑名单 | 0 | |
secureDirectory | 是 | String | 防护目录 | /opt/project | |
backupDirectory | 是 | String | 本地备份目录 | /opt/backup | |
excludeDirectory | 是 | String | 排除目录 | /opt/exclude | |
excludeFile | 是 | String | 排除指定文件 | x.jsp\|x.png | |
createTime | 是 | Date | 创建时间 | 2022-10-17T07:47:22.000+00:00 | |
updateTime | 是 | Date | 修改时间 | 2022-10-17T07:47:22.000+00:00 |
请求示例
请求头header
{
"regionid": "100054c0416811e9a6690242ac110002",
"accessKey": "18ee9b6b63e411e8b4a7186590d96509",
"contentMD5": "1B2M2Y8AsgTpgAmY7PhCfg==",
"hmac": "mTOyK30c+4Poit2857iXCb8N7Qc=",
"requestDate": "Mon, 29 Aug 2022 00:59:26 UTC"
}
请求体body
{
"serverIp": "163.0.0.2",
}
响应示例
{
"code": "0",
"message": "成功!",
"data": {
"total": 1,
"list": [
{
"id": 61,
"custName": "测试配置",
"serverIp": "166.0.0.2",
"serverPublicIp": "",
"agentGuid": "121212121212",
"ctyunUserId": "1",
"os": "linux",
"serverStatus": -1,
"secureStatus": 1,
"autoRepair": 0,
"createTime": "2022-10-17T07:47:22.000+00:00",
"updateTime": "2022-10-17T07:47:22.000+00:00",
"tamperproofDirectoryConfigList": [
{
"id": 42,
"serverIp": "166.0.0.2",
"agentGuid": "121212121212",
"secureType": 0,
"fileType": ".jpeg$",
"secureDirectory": "/opt/project",
"backupDirectory": "/opt/backup",
"excludeDirectory": "/opt/exclude",
"excludeFile": "x.jsp$|x.png$|x.gif$",
"distributeStatus": null,
"createTime": "2022-10-17T07:47:22.000+00:00",
"updateTime": "2022-10-17T07:47:22.000+00:00"
},
{
"id": 43,
"serverIp": "166.0.0.2",
"guid": "121212121212",
"agentGuid": "121212121212",
"secureType": 1,
"fileType": ".jpeg$|.jsp$|.png$|.gif$",
"secureDirectory": "/opt/project1",
"backupDirectory": "/opt/backup1",
"excludeDirectory": "/opt/exclude1|/opt/exclude2",
"excludeFile": "xxx.jsp$",
"distributeStatus": null,
"createTime": "2022-10-17T07:47:22.000+00:00",
"updateTime": "2022-10-17T07:47:22.000+00:00"
}
],
"quotaId": "2",
"quotaStatus": 2
}
],
"pageNum": 1,
"pageSize": 10,
"size": 1,
"startRow": 1,
"endRow": 1,
"pages": 1,
"prePage": 0,
"nextPage": 0,
"isFirstPage": true,
"isLastPage": true,
"hasPreviousPage": false,
"hasNextPage": false,
"navigatePages": 8,
"navigatepageNums": [
1
],
"navigateFirstPage": 1,
"navigateLastPage": 1
}
}
状态码
状态码 | 描述 |
200 | 表示请求成功。 |
错误码
请参考错误码说明。