获取采集规则配置

最近更新时间: 2026-09-17 00:06:37

1. 接口描述

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

获取采集规则配置

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

接口更新时间：2025-07-30 00:46:59。

接口只验签名不鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeConfigs
Version	是	否	String	公共参数，本接口取值：2020-10-16
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Filters	否	否	Array of Filter	configName 按照【采集配置名称】进行模糊匹配过滤。类型：String 必选：否 configId 按照【采集配置ID】进行过滤。类型：String 必选：否 topicId 按照【日志主题】进行过滤。类型：String 必选：否每次请求的Filters的上限为10，Filter.Values的上限为5。示例值：查看
Offset	否	否	Int64	分页的偏移量，默认值为0 示例值： 0
Limit	否	否	Int64	分页单页的限制数目，默认值为20，最大值100 示例值： 10

3. 输出参数

参数名称	类型	描述
Configs	Array of ConfigInfo	采集配置列表示例值：查看
TotalCount	Int64	过滤到的总数目示例值： 1
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

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

5. 示例

示例1 获取采集配置

输入示例

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

{
      "Filters":[{
                    "Key":"configId",
                    "Values":["dfa4ac24-caa1-4e30-a027-349cb29937c4"]
            }
      ],
      "Offset":0,
      "Limit":10
}

输出示例

{
    "Response":{
        "Configs": [
        {
            "ConfigId": "dfa4ac24-caa1-4e30-a027-349cb29937c4",
            "Name": "testname",
            "Path": "/var/log/test.log",
            "LogType": "delimiter_log",
            "ExtractRule": {
                "TimeKey": "date",
                "TimeFormat": "%Y-%m-%d %H:%M:%S",
                "Delimiter": "|",
                "LogRegex": ".*",
                "BeginRegex": "^",
                "Keys": ["date","","content"],
                "FilterKeyRegex": [{"Key": "key", "Regex":"val"}],
                "UnMatchLogKey": "testlog",
                "UnMatchUpLoadSwitch": true,
                "Backtracking": -1
            },
            "UserDefineRule": "rule",
            "UpdateTime": "2017-08-08 12:12:12",
            "CreateTime": "2017-08-08 12:12:12"
        }],
        "TotalCount": 1,
        "RequestId":"6ef60bec-0242-43af-bb20-270359fb54a7"
    }
}