You need to enable JavaScript to run this app.
文档中心
云搜索服务

云搜索服务

复制全文
下载 pdf
可观测
ListLogs - 查询日志
复制全文
下载 pdf
ListLogs - 查询日志
调用 ListLogs 接口查询实例相关的运行日志,支持按时间范围、关键字、节点、日志级别、组件、文件类型过滤。​
调试​
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
​
请求参数​
下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。​
Action string 必选 示例值:ListLogs​
要执行的操作,取值:ListLogs。​
​
Version string 必选 示例值:2023-01-01​
API的版本,取值:2023-01-01。​
​
StartTime long 可选 示例值:1712052000000​
查询起始时间,格式为 Unix 时间戳。默认为当前时间 - 15 分钟,且只允许查询最近 7 天内的数据(超出会回退默认范围)。​
​
EndTime long 可选 示例值:1712052900000​
查询结束时间,格式为 Unix 时间戳。默认为当前时间,且只允许查询最近 7 天内的数据。​
​
InstanceId string 可选 示例值:o-0080**iu98​
实例 ID:若传入则会校验该实例归属并用于日志过滤;不传则仅基于账号维度检索。​
​
NodeName string 可选 示例值:es-data-****j8ilw8-0​
节点名称。​
​
Keyword string 可选 示例值:failed​
关键词过滤,匹配日志正文。​
​
Cursor string 可选 示例值:eyJ***​
游标(翻页/续查):从上一次响应的 Cursor 获取并回传。​
​
LogLevel string 可选 示例值:INFO​
日志级别过滤,取值范围如下:TRACE、DEBUG、INFO、WARN、ERROR、FATAL。​
​
LogRole string 可选 示例值:elasticsearch​
组件角色过滤,取值范围如下:elasticsearch、kibana。默认为 elasticsearch。​
​
LogType string 可选 示例值:cluster​
日志文件类型过滤。cluster: 集群日志。 searchSlow:慢查日志。indexSlow:慢写日志。gc:GC 日志。kibana:Kibana/Dashboard 日志。​
默认为 cluster。当 LogRole = kibana 时会强制使用 Kibana。​
​
Sort string 可选 示例值:desc​
排序方式。支持:asc、desc。默认为 desc。​
​
PageSize integer 可选 示例值:100​
单次返回日志条数,取值范围:[10, 1000]。默认值为 100。超出范围会回退到默认值。​
​
​
​
返回参数​
下方仅列出本接口特有的返回参数。更多信息请参见返回结构。​
Logs object[] 示例值:-​
日志列表。​
InstanceId string 示例值:o-0080**iu98​
实例 ID。​
​
NodeName string 示例值:es-data-0080**iu98-0​
节点名称。​
​
LogTime string 示例值:2026-04-01T19:33:01+08:00​
日志时间,格式为 RFC 3339 字符串。​
​
LogLevel string 示例值:ERROR​
日志级别。​
​
Message string 示例值:[ERROR] ...​
日志正文。​
​
​
Total integer 示例值:10​
命中总数。​
​
Cursor string 示例值:eyJ***​
下一页游标。​
​
​
​
请求示例​
​
POST /?Action=ListLogs&Version=2023-01-01 HTTP/1.1​
Host: escloud.cn-beijing.volcengineapi.com​
Content-Type: application/json; charset=UTF-8​
X-Date: 20260402T124105Z​
X-Content-Sha256: 287e874e******d653b44d21e​
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20260402/cn-beijing/escloud_dev/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f​
​
{}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"RequestId": "20260402204109199056095028EE4168",​
"Action": "ListLogs",​
"Version": "2023-01-01",​
"Service": "escloud_dev",​
"Region": "cn-beijing"​
},​
"Result": {​
"Logs": [​
{​
"InstanceId": "o-0080**iu98",​
"NodeName": "es-data-0080**iu98-0",​
"LogTime": "2026-04-01T19:33:01+08:00",​
"LogLevel": "ERROR",​
"Message": "[ERROR] ..."​
}​
],​
"Total": 10,​
"Cursor": "eyJ***"​
}​
}​
​
错误码​
您可访问公共错误码,获取更多错误码信息。​
​
最近更新时间:2026.04.21 15:30:38
这个页面对您有帮助吗?
有用
有用
无用
无用