1. 接口描述
接口请求域名： tsf.api3.fincloud.tencent.com。
业务日志搜索
默认接口请求频率限制：20次/秒。
接口更新时间：2024-09-14 11:55:39。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：SearchBusinessLog |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-03-26 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceIds | 否 | 否 | Array of String | 机器实例ID，不传表示全部实例 示例值： |
| StartTime | 否 | 否 | Datetime | 开始时间 示例值： |
| EndTime | 否 | 否 | Datetime | 结束时间 示例值： |
| Offset | 否 | 否 | Uint64 | 请求偏移量，取值范围大于等于0，默认值为0 示例值： |
| Limit | 否 | 否 | Uint64 | 单页请求配置数量，取值范围[1, 200]，默认值为50 示例值： |
| OrderBy | 否 | 否 | String | 排序规则，默认值"time" 示例值： |
| OrderType | 否 | 否 | String | 排序方式，取值"asc"或"desc"，默认值"desc" 示例值： |
| SearchWords | 否 | 否 | Array of String | 检索关键词 示例值： |
| ConfigId | 是 | 否 | String | 日志配置项ID 示例值： |
| GroupIds | 否 | 否 | Array of String | 部署组ID列表，不传表示全部部署组 示例值： |
| SearchWordType | 否 | 否 | String | 检索类型，取值"LUCENE", "REGEXP", "NORMAL" 示例值： |
| BatchType | 否 | 否 | String | 批量请求类型，取值"page"或"scroll" 示例值： |
| ScrollId | 否 | 否 | String | 游标ID 示例值： |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | TsfPageBusinessLogV2 | 业务日志列表 示例值：查看 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| UnauthorizedOperation.NoPrivilege | 用户无权限访问该接口。。 |
| FailedOperation.TsfPrivilegeError | TSF权限模块异常，请联系系统管理员。。 |
| InternalError.TsfApmEsResponseStatusException | TSF应用性能管理ES客户端响应状态异常。 |
| InternalError.UnhandledException | [%s]模块未处理异常。。 |
| InvalidParameter.TsfApmBusiLogCfgAppRelationParamError | TSF应用性能管理业务日志配置与应用关联参数错误。 |
| InvalidParameter.TsfApmBusiLogSearchRequestParamError | TSF应用性能管理业务日志搜索请求参数错误。 |
| ResourceNotFound.MicroserviceOffline | 目标微服务已离线[%s]。。 |