Updated on 2026-09-24 GMT+08:00

Querying Details About an Alarm Whitelist

Function

This API is used to query alarm whitelist details.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, no identity policy-based permission required for calling this API.

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID, which is used to specify the project that an asset belongs to. After the project ID is configured, you can query assets in the project using the project ID. For details about how to obtain it, see Obtaining a Project ID. Constraints N/A Range The value can contain 1 to 256 characters. Default Value N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
enterprise_project_id	No	String	Definition Enterprise project ID, which is used to filter assets in different enterprise projects. For details, see Obtaining an Enterprise Project ID. To query assets in all enterprise projects, set this parameter to all_granted_eps. Constraints You need to set this parameter only after the enterprise project function is enabled. Range The value can contain 1 to 256 characters. Default Value 0: default enterprise project.
rule_id	Yes	String	Definition Rule ID. Constraints Mandatory. Range The value can contain 1 to 36 characters. Default Value N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token, which contains user identity and permissions. The token can be used for identity authentication when an API is called. For details about how to obtain the token, see Obtaining a User Token. Constraints N/A Range The value can contain 1 to 32,768 characters. Default Value N/A
region	No	String	Definition Region ID, which is used to query assets in the required region. For details about how to obtain a region ID, see Obtaining a Region ID. Constraints N/A Range The value can contain 1 to 128 characters. Default Value N/A

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
rule_id	String	Definition Rule ID. Range The value can contain 1 to 36 characters.
scope	Boolean	Definition Whether to select all servers. Range true: yes false: no
agent_ids	Array of strings	Definition Agent list Range 1 to 1000 agent IDs
instance_ids	Array of strings	Definition Instance ID list. Range 1 to 1000 instance IDs

Example Requests

Query details about an alarm whitelist.

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

Example Responses

Status code: 200

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

Status Codes

Status Code	Description
200	Request succeeded.

Error Codes

See Error Codes.

Parent Topic: Intrusion detection