You need to enable JavaScript to run this app.
文档中心
云安全中心

云安全中心

复制全文
下载 pdf
HIDS_ALARM
ListHidsAlarms - 获取告警列表
复制全文
下载 pdf
ListHidsAlarms - 获取告警列表

分页查询当前账户的主机入侵安全告警,支持按发生时间、处理状态、告警级别、告警类别、资产及分组等条件筛选,用于安全事件分析和处置;筛选条件均不传时查询全部可见告警。

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数
类型
是否必填
示例值
描述
Action
String
是

ListHidsAlarms

要执行的操作,取值:ListHidsAlarms。

Version
String
是

2024-05-08

API的版本,取值:2024-05-08。

AlarmHandleResultList
Array of Long
否

[0,3,25]

处理结果 0 :未处理 1:已人工处理 3:端上处理中 4:端上处理成功 5:端上处理失败 11:已加白 12:已终止 13:已自动拦截 14:已隔离 15:隔离中 16:隔离失败 17:删除中 18:删除失败 19:已删除 20:终止中 21:终止失败 22: 已封禁 23: 已解除封禁 24:已自动封禁 25:封禁失败

ContainerID
String
否

container-id-001

容器 ID,可从容器资产列表获取

ContainerName
String
否

example-name

容器名

VirusType
String
否

Webshell

病毒或恶意文件分类,按 class 字段模糊匹配,例如 Webshell

LeafGroupIDs
Array of String
否

["group-id-101","group-id-102"]

叶子分组 ID 列表,可通过多级分组查询接口获取;不传时不限制叶子分组

AgentGroup
String
否

production-hosts

单个主机主机分组

CloudProviders
Array of String
否

["volcengine"]

云厂商

ImageName
String
否

example-name

镜像名

Status
Array of Long
否

[0,1]

处理状态;0未处理 1已处理

AgentGroupList
Array of String
否

["production"]

主机分组列表

MlpInstanceID
String
否

mlp-instance-id-001

MLP 开发机实例 ID,可从开发机资产列表获取

AlarmID
String
否

64b000000000000000000002

告警 ID,可从对应告警列表获取

LevelList
Array of String
否

["critical","high"]

告警级别 critical;high;low;medium

TopGroupID
String
否

group-id-001

根分组 ID,可通过多级分组查询接口获取;不传时不限制根分组

AgentID
String
否

agent-id-001

主机 Agent ID,可从主机资产列表获取

AgentIDList
Array of String
否

["agent-id-001"]

agent id 列表

AgentTags
Array of String
否

["production"]

主机标签列表

AlertTags
Array of String
否

["production"]

告警标签

ClusterID
String
否

cluster-id-001

集群 ID,容器集群防护告警专用,可从容器集群列表获取

LastAlarmTimeStart
Long
否

1786492800

最近一次告警时间范围起点,秒级 Unix 时间戳

ClusterName
String
否

example-name

集群名称;容器集群防护告警专用

ClusterRegion
String
否

cn-beijing

集群区域;容器集群防护告警专用

ClusterTags
Array of String
否

["production"]

集群标签列表;容器集群防护告警专用

DataType
String
否

4000

告警数据类型代码,例如 59、602、4000;具体代码来自告警规则或告警详情的 DataType

EventID
String
否

event-id-001

从属安全事件 ID,可从告警列表或告警详情获取

EventName
String
否

example-name

从属事件名称

EventReason
String
否

example description

归因逻辑

Exe
String
否

/var/log/example

二进制文件名搜索

FileHash
String
否

d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2

文件哈希(MD5);病毒扫描告警专用

FilePath
String
否

/var/log/example.log

文件路径;病毒扫描告警专用

Hostname
String
否

host-001

主机名称

IP
String
否

192.0.2.10

IP(内外网) 模糊搜索

Name
String
否

异常登录

搜索rule_name 模糊搜索

ProbeHook
String
否

java.lang.Runtime.exec

探针采集点;应用运行时防护专用

RaspArgv
String
否

ls -la

参数;应用运行时防护专用

TaskID
String
否

task-id-001

病毒扫描任务ID(用于查询扫描任务关联告警);病毒扫描告警专用

TimeEnd
Long
否

1761209000

告警发生时间范围终点,秒级 Unix 时间戳

TimeStart
Long
否

1761208000

告警发生时间范围起点,秒级 Unix 时间戳

LastAlarmTimeEnd
Long
否

1786579199

最近一次告警时间范围终点,秒级 Unix 时间戳

Type
Array of String
否

["credential_access"]

告警类别英文,可传 bruteforce、privilege_escalation、persistent、evasion、purpose、static_scan、killchain、initial_access、execution、credential_access、discovery、collection、lateral_movement、command_control、exfiltration、custom、Code Execution、Abnormal File Read/Write、Abnormal Network Connect、Path Traversal、Abnormal Behavior Sequence、Abnormal Runtime Behavior、SQL Injection、algorithm_killchain 或 precision_defense,可从告警详情中获取得到

WhiteListID
String
否

64b000000000000000000001

关联白名单 ID,可从告警白名单列表获取

WhiteListName
String
否

example-name

关联白名单名称

PageNumber
Long
是

1

翻页页码,取值范围为 1 及以上

PageSize
Long
是

20

每页记录数,取值范围为 1~5000

SortBy
String
否

LastHeartbeatTime

排序字段;不传时使用接口默认排序

SortOrder
String
否

Desc

排序顺序

  • Asc 升序排列
  • Desc 降序排列
OperationList
Array of String
否

["write"]

文件操作列表

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数
类型
示例值
描述
TotalCount
Long

1

全部数据条数

PageNumber
Long

1

当前页面

PageSize
Long

20

页面大小

Data
Array of Object

--

分页业务数据,具体元素结构见各接口响应声明

请求示例

POST /?Action=ListHidsAlarms&Version=2024-05-08 HTTP/1.1
Host: seccenter.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241120T080538Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241120/cn-beijing/seccenter/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "AgentGroup": "production-hosts",
  "AgentGroupList": [
    "production"
  ],
  "AgentID": "agent-id-001",
  "AgentIDList": [
    "agent-id-001"
  ],
  "AgentTags": [
    "production"
  ],
  "AlarmHandleResultList": [
    0,
    3,
    25
  ],
  "AlarmID": "64b000000000000000000002",
  "AlertTags": [
    "production"
  ],
  "CloudProviders": [
    "volcengine"
  ],
  "ClusterID": "cluster-id-001",
  "ClusterName": "example-name",
  "ClusterRegion": "cn-beijing",
  "ClusterTags": [
    "production"
  ],
  "ContainerID": "container-id-001",
  "ContainerName": "example-name",
  "DataType": "4000",
  "EventID": "event-id-001",
  "EventName": "example-name",
  "EventReason": "example description",
  "Exe": "/var/log/example",
  "FileHash": "d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2",
  "FilePath": "/var/log/example.log",
  "Hostname": "host-001",
  "IP": "192.0.2.10",
  "ImageName": "example-name",
  "LastAlarmTimeEnd": 1786579199,
  "LastAlarmTimeStart": 1786492800,
  "LeafGroupIDs": [
    "group-id-101",
    "group-id-102"
  ],
  "LevelList": [
    "critical",
    "high"
  ],
  "MlpInstanceID": "mlp-instance-id-001",
  "Name": "异常登录",
  "OperationList": [
    "write"
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "ProbeHook": "java.lang.Runtime.exec",
  "RaspArgv": "ls -la",
  "SortBy": "LastHeartbeatTime",
  "SortOrder": "Desc",
  "Status": [
    0,
    1
  ],
  "TaskID": "task-id-001",
  "TimeEnd": 1761209000,
  "TimeStart": 1761208000,
  "TopGroupID": "group-id-001",
  "Type": [
    "credential_access"
  ],
  "VirusType": "Webshell",
  "WhiteListID": "64b000000000000000000001",
  "WhiteListName": "example-name"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120165538010234567890",
    "Action": "ListHidsAlarms",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "Data": [
      {
        "AgentGroup": "production-hosts",
        "AgentID": "agent-id-001",
        "AlarmCount": 1,
        "AlarmHandleResult": 11,
        "AlarmHostname": "host-001",
        "AlarmID": "alarm-id-001",
        "AlarmTime": 1761208351,
        "AlertTags": [
          "已处理"
        ],
        "AnalysisRecordUUID": "sec_intel_risk_analysis_alarm-id-001",
        "Args": [
          "RASP"
        ],
        "ArgsList": [
          "RASP"
        ],
        "ArgvList": [
          "java -jar app.jar"
        ],
        "AttributionList": [
          {
            "Type": "USER",
            "Value": "value"
          }
        ],
        "Class": "Webshell",
        "Cluster": {
          "ClusterArea": "cn-beijing",
          "ClusterID": "cluster-id-001",
          "ClusterName": "example-name",
          "ClusterTags": [
            "production"
          ],
          "RuleType1st": "default",
          "RuleType2nd": "default"
        },
        "Confidence": "8",
        "DataType": "601",
        "ErrorReason": "example description",
        "EventID": "event-id-001",
        "EventName": "example-name",
        "Exe": "/usr/bin/bash",
        "FileDownloadable": true,
        "FileHash": "d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2",
        "FilePath": "/var/log/example.log",
        "GroupPath": "/未分组",
        "HandleFailReason": "example description",
        "HandleTime": 1764640425,
        "Host": {
          "AgentID": "agent-id-001",
          "AgentTags": [
            "production"
          ],
          "Hostname": "host-001",
          "InnerIPList": [
            "192.0.2.10"
          ],
          "OuterIPList": [
            "192.0.2.10"
          ]
        },
        "ImageName": "example-name",
        "InDocker": "true",
        "LLMAnalysisResult": "success",
        "LLMProcessed": true,
        "LastAlarmTime": 1786579199,
        "Level": "high",
        "MlpInstanceID": "instance-id-001",
        "MlpPrivateIP": "192.0.2.10",
        "Name": "可疑代理程序",
        "NsPid": "ns-pid-id-001",
        "OperationList": [
          "write"
        ],
        "OsType": "linux",
        "Pid": "32754",
        "ProbeHook": "java.lang.Runtime.exec",
        "Region": "cn-shanghai",
        "SecurityIntelligenceComplete": true,
        "SecurityIntelligenceError": "model service unavailable",
        "SecurityIntelligenceResult": "FALSE",
        "SecurityIntelligenceStatus": "PENDING",
        "Sid": "sid-id-001",
        "StackTraceFormat": "RASP",
        "StackTraceHash": "d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2",
        "Status": 1,
        "TraceID": "trace_alarm-id-001",
        "Type": "command_control"
      }
    ],
    "PageNumber": 1,
    "PageSize": 20,
    "TotalCount": 1
  }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
MissingParameter

The required parameter %s is missing.

请求参数缺失,请检查参数是否已正确传入。

400
InvalidParameter

The specified parameter %s is invalid.

请求参数错误,请检查参数传递内容是否正确。

400
OperationDenied

Operation is denied because the specified resource is in use.

不允许的操作,请检查当前资源是否被占用。

403
OperationDenied.TenantUnauthorized(%s)

The request has failed due to tenant not found(%s)

未授权的租户操作

500
InternalError

The request has failed due to an unknown error.

服务器内部错误,请稍后重试或联系技术支持。

500
DBOperateError

The request has failed because database return error: %s

数据库操作异常,请稍后重试或联系技术支持。

最近更新时间:2026.10.30 14:06:18
这个页面对您有帮助吗?
有用
有用
无用
无用