日志搜索服务
最近更新时间: 2024-10-18 10:38:33
1. 接口描述
接口请求域名： apigateway.api3.fincloud.tencent.cn。
本接口DescribeLogSearch用于搜索日志
默认接口请求频率限制：20次/秒。
接口更新时间：2020-06-10 11:38:29。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeLogSearch |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-08-08 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| StartTime | 是 | 否 | Datetime | 日志开始时间 |
| EndTime | 是 | 否 | Datetime | 日志结束时间 |
| Filters | 否 | 否 | Array of Filter | 保留字段 |
| Limit | 否 | 否 | Uint64 | 单次要返回的日志条数，单次返回的最大条数为100 |
| ConText | 否 | 否 | String | 根据上次返回的ConText，获取后续的内容，最多可获取10000条 |
| Sort | 否 | 否 | String | 按时间排序 asc（升序）或者 desc（降序），默认为 desc |
| ServiceId | 是 | 否 | String | 服务id |
| Query | 否 | 否 | String | 保留字段 |
| LogQuerys | 否 | 否 | Array of LogQuery | 检索条件,支持的检索条件如下：<br>req_id：“=”<br>api_id：“=”<br>cip：“=”<br>uip：“:”<br>err_msg：“:”<br>rsp_st：“=” 、“!=” 、 “:” 、 “>” 、 “<”<br>req_t：”>=“ 、 ”<=“<br><br>说明：<br>“:”表示包含，“!=”表示不等于，字段含义见输出参数的LogSet说明 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ConText | String | 获取更多检索结果的游标，值为""表示无后续结果 |
| LogSet | String | 由0或多条日志组成，每条日志格式如下：<br>'[$app_id][$env_name][$service_id][$http_host][$api_id][$uri][$scheme][rsp_st:$status][ups_st:$upstream_status]'<br>'[cip:$remote_addr][uip:$upstream_addr][vip:$server_addr][rsp_len:$bytes_sent][req_len:$request_length]'<br>'[req_t:$request_time][ups_rsp_t:$upstream_response_time][ups_conn_t:$upstream_connect_time][ups_head_t:$upstream_header_time]’<br>'[err_msg:$err_msg][tcp_rtt:$tcpinfo_rtt][$pid][$time_local][req_id:$request_id]';<br><br>说明：<br>app_id： 用户 ID。<br>env_name：环境名称。<br>service_id： 服务 ID。<br>http_host： 域名。<br>api_id： API 的 ID。<br>uri：请求的路径。<br>scheme： HTTP/HTTPS 协议。<br>rsp_st： 请求响应状态码。<br>ups_st： 后端业务服务器的响应状态码（如果请求透传到后端，改变量不为空。如果请求在 APIGW 就被拦截了，那么该变量显示为 -）。<br>cip： 客户端 IP。<br>uip： 后端业务服务（upstream）的 IP。<br>vip： 请求访问的 VIP。<br>rsp_len： 响应长度。<br>req_len： 请求长度。<br>req_t： 请求响应的总时间。<br>ups_rsp_t： 后端响应的总时间（apigw 建立连接到接收到后端响应的时间）。<br>ups_conn_t: 与后端业务服务器连接建立成功时间。<br>ups_head_t：后端响应的头部到达时间。<br>err_msg： 错误信息。<br>tcp_rtt： 客户端 TCP 连接信息，RTT（Round Trip Time）由三部分组成：链路的传播时间（propagation delay）、末端系统的处理时间、路由器缓存中的排队和处理时间（queuing delay）。<br>req_id：请求id。 |
| TotalCount | Uint64 | 单次搜索返回的日志条数，TotalCount <= Limit |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.InvalidRegion |