接口功能介绍
操作审计-审计规则根据id查询接口。
接口约束
此功能为收费功能。确认已经购买服务器配额，并且开启服务器防护。如果没有购买配额，可按照页面提示进行购买。如果没有开启防护，请在服务器列表页开启机器防护。
URI
GET /v1/audit/queryAuditRule/*
路径参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| id | 是 | String | id | 11212 |
Query参数
无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionid | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 | |
| urlType | 是 | String | 请求地址类型。CTAPI | CTAPI | |
| Content-Type | 是 | String | Content-Type | application/json |
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 状态码 200-成功 | ||
| error | String | 返回码 CTCSSCN_000000 :成功; CTCSSCN_000001:失败; CTCSSCN_000003：用户未签署协议，安全卫士系统无法正常使用; CTCSSCN_000004：鉴权错误; CTCSSCN_000005：用户没有付费版配额，功能不可用 |
CTCSSCN_000000 | |
| message | String | 返回信息 | 成功 | |
| returnObj | Object | 返回对象 | data |
表 data
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| id | Long | id | 111111 | |
| ctyunUserId | String | 天翼云用户id | ||
| ruleName | String | 告警类型中文名 | ||
| ruleExpression | String | 告警类型英文名 | ||
| threatLevel | String | 威胁等级 0：低危 1：中危 2：高危 |
||
| agentGuidList | String | 服务器id集合 | ||
| ruleStatus | Boolean | 规则开启状态 false：关闭 true：开启 |
||
| status | Boolean | 规则删除状态 false：未删除 true已删除 |
||
| hostCount | String | 同一用户，相同告警类型统计 | ||
| custName | String | 服务器名 | ||
| serverIp | String | 私有ip | ||
| pulilcIp | String | 公网ip | ||
| agentGuid | String | 服务器id | ||
| remark | String | 备注 | ||
| hostsDtoList | Array of Objects | 主机信息 | hostsDto |
表 hostsDto
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| custName | String | 服务器名 | ||
| privateIp | String | 私有ip | ||
| pulilcIp | String | 公网ip | ||
| agentGuid | String | 服务器id | ||
| osType | String | 系统类型linux/windows |
枚举参数
无
请求示例
请求url
无
请求头header
{"regionid": "100054c0416811e9a6690242ac110002","Content-Type":"application/json","urlType": "CTAPI"}
请求体body
无
响应示例
{"statusCode": "200","error": "CTCSSCN_000000","message": "查询成功!","returnObj":{"id": 1,"custName": null,"serverIp": null,"pulilcIp": null,"agentGuid": null,"agentGuids": null,"agentGuidList": ["4FC0E48E-E932-C14C-6A81-C6A04ADC6B7C","F0111FE1-A07A-1B03-3B1D-2BDD3064D149"],"hostsDtoList": [{"custName": "win2012-az1-2","agentGuid": "6910579D-1477-4966-AD0B-E9CDF52D1E0B","privateIp": "192.168.0.207","osType": "linux","publicIp": null}],"ctyunUserId": "1","ruleName": "清理痕迹.设置操作命令不记录进日志.g","ruleExpression": "unset\s*HIST(ORY|FILE|SAVE|ZONE|LOG)","threatLevel": 2,"hostCount": -1,"ruleStatus": true,"status": false,"createTime": "2022-10-09T07:26:45.000+00:00","updateTime": "2022-10-08T23:30:34.000+00:00"}}
状态码
请参考 状态码
错误码
请参考 错误码
