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

云安全中心

复制全文
下载 pdf
HIDS_ALARM
ListAlarmArchiveRecords - 获取归档记录
复制全文
下载 pdf
ListAlarmArchiveRecords - 获取归档记录

分页查询当前账户指定秒级时间范围内的告警归档记录,可按 hids、virus、rasp 或 mlp 告警类别过滤;默认按归档时间倒序返回归档文件和告警数量。

调试

请求参数

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

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

ListAlarmArchiveRecords

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

Version
String
是

2024-05-08

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

TimeEnd
Long
否

1786579199

归档时间范围终点,秒级 Unix 时间戳

TimeStart
Long
否

1786492800

归档时间范围起点,秒级 Unix 时间戳

AlarmType
String
否

hids

hids:入侵防御安全告警 virus:病毒扫描 rasp:应用防护 mlp:开发机

PageNumber
Long
是

1

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

PageSize
Long
是

20

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

SortBy
String
否

LastHeartbeatTime

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

SortOrder
String
否

Desc

排序顺序

  • Asc 升序排列
  • Desc 降序排列

返回参数

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

参数
类型
示例值
描述
TotalCount
Long

1

全部数据条数

PageNumber
Long

1

当前页面

PageSize
Long

20

页面大小

Data
Array of Object

--

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

请求示例

POST /?Action=ListAlarmArchiveRecords&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

{
  "AlarmType": "hids",
  "PageNumber": 1,
  "PageSize": 20,
  "SortBy": "LastHeartbeatTime",
  "SortOrder": "Desc",
  "TimeEnd": 1786579199,
  "TimeStart": 1786492800
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120165538010234567890",
    "Action": "ListAlarmArchiveRecords",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "Data": [
      {
        "AccountID": "account-id-001",
        "AlarmCount": 1,
        "AlarmType": "hids",
        "ArchiveTime": 1786492800,
        "FileName": "example-name"
      }
    ],
    "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.

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

500
InternalError

The request has failed due to an unknown error.

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

500
DBOperateError

The request has failed because database return error: %s

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

最近更新时间:2026.08.21 20:30:54
这个页面对您有帮助吗?
有用
有用
无用
无用