ListSearchLog - 查看实例日志-检索分析服务 Elasticsearch版(ES)-阿里云帮助中心

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

elasticsearch:ListSearchLogs

get

*Instance

acs:elasticsearch:{#regionId}:{#accountId}:instances/{#instancesId}

无

请求语法

GET /openapi/instances/{InstanceId}/search-log HTTP/1.1

路径参数

名称	类型	必填	描述	示例值
InstanceId	string	是	实例 ID。	es-cn-n6w1o1x0w001c****

请求参数

名称	类型	必填	描述	示例值
type	string	是	日志类型。可选值： INSTANCELOG：主日志。 SEARCHSLOW：searching 慢日志。 INDEXINGSLOW：indexing 慢日志。 JVMLOG：GC 日志。 ES_SEARCH_ACCESS_LOG：ES 访问日志。 AUDIT：审计日志。查看日志的相关限制信息，请参见查询日志。	INSTANCELOG
query	string	是	要查询的关键词。	host:172.16.. AND content:netty
beginTime	integer	否	日志开始时间戳，单位：毫秒。必须为最近 7 天内的时间，如果不填会查询[当前时间-7 天,endTime]范围内的所有日志。	1531910852074
endTime	integer	否	日志结束时间戳，单位：毫秒。必须为最近 7 天内的时间，建议填写，如果不填返回结果为空。	1531910852074
page	integer	否	插件列表的页码。起始值：1，默认值：1。	1
size	integer	否	分页查询时设置的每页条数。默认值：20，最小值：1，最大值：50。	20

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	7F40EAA1-6F1D-4DD9-8DB8-C5F00C4E****
Headers	object	返回头信息。
X-Total-Count	integer	实例总记录数。	1000
Result	array<object>	请求返回的日志列表。
	array<object>
contentCollection	object	日志详细信息。不同的日志类型，返回不同的内容字段。	{"level": "info", "host": "192.168..", "time": "2019-03-18T08:16:12.741Z","content": "[o.e.c.r.a.AllocationService] [MnNASM_] Cluster health status changed from [YELLOW] to [GREEN] (reason: [shards started [[my_index][3]] ...])."}
instanceId	string	实例 ID。	es-cn-n6w1o1x0w001c****
level	string	日志等级。取值包括： warn：警告日志 info：信息日志 error：错误日志 trace：跟踪日志 debug：调试日志 level 信息已迁移至 contentCollection 字段中。	info
host	string	生成日志的节点的 IP 地址。	192.168..
content	string	日志详细内容。已迁移至 contentCollection 字段中。	[GC (Allocation Failure) 2018-07-19T17:24:20.682+0800: 7516.513: [ParNew: 6604768K->81121K(7341504K), 0.0760606 secs] 7226662K->703015K(31813056K), 0.0762507 secs] [Times: user=0.52 sys=0.00, real=0.07 secs]
timestamp	integer	日志生成的时间戳，单位为 ms。	1531985112420

Result.contentCollection 中包含以下参数。

名称	类型	示例值	描述
time	String	2020-07-21T11:12:53.057Z	日志产生的时间。
content	String	[o.e.c.r.a.AllocationService] [MnNASM_] Cluster health status changed from [YELLOW] to [GREEN] (reason: [shards started [[my_index][3]] ...]).	日志详细内容。
host	String	192.168..	生成日志的节点 IP。
level	String	warn	日志等级。取值包括： warn（警告日志）、info（信息日志）、error（错误日志）、trace（跟踪日志）、debug（调试日志）。

示例

正常返回示例

JSON格式

{
  "RequestId": "7F40EAA1-6F1D-4DD9-8DB8-C5F00C4E****",
  "Headers": {
    "X-Total-Count": 1000
  },
  "Result": [
    {
      "contentCollection": {
        "level": "info",
        "host": "192.168.**.**",
        "time": "2019-03-18T08:16:12.741Z",
        "content": "[o.e.c.r.a.AllocationService] [MnNASM_] Cluster health status changed from [YELLOW] to [GREEN] (reason: [shards started [[my_index][3]] ...])."
      },
      "instanceId": "es-cn-n6w1o1x0w001c****",
      "level": "info",
      "host": "192.168.**.**",
      "content": "[GC (Allocation Failure) 2018-07-19T17:24:20.682+0800: 7516.513: [ParNew: 6604768K->81121K(7341504K), 0.0760606 secs] 7226662K->703015K(31813056K), 0.0762507 secs] [Times: user=0.52 sys=0.00, real=0.07 secs] ",
      "timestamp": 1531985112420
    }
  ]
}

异常返回示例

JSON格式

{}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。