ListWhiteLists - 获取告警白名单列表--云安全中心-火山引擎

文档中心

立即注册

导航

ListWhiteLists - 获取告警白名单列表

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

根据告警类别获取

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListWhiteLists	要执行的操作，取值：ListWhiteLists。
Version	String	是	2024-05-08	API的版本，取值：2024-05-08。
Conditions	Object	否	--	Conditions
Type	String	否	Type	告警类型 hids：主机入侵检测告警 virus:病毒扫描告警
PageNumber	Integer	是	1	翻页页码
PageSize	Integer	是	10	每页的大小
SortBy	String	否	SortBy	排序字段
SortOrder	String	否	Asc	排序顺序 Asc 升序排列 Desc 降序排列

返回参数

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

参数	类型	示例值	描述
TotalCount	Integer	100	全部数据条数
PageNumber	Integer	1	当前页面
PageSize	Integer	10	页面大小
Data	Array of Object	--	响应结果

请求示例

POST /?Action=ListWhiteLists&Version=2024-05-08&PageNumber=1&PageSize=10&SortBy=xxxx&SortOrder=Asc HTTP/1.1
Host: seccenter.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20241212T074505Z
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

{
  "Conditions": {
    "CloudProviders": [
      "volc","ali"
    ],
    "LeafGroupIDs": [
      "crl9aa73pfsdrned3gn0","crl9aa73pfsdrned3xv6"
    ],
    "Range": {
      "Hostname": "instance-host-name",
      "IP": "172.16.xx.xx",
      "IsGlobal": true,
      "ClusterArea": "cluster area",
      "ClusterName": "cluster name"
    },
    "RangeIncludeGlobal": {
      "AgentID": "i-ycwdlfegw0qbxyxxxxxx"
    },
    "TopGroupID": "crl9aa73pfsdrned3gmg",
    "UpdateTimeEnd": 1702090889,
    "UpdateTimeStart": 1702090889,
    "User": "xxxx",
    "WhiteListID": "66eac07353890101c02b3310",
    "MatchAlarmName": "*",
    "Desc": "--",
    "MatchContent": "--",
    "MatchKey": "key",
    "Name": "whitelist name"
  },
  "Type": "hids"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241212154520057202011169E6BC26",
    "Action": "ListWhiteLists",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "Desc": "--",
    "ID": "66eac07353890101c02b3310",
    "MatchAlarmName": "alarm name",
    "Name": "whitelist name",
    "Range": {
      "ClusterList": [
        {
          "ClusterID": "66eac07353890101c02b3310",
          "ClusterName": "cluster name",
          "ClusterRegion": "cn-shanghai",
          "ClusterTags": [
            "tag1","tag2"
          ]
        }
      ],
      "HostList": [
        {
          "AgentID": "i-ycwdlfegw0qbxyxxxxxx",
          "CloudProvider": "volc",
          "HostTags": [
            "tag1","tag2"
          ],
          "Hostname": "instance-host-name",
          "InnerIPList": [
            "192.168.xx.xx","192.168.xx.xx"
          ],
          "OuterIPList": [
            "101.10.xx.xx","101.10.xx.xx"
          ]
        }
      ],
      "LeafGroupIDList": [
        "66eac07353890101c02b3310"
      ],
      "SingleGroupPath": "xxxx"
    },
    "RuleList": [
      {
        "MatchContent": "match content",
        "MatchKey": "match key",
        "MatchType": 1
      }
    ],
    "UpdateTime": 1702090889,
    "User": "root"
  }
}

错误码

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

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