微服务平台 TSF
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 微服务平台 TSF > API 文档 > 其他接口 > 查询日志配置项列表

查询日志配置项列表

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

我的收藏

本页目录：

1. 接口描述

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

查询日志配置项列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeBusinessLogConfigs。
Version 是 String 公共参数，本接口取值：2018-03-26。
Region 是 String 公共参数，详见产品支持的 地域列表。
Offset 否 Integer 偏移量，取值范围大于等于0，默认值为0
示例值：0
Limit 否 Integer 单页请求配置数量，取值范围[1, 50]，默认值为10
示例值：50
SearchWord 否 String 模糊匹配关键词
DisableProgramAuthCheck 否 Boolean 无
ConfigIdList.N 否 Array of String 无

3. 输出参数

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

4. 示例

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

输入示例

https://tsf.tencentcloudapi.com/?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",
                    "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": []
                }
            ]
        }
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

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