调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	GetAlarmRuleList	要执行的操作，取值：GetAlarmRuleList。
Version	String	是	2024-05-08	API的版本，取值：2024-05-08。
AlertTypeList	Array of String	否	["brute_force"]	告警类型
HarmLevelList	Array of String	否	["high"]	危害等级列表，用于筛选对应严重程度的规则
NoticeType	String	否	hids	通知类别,目前仅 hids
PageNumber	Long	是	1	翻页页码
RuleName	String	否	异常登录	告警规则名称，支持模糊匹配；不传时不限制
SortBy	String	否	LastHeartbeatTime	排序字段
AlarmRuleIDList	Array of String	否	["64b000000000000000000001"]	告警规则 ID 列表，可通过本接口返回的 RuleID 获取；不传时不按规则 ID 筛选
PageSize	Long	是	10	每页的大小
SortOrder	String	否	Desc	排序顺序 Asc 升序排列 Desc 降序排列

返回参数

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

参数	类型	示例值	描述
Data	Array of Object	--	分页业务数据，具体元素结构见各接口响应声明
PageNumber	Long	1	当前页面
PageSize	Long	20	页面大小
TotalCount	Long	1	全部数据条数

请求示例

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

{
  "AlarmRuleIDList": [
    "64b000000000000000000001"
  ],
  "AlertTypeList": [
    "brute_force"
  ],
  "HarmLevelList": [
    "high"
  ],
  "NoticeType": "hids",
  "PageNumber": 1,
  "PageSize": 10,
  "RuleName": "异常登录",
  "SortBy": "LastHeartbeatTime",
  "SortOrder": "Desc"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120165538010234567890",
    "Action": "GetAlarmRuleList",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "Data": [
      {
        "AlertDesc": "检测到异常登录行为",
        "AlertDescUs": "Abnormal login behavior detected",
        "AlertType": "暴力破解",
        "AlertTypeUs": "brute_force",
        "HarmLevel": "high",
        "RuleCategory": "hids",
        "RuleID": "64b000000000000000000001",
        "RuleName": "异常登录",
        "RuleNameUs": "Abnormal Login"
      }
    ],
    "PageNumber": 1,
    "PageSize": 20,
    "TotalCount": 1
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	OperationDenied	Operation is denied because the specified resource is in use.	不允许的操作，请检查当前资源是否被占用
400	InvalidParameter	The specified parameter %s is invalid.	请求参数错误，请检查参数传递内容是否正确。
400	MissingParameter	The required parameter %s is missing.	请求参数缺失，请检查参数是否已正确传入。
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:35:54

这个页面对您有帮助吗？

有用

无用

云安全中心

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码