文档中心

云安全中心

请输入

HIDS_AGENT

ListCleanHistory - 查询清理记录

分页查询 Agent 清理任务历史，支持按任务 ID、执行状态和创建时间过滤，用于跟踪清理结果；任务 ID 可从清理任务或本接口结果获取，时间字段为秒级 Unix 时间戳。

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	ListCleanHistory	要执行的操作，取值：ListCleanHistory。
Version	String	是	2024-05-08	API的版本，取值：2024-05-08。
SortOrder	String	否	Desc	排序顺序 Asc 升序排列 Desc 降序排列
PageNumber	Long	是	1	翻页页码，取值范围为 1 及以上
PageSize	Long	是	20	每页记录数，取值范围为 1~5000
SortBy	String	否	LastHeartbeatTime	排序字段；不传时使用接口默认排序
Tags	Array of String	否	["production"]	Tags 列表；不传时不按该字段筛选
CloudProviders	Array of String	否	["cloud-providers-id-001"]	CloudProviders 列表；不传时不按该字段筛选
Regions	Array of String	否	["cn-beijing"]	Regions 列表；不传时不按该字段筛选
Platforms	Array of String	否	["linux"]	Platforms 列表；不传时不按该字段筛选
LeafGroupIDs	Array of String	否	["group-id-001","group-id-002"]	叶子分组 ID 列表，可从多级分组查询接口获取；不传时不按分组筛选
Hostname	String	否	host-001	HostName 名称
AgentId	String	否	agent-id-001	HostId 标识值，可从对应资源列表接口获取
Ip	String	否	192.0.2.10	主机 IP 地址

返回参数

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

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

请求示例

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

{
  "AgentId": "agent-id-001",
  "CloudProviders": [
    "cloud-providers-id-001"
  ],
  "Hostname": "host-001",
  "Ip": "192.0.2.10",
  "LeafGroupIDs": [
    "group-id-001",
    "group-id-002"
  ],
  "PageNumber": 1,
  "PageSize": 20,
  "Platforms": [
    "linux"
  ],
  "Regions": [
    "cn-beijing"
  ],
  "SortBy": "LastHeartbeatTime",
  "SortOrder": "Desc",
  "Tags": [
    "production"
  ]
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20241120165538010234567890",
    "Action": "ListCleanHistory",
    "Version": "2024-05-08",
    "Service": "seccenter",
    "Region": "cn-beijing"
  },
  "Result": {
    "Data": [
      {
        "CleanTime": 1786579200,
        "CloudProvider": "volcengine",
        "GroupName": "example-name",
        "HostId": "host-id-001",
        "HostName": "host-001",
        "OfflineTime": 1786492800,
        "Platform": "linux",
        "PrivateIP": "192.0.2.10",
        "PublicIP": "192.0.2.10",
        "Region": "cn-beijing",
        "Tags": [
          "production"
        ],
        "VpcId": "vpc-id-001"
      }
    ],
    "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.08.21 20:30:49

这个页面对您有帮助吗？

有用

无用

云安全中心

调试 #

请求参数 #

返回参数 #

请求示例 #

返回示例 #

错误码 #

调试

请求参数

返回参数

请求示例

返回示例

错误码