调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListWhiteLists	要执行的操作，取值：ListWhiteLists。
Version	String	是	2024-05-08	API的版本，取值：2024-05-08。
PageSize	Long	是	20	每页记录数，取值范围为 1~1000
SortBy	String	否	LastHeartbeatTime	排序字段。支持取值：match_key（匹配字段）、match_type（匹配方式）、match_content（匹配值）、match_alarm_name（关联告警）、range_type（范围类型）、white_rule_name（规则名称）、insert_time（创建时间）、update_time（更新时间）、_id。未指定时默认 update_time（更新时间）倒序。
SortOrder	String	否	Desc	排序顺序 Asc 升序排列 Desc 降序排列
Type	String	是	hids	白名单类别：hids:安全告警 virus:病毒查杀 rasp:应用防护 rasp_config:应用防护配置 file_monitor:文件监控
Conditions	Object	否	--	白名单筛选条件；不传或条件均为空时查询全部可见白名单
PageNumber	Long	是	1	翻页页码，取值范围为 1 及以上

返回参数

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

参数	类型	示例值	描述
Data	Array of Object	--	分页业务数据，具体元素结构见各接口响应声明
PageNumber	Long	1	当前页面
PageSize	Long	20	页面大小
TotalCount	Long	1	全部数据条数

请求示例

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

{
  "Conditions": {
    "CloudProviders": [
      "volc"
    ],
    "Desc": "example description",
    "LeafGroupIDs": [
      "group-id-101",
      "group-id-102"
    ],
    "MatchAlarmName": "example-name",
    "MatchContent": "/usr/bin/approved-tool",
    "MatchKey": "exe",
    "Name": "example-name",
    "Range": {
      "ClusterArea": "cn-beijing",
      "ClusterName": "example-name",
      "Hostname": "host-001",
      "IP": "192.0.2.10",
      "IsGlobal": true
    },
    "RangeIncludeGlobal": {
      "AgentID": "agent-id-001"
    },
    "TopGroupID": "group-id-001",
    "UpdateTimeEnd": 1786579199,
    "UpdateTimeStart": 1786579199,
    "User": "user@example.com",
    "WhiteListID": "whitelist-id-001"
  },
  "PageNumber": 1,
  "PageSize": 20,
  "SortBy": "LastHeartbeatTime",
  "SortOrder": "Desc",
  "Type": "hids"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120165538010234567890",
    "Action": "ListWhiteLists",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "Data": [
      {
        "Desc": "example description",
        "ID": "resource-id-001",
        "MatchAlarmName": "example-name",
        "Name": "example-name",
        "Range": {
          "ClusterList": [
            {
              "ClusterID": "cluster-id-001",
              "ClusterName": "example-name",
              "ClusterRegion": "cn-beijing",
              "ClusterTags": [
                "production"
              ]
            }
          ],
          "HostList": [
            {
              "AgentID": "agent-id-001",
              "CloudProvider": "volcengine",
              "HostTags": [
                "production"
              ],
              "Hostname": "host-001",
              "InnerIPList": [
                "192.0.2.10"
              ],
              "OuterIPList": [
                "192.0.2.10"
              ]
            }
          ],
          "LeafGroupIDList": [
            "leaf-group-id-001"
          ],
          "SingleGroupPath": "/production/web"
        },
        "RuleList": [
          {
            "MatchContent": "/usr/bin/approved-tool",
            "MatchContentList": [
              "/usr/bin/approved-tool"
            ],
            "MatchKey": "exe",
            "MatchType": 1
          }
        ],
        "UpdateTime": 1786579199,
        "User": "user@example.com"
      }
    ],
    "PageNumber": 1,
    "PageSize": 20,
    "TotalCount": 1
  }
}

错误码

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

状态码	错误码	错误信息	说明
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:18

这个页面对您有帮助吗？

有用

无用

云安全中心

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码