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

云安全中心

复制全文
下载 pdf
HIDS_ALARM
AddWhiteList - 添加白名单
复制全文
下载 pdf
AddWhiteList - 添加白名单

为指定告警类别创建白名单,配置匹配字段、值和资产范围;匹配字段可通过 GetWhiteListField 获取,告警 ID 可从对应告警列表获取。

调试

请求参数

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

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

AddWhiteList

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

Version
String
是

2024-05-08

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

RuleList
Array of Object
否

--

加白规则列表,与逻辑

Type
String
是

hids

白名单类别:hids:安全告警 virus:病毒查杀 rasp:应用防护 rasp_config:应用防护配置 file_monitor:文件监控

Desc
String
否

example description

描述信息

Lang
String
否

Lang

语言(从header中获取)

IsKillchain
Boolean
否

true

是否为杀伤链类型告警

MatchAlarmName
String
否

example-name

匹配的告警名称 *表示全部

MatchName
String
否

example-name

匹配配置名称 *表示全部

Range
Object
否

--

加白范围 为空时表示全局

User
String
否

User

创建用户(从token中获取)

返回参数

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

参数
类型
示例值
描述
Data
String

success

返回结果

请求示例

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

{
  "Desc": "example description",
  "IsKillchain": true,
  "MatchAlarmName": "example-name",
  "MatchName": "example-name",
  "Range": {
    "AgentIDList": [
      "agent-id-001"
    ],
    "CloudProviders": [
      "volcengine"
    ],
    "ClusterIDList": [
      "cluster-id-001"
    ],
    "LeafGroupIDs": [
      "group-id-101",
      "group-id-102"
    ],
    "TopGroupID": "group-id-001"
  },
  "RuleList": [
    {
      "MatchContent": "/usr/bin/approved-tool",
      "MatchContentList": [
        "/usr/bin/approved-tool"
      ],
      "MatchKey": "exe",
      "MatchType": 1
    }
  ],
  "Type": "hids"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120165538010234567890",
    "Action": "AddWhiteList",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "Data": "success"
  }
}

错误码

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

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