文档首页/ 企业主机安全 HSS/ API参考/ API说明/ event/ 查询告警白名单生详情 - ListAlarmWhiteListHostDetail
更新时间：2026-08-10 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询告警白名单生详情 - ListAlarmWhiteListHostDetail

功能介绍

查询告警白名单生详情

调用方法

请参见如何调用API。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，当前API调用无需身份策略权限。

URI

GET /v5/{project_id}/event/white-list/rule/detail

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及
表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

否

String

参数解释:

企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0，表示默认企业项目（default）。

rule_id

是

String

参数解释：

规则ID

约束限制：

必填

取值范围：

字符长度1-36位

默认取值：

不涉及

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

region

否

String

参数解释:

区域ID，用于查询目的区域内的资产。获取方式请参见获取区域ID。

约束限制:

不涉及

取值范围:

字符长度1-128位

默认取值:

不涉及

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

rule_id

String

参数解释：

规则ID

取值范围：

字符长度1-36位

scope

Boolean

参数解释:

是否选择所有主机

取值范围:

  • true：是

  • false：否

agent_ids

Array of strings

参数解释:

agent列表

取值范围:

1-1000个agentID

instance_ids

Array of strings

参数解释:

实例ID列表

取值范围:

1-1000个实例ID

请求示例

查询告警白名单生详情

GET https://{endpoint}/v5/{project_id}/event/white-list/rule/detail?rule_id=a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6

响应示例

状态码：200

请求已成功

{
  "rule_id" : "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
  "scope" : false,
  "agent_ids" : [ "bdcb6303b37c61342792f186e38d580b4b073e0024864019eaf982f30c9384db" ],
  "instance_ids" : [ ]
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码。

父主题： event

相关文档