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

DescribeRule

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

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

调用 DescribeRule 接口查看指定的采集配置信息。

使用说明

此接口的调用频率限制为 20 次/s,超出频率限制会报错 ExceedQPSLimit。

URI

请求方法
GET

URI

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

传输协议

HTTPS

URI请求参数

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

RuleId

String

必选

fa*******

采集配置的 ID。

响应参数

参数
类型
示例值
说明

ProjectId

String

c7***********

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

ProjectName

String

testname

采集配置所属的项目的名称。

TopicId

String

4a**********

采集配置所属的日志主题的 ID。

TopicName

String

testname

采集配置所属的日志主题的名称。

RuleInfo

RuleInfo

/

采集配置的信息。详细信息请参考 RuleInfo

HostGroupInfos

Array Of HostGroupInfo

/

采集配置绑定的机器组的信息。详细信息请参考 HostGroupInfo

示例

请求示例

GET https://tls-{Region}.ivolces.com/DescribeRule?RuleId=faf HTTP/1.1
...

响应示例

以单行全文模式为例。

HTTP/1.1 200 OK
Content-Type: application/json
...
{
    "ProjectId": "c7e0e442-19bf-4fb3-b547-5992fb8b****",
    "ProjectName": "testname",
    "TopicId": "4a9bd4bd-53f1-43ff-b88a-64ee1be5****",
    "TopicName": "testname",
    "RuleInfo": {
        "TopicId": "4a9bd4bd-53f1-43ff-b88a-64ee1be5****",
        "TopicName": "testname",
        "RuleId": "faf6d529-e75e-457f-a23a-9c4203a6df****",
        "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
            }
        }
    },
    "HostGroupInfos": [
        {
            "HostGroupId": "bcb20377-7e48-4e90-968b-922eb259****",
            "HostGroupName": "testname",
            "HostGroupType": "Label",
            "HostIdentifier": "label",
            "HostCount": 2,
            "NormalHeartbeatStatusCount": 1,
            "AbnormalHeartbeatStatusCount": 1,
            "RuleCount": 1,
            "CreateTimestamp": "2021-08-18 13:32:23",
            "ModifyTimestamp": "2021-08-18 13:32:23"
        }
    ]
}

错误码

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

InvalidArgument

400

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

参数不合法。

RuleNotExist

404

Rule %s does not exist

采集配置不存在。

InternalServerError

500

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

服务器内部错误。

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