此操作用来发起HBlock日志采集。
注意
目前仅支持10个日志采集任务，超过10个将不能采集新日志。
系统中有正在进行的采集任务，不能执行新的采集任务。
每次采集的日志文件大小不超过5 GiB。
日志信息以服务器的系统时间为准进行记录。时间被调整，或集群中服务器时间不统一，都可能导致日志信息不准确，但用户数据不会受影响。
请求语法
POST /rest/v1/system/logcollect HTTP/1.1
Date: date
Host: ip:port
Content-Length: length
Authorization: authorization
{
"startTime": startTime,
"endTime": endTime,
"servers": [
serverId1,
serverId2,
…,
serverIdN
],
"logTypes": [ logTypes ],
"services": [
service1,
service2,
…,
serviceN
],
"outputDirectory": outputDirectory
}请求参数
| 参数 | 类型 | 描述 | 是否必须 |
|---|---|---|---|
| startTime | String | HBlock日志采集的起始时间。 取值：unix时间戳（UTC），精确到毫秒。默认值为HBlock日志采集结束时间2小时之前的时间点。 注意
| 否 |
| endTime | String | HBlock日志采集的结束时间。 取值：unix时间戳（UTC），精确到毫秒。默认值为当前时间。 注意
| 否 |
| servers | Array of String | 要采集HBlock日志的服务器ID。 取值：可以填写多个服务器ID，以英文逗号（,）隔开。默认采集所有服务器。 | 否 |
| logTypes | Array of String | 采集的日志类型 取值：
默认采集所有类型的日志。 | 否 |
| services | Array of string | 待采集的服务，一次可以指定多个服务，以英文逗号（,）分开。 说明 只有采集类型包含Service时，此参数才有效。 取值：
默认采集所有服务的日志。 | |
| outputDirectory | String | HBlock日志采集后存放的目录，为绝对路径。 取值：如果不指定，默认存放在被请求服务器的HBlock安装目录下。以collected_logs/hblock_logs_id_yyyyMMddHHmmss_yyyyMMddHHmmss.zip命名，其中：
| 否 |
响应结果
| 名称 | 类型 | 描述 |
|---|---|---|
| id | String | 日志ID。 |
请求示例1
采集服务器ID为hblock_1和hblock_2、时间为2026-06-11 10:00:00到2026-06-12 22:00:00、配置、系统和服务的相关的日志，并将日志文件存放在/mnt/storage01下。
POST /rest/v1/system/logcollect HTTP/1.1
Date: Mon, 15 Jun 2026 02:19:57 GMT
Authorization: HBlock userName:signature
Content-Length: 320
Content-Type: application/json
Host: 192.168.0.65:1443
{
"startTime": "1781172000000",
"endTime": "1781301600000",
"servers": [
"hblock_1",
"hblock_3"
],
"logTypes": [
"Config",
"System",
"Service"
],
"services": [
"ps",
"ag"
],
"outputDirectory": "/mnt/storage01"
}响应示例1
HTTP/1.1 202 Accepted
x-hblock-request-id: e27d4df6bf3749888950361eabe835e5
Connection: keep-alive
Content-Length: 50
Date: Mon, 15 Jun 2026 02:19:58 GMT
Content-Type: application/json;charset=utf-8
Server: HBlock
{
"data": {
"id": "f9257600e3c640c9889baedb370572f1"
}
}请求示例2
采集HBlock最近两个小时所有服务器上所有类型的日志，并将日志文件存放在/mnt/storage01下。
POST /rest/v1/system/logcollect HTTP/1.1
Date: Mon, 08 Aug 2022 06:18:12 GMT
Authorization: HBlock userName:signature
Content-Length: 45
Content-Type: application/json
Host:192.168.0.121:1443
{
"outputDirectory": "/mnt/storage01"
}响应示例2
HTTP/1.1 202 Accepted
x-hblock-request-id: f9cbe1e2e7564f00becc8903aaa7c9e6
Connection: keep-alive
Content-Length: 50
Date: Mon, 8 Aug 2022 06:18:14 GMT
Content-Type: application/json;charset=utf-8
Server: HBlock
{
"data": {
"id": "8c042a768cc74b15b74669d7ebec683c"
}
}
