此操作用来发起HBlock日志采集。

注意
日志采集的进程不能超过10个。

请求语法

POST /rest/v1/system/logcollect HTTP/1.1
Date: date
Host: ip:port
Content-Length: length
Authorization: authorization

{
    "startTime": startTime,
    "endTime": endTime,
    "servers": [server_ID],
    "logTypes": [logTypes],
    "outputDirectory": outputDirectory
}

请求参数

参数
描述
是否必须
startTime
HBlock日志采集的起始时间。
类型：时间戳
取值：unix时间戳（UTC），精确到毫秒。默认值为HBlock日志采集结束时间2小时之前的时间点。
注意
HBlock日志采集的起始时间必须早于HBlocks日志采集的结束时间。
如果HBlock日志采集的起始时间早于HBlock初始化时间，则HBlock初始化时间为日志采集起始时间。
如果修改系统时间，可能导致日志文件的最后修改时间出现波动甚至错误。
否
endTime
HBlock日志采集的结束时间。
类型：时间戳
取值：unix时间戳（UTC），精确到毫秒。默认值为当前时间。
注意
HBlock日志采集的起始时间必须早于HBlocks日志采集的结束时间。
HBlock日志采集的结束时间必须晚于HBlock初始化时间。
日志文件的最后修改时间大于结束时间时，如果存在多个大于结束时间的同类型日志，则HBlock日志采集时间值最小的那个日志文件。
否
servers
要采集HBlock日志的服务器ID。
类型：数组
取值：可以填写多个服务器ID，以英文逗号（,）隔开。默认采集所有服务器。
否
logTypes
采集的日志类型
类型：数组
取值：
Config：配置相关的日志。
System：系统相关的日志。
Data：数据处理相关的日志（仅集群版支持）。
Coordination：内部协调服务相关的日志（仅集群版支持）。
默认采集所有类型的日志。
否
outputDirectory
HBlock日志采集后存放的目录，为绝对路径。
类型：字符串
取值：如果不指定，默认存放在被请求服务器的HBlock安装目录下。以collected_logs/hblock_logs_id_yyyyMMddHHmmss_yyyyMMddHHmmss.zip命名，其中：
id：本次日志请求的唯一标识符。
yyyyMMddHHmmss：日志采集的起始时间和结束时间，UTC+0时间。
否

响应结果

名称
描述
id
日志ID。

请求示例1

采集服务器ID为hblock_1和hblock_2、时间为2022-08-07 10:00:00到2022-08-07 22:00:00、配置和系统的相关的日志，并将日志文件存放在/mnt/storage01下。

POST /rest/v1/system/logcollect HTTP/1.1
Date: Mon, 08 Aug 2022 05:57:49 GMT
Authorization: HBlock userName:signature
Content-Length: 192
Content-Type: text/plain
Host:192.168.0.121:1443

{
    "startTime": "1659837600000",
    "endTime": "1659880800000",
    "servers": ["hblock_1","hblock_2"],
    "logTypes": ["Config","System"],
    "outputDirectory": "/mnt/storage01"
}

响应示例1

HTTP/1.1 202 Accepted 
x-hblock-request-id: 68a53a147d504d5087841192adef799e
Connection: keep-alive
Content-Length: 50
Date: Mon, 8 Aug 2022 05:57:52 GMT
Content-Type: application/json;charset=utf-8
Server: HBlock

{
    "data": {
        "id": "7889764ce31444d2b06f8c2b8201c836"
    }
}

请求示例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: text/plain
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"
    }
}