AddWhiteList - 添加白名单--云安全中心-火山引擎

文档中心

立即注册

导航

云安全中心

AddWhiteList - 添加白名单

最近更新时间：2025.04.03 10:57:06首次发布时间：2025.04.03 10:57:06

根据告警类别获取

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	AddWhiteList	要执行的操作，取值：AddWhiteList。
Version	String	是	2024-05-08	API的版本，取值：2024-05-08。
Desc	String	否	Desc	描述信息
IsKillchain	Boolean	否	true	是否为杀伤链类型告警
Lang	String	否	Lang	语言（从header中获取）
MatchAlarmName	String	否	MatchAlarmName	匹配的告警名称 *表示全部
Range	Object	否	--	加白范围为空时表示全局
RuleList	Array of Object	否	--	加白规则列表，与逻辑
Type	String	否	Type	告警类别：hids:安全告警 viru病毒查杀
User	String	否	User	创建用户（从token中获取）

返回参数

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

参数	类型	示例值	描述
Data	String	ok	返回结果

请求示例

POST /?Action=AddWhiteList&Version=2024-05-08 HTTP/1.1
Host: seccenter.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241212T031929Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20241212/cn-beijing/seccenter/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "Desc": "xxxx",
  "IsKillchain": true,
  "Lang": "xxxx",
  "MatchAlarmName": "*",
  "Range": {
    "AgentIDList": [
      "i-ycwdlfegw0qbxyxxxxxx","i-ycwdlfegw1qbxyxxxxxx"
    ],
    "CloudProviders": [
      "volc","ali"
    ],
    "ClusterIDList": [
      "66eac07353890101c02b3310"
    ],
    "LeafGroupIDs": [
      "crl9aa73pfsdrned3gn0","crl9aa73pfsdrned3xv6"
    ],
    "TopGroupID": "crl9aa73pfsdrned3gmg"
  },
  "RuleList": [
    {
      "MatchContent": "xxxx",
      "MatchKey": "xxxx",
      "MatchType": 1
    }
  ],
  "Type": "hids",
  "User": "xxxx"
}

返回示例

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

错误码

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

状态码	错误码	错误信息	说明
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	数据库操作异常