查询日志配置项列表

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

1. 接口描述

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

查询日志配置项列表

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

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

接口既验签名又鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeBusinessLogConfigs
Version	是	否	String	公共参数，本接口取值：2018-03-26
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Offset	否	否	Uint64	偏移量，取值范围大于等于0，默认值为0 示例值：
Limit	否	否	Uint64	单页请求配置数量，取值范围[1, 50]，默认值为10 示例值：
SearchWord	否	否	String	模糊匹配关键词示例值：
DisableProgramAuthCheck	否	否	Bool	无示例值：
ConfigIdList	否	否	Array of String	无示例值：

3. 输出参数

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

4. 错误码

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

错误码	描述
InvalidParameter.ParamError	参数错误。
UnauthorizedOperation.NoPrivilege	用户无权限访问该接口。。
FailedOperation.TsfApmBusiLogCfgWriteError	TSF应用性能管理业务日志配置数据库写入失败。
FailedOperation.TsfPrivilegeError	TSF权限模块异常，请联系系统管理员。。
InternalError.UnhandledException	[%s]模块未处理异常。。
ResourceNotFound.MicroserviceOffline	目标微服务已离线[%s]。。
UnauthorizedOperation.NoLicense	缺少License。。
InvalidParameter.TsfApmBusiLogCfgLimitParamError	TSF应用性能管理业务日志配置数目参数错误。
FailedOperation.UnhandledException	模块未处理异常。

5. 示例

示例1 查询日志配置项列表

输入示例

https://tsf.api3.<no value>/?Action=DescribeBusinessLogConfigs
&Offset=0
&Limit=50
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "7b9926c8-af66-4bdc-be70-612a9d1c1afc",
    "Result": {
      "TotalCount": 2,
      "Content": [
        {
          "ConfigId": "apm-busi-log-cfg-qabp49vl",
          "ConfigName": "default-log-config",
          "ConfigPath": "PH_STARTUP_PATH/logs/*.log",
          "ConfigDesc": null,
          "ConfigTags": null,
          "ConfigPipeline": "tsf-business-1251001060-qabp49vl",
          "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-04-17 17:00:37"
          },
          "ConfigAssociatedGroups": []
        },
        {
          "ConfigId": "apm-busi-log-cfg-gyq883y5",
          "ConfigName": "tsf_gateway",
          "ConfigPath": "/logs/idreamsky-microservice-gateway/*.log",
          "ConfigDesc": "/logs/idreamsky-microservice-gateway/*.log",
          "ConfigTags": null,
          "ConfigPipeline": "tsf-business-1251001060-gyq883y5",
          "ConfigCreateTime": "2019-04-24 18:40:26",
          "ConfigUpdateTime": "2019-04-24 18:40:26",
          "ConfigSchemaId": 1916,
          "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-04-24 18:40:26"
          },
          "ConfigAssociatedGroups": []
        }
      ]
    }
  }
}