业务日志搜索

最近更新时间：2024-03-12 02:00:16

我的收藏

本页目录：

1. 接口描述

接口请求域名： tsf.tencentcloudapi.com 。

业务日志搜索

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：SearchBusinessLog。
Version	是	String	公共参数，本接口取值：2018-03-26。
Region	是	String	公共参数，详见产品支持的地域列表。
ConfigId	是	String	日志配置项ID 示例值：apm-busi-log-cfg-6a7m36a5
InstanceIds.N	否	Array of String	机器实例ID，不传表示全部实例示例值：["openapi-service-api-c594fd9cd-x76rf\r\n"]
StartTime	否	Timestamp	开始时间示例值：2019-05-29 16:06:08
EndTime	否	Timestamp	结束时间示例值：2019-05-29 17:06:08
Offset	否	Integer	请求偏移量，取值范围大于等于0，默认值为0 示例值：0
Limit	否	Integer	单页请求配置数量，取值范围[1, 200]，默认值为50 示例值：20
OrderBy	否	String	排序规则，默认值"time" 示例值：score
OrderType	否	String	排序方式，取值"asc"或"desc"，默认值"desc"
SearchWords.N	否	Array of String	检索关键词
GroupIds.N	否	Array of String	部署组ID列表，不传表示全部部署组示例值：["group-gvkqkdjv\r\n"]
SearchWordType	否	String	检索类型，取值"LUCENE", "REGEXP", "NORMAL"
BatchType	否	String	批量请求类型，取值"page"或"scroll"
ScrollId	否	String	游标ID

3. 输出参数

参数名称	类型	描述
Result	TsfPageBusinessLogV2	业务日志列表注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 业务日志搜索

输入示例

https://tsf.tencentcloudapi.com/?Action=SearchBusinessLog
&Offset=0
&Limit=20
&StartTime=2019-05-29 16:06:08
&EndTime=2019-05-29 17:06:08
&OrderBy=score
&ConfigId=apm-busi-log-cfg-6a7m36a5
&GroupIds.0=group-gvkqkdjv
&InstanceIds.0=openapi-service-api-c594fd9cd-x76rf
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "01e72376-fdbd-4b96-ab81-6c04edce442e",
        "Result": {
            "TotalCount": 184,
            "Content": [
                {
                    "LogId": "AWsCop02uXjszoOzsHWG",
                    "InstanceId": "openapi-service-api-c594fd9cd-x76rf",
                    "InstanceIp": "172.16.1.34",
                    "Content": "2019-05-29 16:08:54.072  INFO [openapi-service-api,3898e77614d63944,3898e77614d63944,true] 1 --- [http-nio-80-exec-2] c.k.t.o.service.api.aop.HttpAspect       : url=http://testprh.yunassess.com/push/getByOffset",
                    "Timestamp": 1559117334072
                },
                {
                    "LogId": "AWsCop02uXjszoOzsHWJ",
                    "InstanceId": "openapi-service-api-c594fd9cd-x76rf",
                    "InstanceIp": "172.16.1.34",
                    "Content": "2019-05-29 16:08:54.072  INFO [openapi-service-api,3898e77614d63944,3898e77614d63944,true] 1 --- [http-nio-80-exec-2] c.k.t.o.service.api.aop.HttpAspect       : class_method=com.ke.txprh.openapi.service.api.controller.PushController.getOnyByOffset",
                    "Timestamp": 1559117334072
                },
                {
                    "LogId": "AWsCp3BR2hErXcJYbH4i",
                    "InstanceId": "openapi-service-api-c594fd9cd-x76rf",
                    "InstanceIp": "172.16.1.34",
                    "Content": "2019-05-29 16:13:56.369  INFO [openapi-service-api,ce4fc5d9d17c042f,ce4fc5d9d17c042f,true] 1 --- [http-nio-80-exec-4] c.k.t.o.service.api.aop.HttpAspect       : 方法结束",
                    "Timestamp": 1559117636369
                },
                {
                    "LogId": "AWsCp0lBuXjszoOzscRb",
                    "InstanceId": "openapi-service-api-c594fd9cd-x76rf",
                    "InstanceIp": "172.16.1.34",
                    "Content": "2019-05-29 16:13:56.359  INFO [openapi-service-api,ce4fc5d9d17c042f,ce4fc5d9d17c042f,true] 1 --- [http-nio-80-exec-4] c.k.t.o.service.api.aop.HttpAspect       : 方法环绕start.....",
                    "Timestamp": 1559117636359
                },
                {
                    "LogId": "AWsCp0lBuXjszoOzscRg",
                    "InstanceId": "openapi-service-api-c594fd9cd-x76rf",
                    "InstanceIp": "172.16.1.34",
                    "Content": "2019-05-29 16:13:56.359  INFO [openapi-service-api,ce4fc5d9d17c042f,ce4fc5d9d17c042f,true] 1 --- [http-nio-80-exec-4] c.k.t.o.service.api.aop.HttpAspect       : get入参args=0",
                    "Timestamp": 1559117636359
                },
                {
                    "LogId": "AWsCqZOV2hErXcJYbUBX",
                    "InstanceId": "openapi-service-api-c594fd9cd-x76rf",
                    "InstanceIp": "172.16.1.34",
                    "Content": "2019-05-29 16:16:19.751  INFO [openapi-service-api,e64eaaa959f51579,e64eaaa959f51579,true] 1 --- [pool-2-thread-1] o.s.c.t.r.sync.TsfRouteConsulKVLoader    : tsf route rule, routeRuleInfoMap: {}",
                    "Timestamp": 1559117779751
                },
                {
                    "LogId": "AWsCq8Z7uXjszoOzswqr",
                    "InstanceId": "openapi-service-api-c594fd9cd-x76rf",
                    "InstanceIp": "172.16.1.34",
                    "Content": "2019-05-29 16:18:58.675  INFO [openapi-service-api,34a8a2e5d403a84e,34a8a2e5d403a84e,true] 1 --- [http-nio-80-exec-1] c.k.t.o.service.api.aop.HttpAspect       : url=http://testprh.yunassess.com/push/getByOffset",
                    "Timestamp": 1559117938675
                },
                {
                    "LogId": "AWsCq8Z7uXjszoOzswqu",
                    "InstanceId": "openapi-service-api-c594fd9cd-x76rf",
                    "InstanceIp": "172.16.1.34",
                    "Content": "2019-05-29 16:18:58.675  INFO [openapi-service-api,34a8a2e5d403a84e,34a8a2e5d403a84e,true] 1 --- [http-nio-80-exec-1] c.k.t.o.service.api.aop.HttpAspect       : class_method=com.ke.txprh.openapi.service.api.controller.PushController.getOnyByOffset",
                    "Timestamp": 1559117938675
                },
                {
                    "LogId": "AWsCq8Z7uXjszoOzswq2",
                    "InstanceId": "openapi-service-api-c594fd9cd-x76rf",
                    "InstanceIp": "172.16.1.34",
                    "Content": "2019-05-29 16:18:58.769  INFO [openapi-service-api,5b7d9126c385642d,5b7d9126c385642d,true] 1 --- [http-nio-80-exec-9] c.k.t.o.service.api.aop.HttpAspect       : class_method=com.ke.txprh.openapi.service.api.controller.PushController.getOnyByOffset",
                    "Timestamp": 1559117938769
                },
                {
                    "LogId": "AWsCq85M2hErXcJYbg7s",
                    "InstanceId": "openapi-service-api-c594fd9cd-x76rf",
                    "InstanceIp": "172.16.1.34",
                    "Content": "2019-05-29 16:19:00.239  INFO [openapi-service-api,487dcec58abfc6ce,487dcec58abfc6ce,true] 1 --- [http-nio-80-exec-6] c.k.t.o.service.api.aop.HttpAspect       : url=http://testprh.yunassess.com/push/multiCallbackSendResult",
                    "Timestamp": 1559117940239
                },
                {
                    "LogId": "AWsCq85M2hErXcJYbg7t",
                    "InstanceId": "openapi-service-api-c594fd9cd-x76rf",
                    "InstanceIp": "172.16.1.34",
                    "Content": "2019-05-29 16:19:00.240  INFO [openapi-service-api,487dcec58abfc6ce,487dcec58abfc6ce,true] 1 --- [http-nio-80-exec-6] c.k.t.o.service.api.aop.HttpAspect       : method=POST",
                    "Timestamp": 1559117940240
                },
                {
                    "LogId": "AWsCq85M2hErXcJYbg7w",
                    "InstanceId": "openapi-service-api-c594fd9cd-x76rf",
                    "InstanceIp": "172.16.1.34",
                    "Content": "2019-05-29 16:19:00.240  INFO [openapi-service-api,487dcec58abfc6ce,487dcec58abfc6ce,true] 1 --- [http-nio-80-exec-6] c.k.t.o.service.api.aop.HttpAspect       : post入参args=[[{\"id\":4531,\"msgType\":1,\"pushSuccess\":true},{\"id\":4532,\"msgType\":1,\"pushSuccess\":true},{\"id\":4533,\"msgType\":1,\"pushSuccess\":true}]]",
                    "Timestamp": 1559117940240
                },
                {
                    "LogId": "AWsCsGp9uXjszoOztE42",
                    "InstanceId": "openapi-service-api-c594fd9cd-x76rf",
                    "InstanceIp": "172.16.1.34",
                    "Content": "2019-05-29 16:24:00.968  INFO [openapi-service-api,fb3be69ce843dc56,fb3be69ce843dc56,true] 1 --- [http-nio-80-exec-3] c.k.t.o.service.api.aop.HttpAspect       : get入参args=0",
                    "Timestamp": 1559118240968
                },
                {
                    "LogId": "AWsCsGp9uXjszoOztE47",
                    "InstanceId": "openapi-service-api-c594fd9cd-x76rf",
                    "InstanceIp": "172.16.1.34",
                    "Content": "2019-05-29 16:24:01.049  INFO [openapi-service-api,b1b8a83046972416,b1b8a83046972416,true] 1 --- [http-nio-80-exec-2] c.k.t.o.service.api.aop.HttpAspect       : method=GET",
                    "Timestamp": 1559118241049
                },
                {
                    "LogId": "AWsCsGp9uXjszoOztE4-",
                    "InstanceId": "openapi-service-api-c594fd9cd-x76rf",
                    "InstanceIp": "172.16.1.34",
                    "Content": "2019-05-29 16:24:01.049  INFO [openapi-service-api,b1b8a83046972416,b1b8a83046972416,true] 1 --- [http-nio-80-exec-2] c.k.t.o.service.api.aop.HttpAspect       : get入参args=4535",
                    "Timestamp": 1559118241049
                },
                {
                    "LogId": "AWsCsGp9uXjszoOztE5D",
                    "InstanceId": "openapi-service-api-c594fd9cd-x76rf",
                    "InstanceIp": "172.16.1.34",
                    "Content": "2019-05-29 16:24:01.750  INFO [openapi-service-api,e744d00003b81587,e744d00003b81587,true] 1 --- [http-nio-80-exec-7] c.k.t.o.service.api.aop.HttpAspect       : method=POST",
                    "Timestamp": 1559118241750
                },
                {
                    "LogId": "AWsCtQbb2hErXcJYcKSd",
                    "InstanceId": "openapi-service-api-c594fd9cd-x76rf",
                    "InstanceIp": "172.16.1.34",
                    "Content": "2019-05-29 16:29:03.273  INFO [openapi-service-api,d4613fe92ebe22e6,d4613fe92ebe22e6,true] 1 --- [http-nio-80-exec-1] c.k.t.o.service.api.aop.HttpAspect       : 方法环绕start.....",
                    "Timestamp": 1559118543273
                },
                {
                    "LogId": "AWsCtQbb2hErXcJYcKSe",
                    "InstanceId": "openapi-service-api-c594fd9cd-x76rf",
                    "InstanceIp": "172.16.1.34",
                    "Content": "2019-05-29 16:29:03.273  INFO [openapi-service-api,d4613fe92ebe22e6,d4613fe92ebe22e6,true] 1 --- [http-nio-80-exec-1] c.k.t.o.service.api.aop.HttpAspect       : url=http://testprh.yunassess.com/push/getByOffset",
                    "Timestamp": 1559118543273
                },
                {
                    "LogId": "AWsCtQbb2hErXcJYcKSf",
                    "InstanceId": "openapi-service-api-c594fd9cd-x76rf",
                    "InstanceIp": "172.16.1.34",
                    "Content": "2019-05-29 16:29:03.273  INFO [openapi-service-api,d4613fe92ebe22e6,d4613fe92ebe22e6,true] 1 --- [http-nio-80-exec-1] c.k.t.o.service.api.aop.HttpAspect       : method=GET",
                    "Timestamp": 1559118543273
                },
                {
                    "LogId": "AWsCtQbb2hErXcJYcKSj",
                    "InstanceId": "openapi-service-api-c594fd9cd-x76rf",
                    "InstanceIp": "172.16.1.34",
                    "Content": "2019-05-29 16:29:03.284  INFO [openapi-service-api,d4613fe92ebe22e6,d4613fe92ebe22e6,true] 1 --- [http-nio-80-exec-1] c.k.t.o.service.api.aop.HttpAspect       : 方法环绕proceed，出参是 :{\"code\":1,\"data\":[]}",
                    "Timestamp": 1559118543284
                }
            ]
        }
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.TsfPrivilegeError	TSF权限模块异常，请联系系统管理员。。
InternalError.TsfApmEsResponseStatusException	TSF应用性能管理ES客户端响应状态异常。
InternalError.UnhandledException	[%s]模块未处理异常。。
InvalidParameter.TsfApmBusiLogCfgAppRelationParamError	TSF应用性能管理业务日志配置与应用关联参数错误。
InvalidParameter.TsfApmBusiLogSearchRequestParamError	TSF应用性能管理业务日志搜索请求参数错误。
InvalidParameterValue.TsfApmBusiLogSearchParseRspDateFormatError	TSF应用性能管理业务日志搜索解析时间格式错误。
ResourceNotFound.MicroserviceOffline	目标微服务已离线[%s]。。
UnauthorizedOperation.NoPrivilege	用户无权限访问该接口。。

上一篇: 撤回已发布的文件配置下一篇: 标准输出日志搜索