文档中心>API 中心>日志服务>日志采集配置相关接口>获取机器组绑定的采集规则配置

获取机器组绑定的采集规则配置

最近更新时间:2024-10-15 01:07:51

我的收藏

1. 接口描述

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

获取机器组绑定的采集规则配置

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeMachineGroupConfigs。
Version String 公共参数,本接口取值:2020-10-16。
Region String 公共参数,详见产品支持的 地域列表
GroupId String 机器组ID
示例值:xxxxx-xxx-xxxxx

3. 输出参数

参数名称 类型 描述
Configs Array of ConfigInfo 采集规则配置列表
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取机器组绑定的采集规则配置

获取机器组绑定的采集规则配置

输入示例

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

{
    "GroupId": "01fd5bcc-d7d4-4edb-9ff5-7ecfc305b831"
}

输出示例

{
    "Response": {
        "Configs": [
            {
                "AdvancedConfig": "",
                "ConfigId": "16c904ed-db2a-4ba4-b6fd-0f5f94f71111",
                "CreateTime": "2023-06-28 15:58:16",
                "ExcludePaths": null,
                "ExtractRule": {
                    "Address": "",
                    "AdvanceFilterRules": [],
                    "Backtracking": -1,
                    "BeginRegex": "",
                    "Delimiter": "",
                    "EventLogRules": [],
                    "FilterKeyRegex": [],
                    "IsGBK": 0,
                    "JsonStandard": 0,
                    "Keys": null,
                    "LogRegex": "",
                    "MetaTags": [],
                    "MetadataType": 0,
                    "ParseProtocol": "",
                    "PathRegex": "",
                    "Protocol": "",
                    "TimeFormat": "",
                    "TimeKey": "",
                    "UnMatchLogKey": "LogParseFailure",
                    "UnMatchUpLoadSwitch": false
                },
                "LogFormat": "",
                "LogType": "json_log",
                "Name": "cls_hkff7p5e_test_c_eks",
                "Output": "a004adec-c87a-4179-b0eb-8f7ee4ec1111",
                "Path": "/var/log/eks-log-agent/test-c/*/*/**/*.log",
                "UpdateTime": "2023-11-16 21:42:48",
                "UserDefineRule": ""
            }
        ],
        "RequestId": "983cd59e-7a7a-48aa-a16f-b0f0275c2288"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
MissingParameter 缺少参数错误。
OperationDenied 操作被拒绝。
OperationDenied.AccountDestroy 账户已销毁。
OperationDenied.AccountIsolate 账户欠费。
OperationDenied.AccountNotExists 账户不存在。
ResourceNotFound.ConfigNotExist 指定的采集规则配置不存在。
ResourceNotFound.MachineGroupNotExist 机器组不存在。