调用 DescribeProcessorFunctions 接口获取所有数据处理器函数。

请求说明

请求方式：GET

请求地址：https://{tls-endpoint}/DescribeProcessorFunctions

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
ProcessorType	String	是	ingester	数据处理器的类型。用于区分处理器的功能类别。 ingester：数据写入处理器。 consumer：数据消费处理器。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
Functions	JSON Map	/	数据处理器函数信息。

请求示例

返回示例

Content-Type: application/json; charset=utf-8​
{​
    "Functions":  {​
                "Name": "f_rename",​
                "FunctionType": "字段操作函数",​
                "MethodSignature": "f_rename(\"key1\", \"new key1\", \"key2\", \"new key2\", ...)",​
                "Description": "调用f_rename函数重命名符合条件的日志字段名称",​
                "Samples": [​
                    {​
                        "Index": 1,​
                        "Log": [​
                            {​
                                "content": "hello world!"​
                            }​
                        ],​
                        "Script": "f_rename(\"content\",\"content_new\")",​
                        "Result": [​
                            {​
                                "content_new": "hello world!"​
                            }​
                        ],​
                        "Description": "将字段content重命名为content_new"​
                    },​
                    {​
                        "Index": 2,​
                        "Log": [​
                            {​
                                "content": "hello world!"​
                            }​
                        ],​
                        "Script": "f_rename(\"field\",\"content_new\")",​
                        "Result": [​
                            {​
                                "content": "hello world!"​
                            }​
                        ],​
                        "Description": "字段不存在时，不进行重命名"​
                    }​
                ],​
                "Arguments": [​
                    {​
                        "Index": 1,​
                        "Name": "key",​
                        "ArgumentType": "STRING",​
                        "Description": "日志的字段名",​
                        "IsNecessary": true,​
                        "DefaultValue": ""​
                    },​
                    {​
                        "Index": 2,​
                        "Name": "new key",​
                        "ArgumentType": "STRING",​
                        "Description": "重命名后的字段名",​
                        "IsNecessary": true,​
                        "DefaultValue": ""​
                    }​
                ]​
            },​
            {​
                "Name": "f_keep",​
                "FunctionType": "字段操作函数",​
                "MethodSignature": "f_keep(\"key1\", \"key2\", ....)",​
                "Description": "调用f_keep函数保留符合条件的日志字段",​
                "Samples": [​
                    {​
                        "Index": 1,​
                        "Log": [​
                            {​
                                "content": "hello world!",​
                                "language": "Java",​
                                "log_level": "DEBUG"​
                            }​
                        ],​
                        "Script": "c_if(f_has(\"content\"), f_keep(\"content\", \"language\"))",​
                        "Result": [​
                            {​
                                "content": "hello world!",​
                                "language": "Java"​
                            }​
                        ],​
                        "Description": "如果存在content字段，则保留content和language字段"​
                    }​
                ],​
                "Arguments": [​
                    {​
                        "Index": 1,​
                        "Name": "key",​
                        "ArgumentType": "STRING",​
                        "Description": "保留日志的字段名",​
                        "IsNecessary": true,​
                        "DefaultValue": ""​
                    }​
                ]​
            }​
}​

错误码

您可访问公共错误码，获取更多错误码信息。

日志服务