日志服务获取采集配置

1. 接口描述

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

获取agent对应的采集配置

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeAgentConfigs。
Version	是	String	公共参数，本接口取值：2020-10-16。
Region	是	String	公共参数，详见产品支持的地域列表。
AgentVersion	是	String	agent的版本号示例值：1.0
AgentIp	是	String	agent的IP地址示例值：10.10.1.1**
Labels.N	否	Array of String	机器组标签列表示例值：["label"]
InstanceId	否	String	agent的instance id 示例值：loglistener-xxxx

3. 输出参数

参数名称	类型	描述
LogConfigs	Array of LogConfigInfo	采集配置注意：此字段可能返回 null，表示取不到有效值。
ServiceLogConfigs	Array of ServiceLogConfigInfo	服务日志的配置信息注意：此字段可能返回 null，表示取不到有效值。
LastVersion	String	弃用注意：此字段可能返回 null，表示取不到有效值。示例值：****
NeedUpdate	Boolean	弃用注意：此字段可能返回 null，表示取不到有效值。示例值：true
URL	String	弃用注意：此字段可能返回 null，表示取不到有效值。示例值：htpp://***
FileMd5	String	弃用注意：此字段可能返回 null，表示取不到有效值。示例值：*
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取采集配置

输入示例

POST / HTTP/1.1
Host: cls.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAgentConfigs
<公共请求参数>

{
    "AgentVersion": "1.0",
    "AgentIp": "10.10.1.119",
    "Labels": [
        "label"
    ]
}

输出示例

{
    "Response": {
        "LogConfigs": [
            {
                "LogsetId": "logset-***",
                "Path": "/var/***",
                "GroupIds": [
                    "group-****"
                ],
                "ConfigId": "config-*****",
                "LogFormat": "**",
                "LogType": "**",
                "ExtractRule": {
                    "LogRegex": "**",
                    "Keys": [
                        "content"
                    ],
                    "FilterKeyRegex": [
                        {
                            "Regex": "**",
                            "Key": "**"
                        }
                    ],
                    "TimeKey": "**",
                    "BeginRegex": "**",
                    "Delimiter": "**",
                    "TimeFormat": "**",
                    "UnMatchUpLoadSwitch": true,
                    "UnMatchLogKey": "testlog",
                    "Backtracking": 1048576,
                    "MetadataType": 1,
                    "Protocol": "***",
                    "JsonStandard": 1,
                    "IsGBK": 1,
                    "Address": "**",
                    "ParseProtocol": "**",
                    "MetaTags": [
                        {
                            "Key": "**",
                            "Value": "**"
                        }
                    ],
                    "PathRegex": "**"
                },
                "ExcludePaths": [
                    {
                        "Type": "**",
                        "Value": "*****"
                    }
                ],
                "TopicId": "x**",
                "UserDefineRule": "x***"
            }
        ],
        "ServiceLogConfigs": [
            {}
        ],
        "URL": "****",
        "NeedUpdate": true,
        "FileMd5": "****",
        "LastVersion": "****",
        "RequestId": "****"
    }
}

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: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。
MissingParameter	缺少参数错误。
OperationDenied	操作被拒绝。
OperationDenied.AccountDestroy	账户已销毁。
OperationDenied.AccountIsolate	账户欠费。
OperationDenied.AccountNotExists	账户不存在。

获取采集配置

本页目录：