接口功能介绍
操作审计-审计规则列表查询接口。
接口约束
此功能为收费功能。确认已经购买服务器配额，并且开启服务器防护。如果没有购买配额，可按照页面提示进行购买。如果没有开启防护，请在服务器列表页开启机器防护。
URI
POST /v1/audit/auditRuleList//
路径参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| currentNum | 是 | Integer | 当前页码 | 1 | |
| pageSize | 是 | Integer | 每页数量 | 10 |
Query参数
无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionid | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 | |
| urlType | 是 | String | 请求地址类型。CTAPI | CTAPI | |
| Content-Type | 是 | String | Content-Type | application/json |
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| threatLevel | 否 | Integer | 威胁等级 1：低危 2：中危 3：高危 |
1 | |
| ruleName | 否 | String | 规则名,模糊查询 | ||
| ruleExpression | 否 | String | 规则正则表达式 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 状态码 200-成功 | ||
| error | String | 返回码 CTCSSCN_000000 :成功; CTCSSCN_000001:失败; CTCSSCN_000003：用户未签署协议，安全卫士系统无法正常使用; CTCSSCN_000004：鉴权错误; CTCSSCN_000005：用户没有付费版配额，功能不可用 |
CTCSSCN_000000 | |
| message | String | 返回信息 | 成功 | |
| returnObj | Object | 返回对象 | data |
表 data
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Integer | 总记录数 | 100 | |
| pageNum | Integer | 当前页 | 1 | |
| pageSize | Integer | 每页记录数 | 10 | |
| list | Array of Objects | list | list |
表 list
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ctyunUserId | String | 天翼云用户id | ||
| ruleName | String | 告警类型中文名 | ||
| ruleExpression | String | 告警类型英文名 | ||
| threatLevel | String | 威胁等级 0：低危 1：中危 2：高危 |
||
| agentGuidList | String | 服务器id集合 | ||
| hostCount | String | 同一用户，相同告警类型统计 | ||
| custName | String | 服务器名 | ||
| serverIp | String | 私有ip | ||
| pulilcIp | Object | 公网ip | ||
| agentGuid | String | 服务器id | ||
| remark | String | 备注 |
枚举参数
无
请求示例
请求url
无
请求头header
{"regionid": "100054c0416811e9a6690242ac110002","Content-Type":"application/json","urlType": "CTAPI"}
请求体body
{"id": 1,"agentGuids": "4FC0E48E-E932-C14C-6A81-C6A04ADC6B7C","ctyunUserId": "1","ruleName": "测试数据","ruleExpression": "/s","threatLevel": 1,"hostCount": 1,"ruleStatus": true,"status": false}
响应示例
{"statusCode": "200","error": "CTCSSCN_000000","message": "查询成功!","returnObj": 1}
状态码
请参考 状态码
错误码
请参考 错误码
