接口功能介绍
防护配置列表查询
接口约束
此功能为收费功能。确认已经购买网页防篡改配额,并且开启防篡改扫描配置。如果没有购买配额,可按照页面提示进行购买。如果没有开启防护,请在服务器列表页开启机器防护
URI
POST /v1/tamperproof/config//
路径参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
currentNum | 是 | Integer | 列表当前页 | 1 | |
pageSize | 是 | Integer | 列表每页记录数 | 10 |
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
regionid | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 | |
urlType | 是 | String | 请求地址类型。CTAPI | CTAPI | |
Content-Type | 是 | String | Content-Type | application/json |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
serverIp | 否 | String | 防护服务器IP | 166.0.0.2 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | String | 状态码 200-成功 | ||
error | String | 返回码 CTCSSCN_000000:成功 CTCSSCN_000001:失败 CTCSSCN_000003:用户未签署协议,安全卫士系统无法正常使用 CTCSSCN_000004:鉴权错误 CTCSSCN_000005:用户没有付费版配额,功能不可用 |
CTCSSCN_000000 | |
message | String | 返回信息 | 成功 | |
returnObj | 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 | ||
custName | String | 防护服务器名称 | CentOS76-az1-2 | |
serverIp | String | 防护服务器IP | 166.0.0.2 | |
agentGuid | String | 服务器对应guid | F5283205-CB2C-45E6-8629-9D5DB63D3AC3 | |
serverPublicIp | String | 公网ip | ||
os | String | 操作系统 | linux | |
secureStatus | Byte | 服务器防护状态,0:关闭防护、1:开启防护 | ||
createTime | String | 创建时间 | 2022-10-17T07:47:22.000+00:00 | |
updateTime | String | 修改时间 | 2022-10-17T07:47:22.000+00:00 | |
tamperproofDirectoryConfigList | Array of Objects | tamperproofDirectoryConfigList | tamperproofDirectoryConfigList |
表 tamperproofDirectoryConfigList
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
agentGuid1 | String | 服务器对应guid | 121212121212 | |
serverIp1 | String | 服务器ip | 166.0.0.2 | |
fileType | String | 文件类型,黑名单防护/白名单排除文件类型,各类型通过"$"和"|"分割。以"$"结尾,例如:.log$ | ||
secureType | Byte | 防护类型,0:白名单、1:黑名单 | ||
secureDirectory | String | 防护目录 | /opt/backup | |
backupDirectory | String | 本地备份目录 | /opt/exclude | |
excludeDirectory | String | 排除目录 | /opt/exclude | |
excludeFile | String | 排除指定文件 | x.jsp$\ | |
createTime1 | String | 创建时间 | 2022-10-17T07:47:22.000+00:00 | |
updateTime1 | String | 修改时间 | 2022-10-17T07:47:22.000+00:00 |
枚举参数
无
请求示例
请求url
无
请求头header
{"regionid": "100054c0416811e9a6690242ac110002","Content-Type":"application/json","urlType": "CTAPI"}
请求体body
{"serverIp": "163.0.0.2",}
响应示例
{"statusCode": "200","error": "CTCSSCN_000000","message": "查询成功!","returnObj":{"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}}
状态码
请参考 状态码
错误码
请参考 错误码