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

云安全中心

复制全文
下载 pdf
HIDS_ALARM
ListAlarmTags - 获取标签列表
复制全文
下载 pdf
ListAlarmTags - 获取标签列表

查询指定告警类型下当前账户可用的内置与自定义告警标签;AlarmType 用于选择告警数据源,TopGroupID 不传时查询全部可见分组,告警 ID 可从对应告警列表获取。

调试

请求参数

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

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

ListAlarmTags

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

Version
String
是

2024-05-08

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

TopGroupID
String
否

group-id-001

根分组 ID,可从多级分组查询接口获取;标签查询时不传则不限制分组,标签更新时当前不参与处理

AlarmIDList.N
Array of String
否

["alarm-id-001"]

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

AlarmType
String
否

hids

告警类型 hids:安全告警 virus:病毒查杀 rasp:应用防护

AlertTags.N
Array of String
否

["真实入侵"]

标签列表;更新接口中不传或为空时清空告警标签

返回参数

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

参数
类型
示例值
描述
Data
Array of String

["已人工处理","误报","真实入侵"]

当前语言下的内置标签与符合条件的自定义告警标签列表

请求示例

GET /?Action=ListAlarmTags&Version=2024-05-08&AlarmIDList.N=["alarm-id-001"]&AlarmType=hids&AlertTags.N=["真实入侵"]&TopGroupID=group-id-001 HTTP/1.1
Host: seccenter.volcengineapi.com
X-Date: 20241120T080538Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241120/cn-beijing/seccenter/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f


返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120165538010234567890",
    "Action": "ListAlarmTags",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "Data": [
      "已人工处理",
      "误报",
      "真实入侵"
    ]
  }
}

错误码

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

状态码
错误码
错误信息
说明
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.10.30 14:06:19
这个页面对您有帮助吗?
有用
有用
无用
无用