查询某告警事件关联的相关告警 - ListRelatedEvents
功能介绍
查询某告警事件关联的相关告警
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/event/related-events
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| enterprise_project_id | 否 | String | 参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
| offset | 是 | Integer | 参数解释: 偏移量:指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0,最大值2000000 默认取值: 不涉及 |
| limit | 是 | Integer | 参数解释: 每页显示个数 约束限制: 必填 取值范围: 取值10-200 默认取值: 10 |
| category | 是 | String | 参数解释: 资产类别 约束限制: 不涉及 取值范围: 默认取值: host |
| event_id | 是 | String | 参数解释: 事件编号 约束限制: 必填 取值范围: 字符长度1-256位 默认取值: 不涉及 |
| occur_time | 是 | Long | 参数解释: 事件发生时间 约束限制: 不涉及 取值范围: 最小值0,最大值9223372036854775807 默认取值: 不涉及 |
请求参数
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| total_num | Integer | 参数解释: 总数 取值范围: 最小值0,最大值2147483647 |
| data_list | Array of RelatedEventInfo objects | 参数解释: 相关的告警列表 取值范围: 最小值0,最大值10 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| event_name | String | 参数解释: 事件名称 取值范围: 字符长度1-256位 |
| event_class_id | String | 参数解释: 事件分类 取值范围: |
| event_id | String | 参数解释: 事件ID 取值范围: 字符长度1-64位 |
| event_type | Integer | 参数解释: 事件类型 取值范围: |
| severity | String | 威胁等级,包含如下: |
| abstract | String | 参数解释: 告警摘要 取值范围: 字符长度0-512位 |
| event_abstract | String | 参数解释: 告警摘要 取值范围: 字符长度0-512位 |
| similiar_type | String | 参数解释: 相似类型 取值范围: 字符长度0-128位 |
| handle_method | String | 参数解释: 处理方式,已处理的告警才有 取值范围: |
| handler | String | 参数解释: 处置账号信息 取值范围: 字符长度1-256位 |
| memo | String | 参数解释: 处置备注信息 取值范围: 字符长度1-2048位 |
| handle_time | Integer | 参数解释: 处置时间,毫秒,已处理的告警才有 取值范围: 最小值0,最大值9223372036854775807 |
请求示例
无
响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求已成功 |
错误码
请参见错误码。