查询业务日志配置项信息

最近更新时间: 2026-09-17 00:03:53

1. 接口描述

接口请求域名： tsf.api3.fincloud.tencent.cn。

查询业务日志配置项信息

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

接口更新时间：2024-09-14 11:55:39。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action 是 否 String 公共参数，本接口取值：DescribeBusinessLogConfig
Version 是 否 String 公共参数，本接口取值：2018-03-26
Region 是 否 String 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
ConfigId 是 否 String 配置项ID
示例值：

3. 输出参数

参数名称 类型 描述
Result BusinessLogConfig 日志配置项
示例值：查看
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

错误码 描述
InvalidParameter.ParamError 参数错误。
UnauthorizedOperation.NoPrivilege 用户无权限访问该接口。。
FailedOperation.GroupQueryFaild 部署组查询失败。
InvalidParameter.TsfApmBusiLogCfgAppRelationParamError TSF应用性能管理业务日志配置与应用关联参数错误。
ResourceNotFound.MicroserviceOffline 目标微服务已离线[%s]。。
FailedOperation.UnhandledException 模块未处理异常。

5. 示例

示例1 查询业务日志配置项信息

输入示例

https://tsf.api3.<no value>/?Action=DescribeBusinessLogConfig
&ConfigId=apm-busi-log-cfg-qv3me6a7
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "7a20c18e-c171-4f5a-ac94-71aa92035216",
    "Result": {
      "ConfigId": "apm-busi-log-cfg-qv3me6a7",
      "ConfigName": "default-log-config",
      "ConfigPath": "PH_STARTUP_PATH/logs/*.log",
      "ConfigDesc": null,
      "ConfigTags": null,
      "ConfigPipeline": "tsf-business-1259302344-qv3me6a7",
      "ConfigCreateTime": null,
      "ConfigUpdateTime": null,
      "ConfigSchema": {
        "SchemaType": 0,
        "SchemaContent": null,
        "SchemaDateFormat": "YYYY-MM-dd HH:mm:ss.SSS",
        "SchemaMultilinePattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}",
        "SchemaCreateTime": "2019-05-27 11:16:59"
      },
      "ConfigAssociatedGroups": []
    }
  }
}