You need to enable JavaScript to run this app.
导航

DescribeRules

最近更新时间2023.11.22 17:29:23

首次发布时间2022.05.11 11:26:48

调用 DescribeRules 接口查看指定日志项目中的采集配置列表。

使用说明

本接口用于获取所有的采集配置。支持分页查询、按采集配置所属于的项目的 ID 查询、按采集配置的 ID、采集配置的名称、日志主题的 ID 和日志主题的名称进行模糊查询。
此接口的调用频率限制为 20 次/s,超出频率限制会报错 ExceedQPSLimit。

URI

请求方法
GET

URI

https://tls-{Region}.ivolces.com/DescribeRules

传输协议

HTTPS

URI请求参数

参数
参数类型
是否必选
示例值
说明

ProjectId

String

必选

c7e*******

采集配置所属于的项目的 ID。

RuleId

String

可选

faf*****

采集配置的 ID 关键词,支持模糊搜索。

RuleName

String

可选

name

采集配置的名称关键词,支持模糊搜索。

TopicId

String

可选

4a*********

日志主题的 ID 关键词,支持模糊搜索。

TopicName

String

可选

name

日志主题的名称关键词,支持模糊搜索。

PageNumber

Integer

可选

1

分页查询时的页码。默认为 1,即从第一页数据开始返回。

PageSize

Integer

可选

20

分页大小。默认为 20,最大为 100。

响应参数

参数
参数类型
示例值
说明

Total

Integer

1

采集配置的数量。

RuleInfos

Array of RuleInfo

/

采集配置信息列表。详细说明请参考 RuleInfo

示例

请求示例

GET https://tls-{Region}.ivolces.com/DescribeRules?ProjectId=c7e*********&RuleId=fa****&RuleName=name&TopicId=4a********&TopicName=name&PageNumber=1&PageSize=20 HTTP/1.1
...

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
...
{
    "total": 1,
    "RuleInfos": [
        {
            "TopicId": "faf*********",
            "TopicName": "tn1",
            "RuleId": "faf*********",
            "RuleName": "testname",
            "Paths": [
                "/data/nginx/log/*/*/*.log"
            ],
            "ExcludePaths":[
                {
                    "Type": "File",
                    "Value": "/data/nginx/log/*/*/exclude.log"
                },
                {
                    "Type": "Path",
                    "Value": "/data/nginx/log/*/exclude/"
                }
            ],
            "LogType": "minimalist_log",
            "ExtractRule": {
                "FilterKeyRegex": [
                    {
                        "Key": "__content__",
                        "Regex": ".*ERROR.*"
                    }
                ]
            },
            "LogSample": "2018-05-22 15:35:53.850 INFO XXXX",
            "UserDefineRule": {
                "ParsePathRule": {
                    "PathSample": "/data/nginx/log/dabaad5f-7a10/tls/app.log",
                    "Regex": "\\/data\\/nginx\\/log\\/(\\w+)-(\\w+)\\/tls\\/app\\.log",
                    "Keys": ["instance-id", "pod-name"]
                },
                "ShardHashKey": {
                    "HashKey": "3C"
                },
                "EnableRawLog": true,
                "RawLogKey": "raw",
                "Fields": {
                    "ClusterID":"dabaad5f-7a10-4771-b3ea-d821f73e****"
                },
                "Advanced": {
                    "CloseInactive": 10
                },
                "TailFiles": false
            },
            "CreateTime": "2021-08-18T13:32:23Z",
            "ModifyTime": "2021-08-18T13:32:23Z"
        }
    ]
}

错误码

错误码(Code)
HTTP 状态码
错误信息(Message)
说明

InvalidArgument

400

Invalid argument key %s, value %s, please check argument.

参数不合法。

InternalServerError

500

We encountered an unexpected server error, please try again later.

服务器内部错误。

更多信息,请参考通用错误码