GetAlarmRuleList - 获取自定义告警规则列表--云安全中心-火山引擎

文档中心

云安全中心

请输入

HIDS_ALARM

GetAlarmRuleList - 获取自定义告警规则列表

获取自定义告警规则列表

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	GetAlarmRuleList	要执行的操作，取值：GetAlarmRuleList。
Version	String	是	2024-05-08	API的版本，取值：2024-05-08。
AlertTypeList	Array of String	否	[ZJQDr oySie ubOeI]	告警类型
HarmLevelList	Array of String	否	[aITzZ UbPmE prMdf]	HarmLevelList
NoticeType	String	否	ZytND	通知类别,目前仅 hids
PageNumber	Long	是	30	翻页页码
RuleName	String	否	clXdo	RuleName
SortBy	String	否	mFght	排序字段
AlarmRuleIDList	Array of String	否	[KoxWx agwKX BndFj]	AlarmRuleIDList
PageSize	Long	是	82	每页的大小
SortOrder	String	否	rlaDZ	排序顺序 Asc 升序排列 Desc 降序排列

返回参数

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

参数	类型	示例值	描述
Data	Array of Object	--	Data
PageNumber	Long	34	当前页面
PageSize	Long	1	页面大小
TotalCount	Long	68	全部数据条数

请求示例

POST /?Action=GetAlarmRuleList&Version=2024-05-08HTTP/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": [
    "znMOe",
    "UoPAn",
    "EChZf"
  ],
  "AlertTypeList": [
    "sOLlC",
    "QCByb",
    "OzOsU"
  ],
  "HarmLevelList": [
    "VamlC",
    "QRWGo",
    "csBPq"
  ],
  "NoticeType": "zgwlP",
  "PageNumber": 70,
  "PageSize": 97,
  "RuleName": "NYrCP",
  "SortBy": "KVMAs",
  "SortOrder": "HOecf"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120165538010234567890",
    "Action": "GetAlarmRuleList",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "Data": [
      {
        "AlertDesc": "yBwNJ",
        "AlertDescUs": "HOkdi",
        "AlertType": "pCuyc",
        "AlertTypeUs": "kovkU",
        "HarmLevel": "unkOg",
        "RuleCategory": "NAnMf",
        "RuleID": "YksIJ",
        "RuleName": "HrAGT",
        "RuleNameUs": "PexdT"
      }
    ],
    "PageNumber": 94,
    "PageSize": 73,
    "TotalCount": 68
  }
}

错误码

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

状态码	错误码	错误信息	说明
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.	服务器内部错误

最近更新时间：2026.06.01 14:37:01

这个页面对您有帮助吗？

有用

无用

云安全中心

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码