全部产品
Search
文档中心

日志服务:GetLogtailPipelineConfig - 获取Logtail流水线配置

更新时间:Dec 26, 2024

获取Logtail流水线配置。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
log:GetLogtailPipelineConfigget
*全部资源
*
  • log:TLSVersion

请求语法

GET /pipelineconfigs/{configName} HTTP/1.1

请求参数

名称类型必填描述示例值
projectstring

Project 名称

test-project
configNamestring

Logtail 流水线配置名称

test-config

返回参数

名称类型描述示例值
headersobject
Serverstring

服务器名称。

nginx
Content-Typestring

返回的响应体的内容格式。

application/json
Content-Lengthstring

响应内容长度。

0
Connectionstring

是否长链接。取值包括: close:不是长链接,则每个 HTTP 请求都会重新建立 TCP 连接。 keep-alive:长链接,TCP 连接建立后保持连接状态,节省连接所需时间和带宽。

close
Datestring

返回响应的时间。

Sun, 27 May 2018 08:25:04 GMT
x-log-requestidstring

服务端产生的标识,该请求的唯一 ID。

5B0A6B60BB6EE39764D458B5
LogtailPipelineConfig

Logtail 流水线配置

示例

正常返回示例

JSON格式

{
  "configName": "test-config",
  "logSample": "127.0.0.1 - - [10/Jun/2022:12:36:49 +0800] \"GET /index.html HTTP/1.1\" 200",
  "global": {
    "test": "test",
    "test2": 1
  },
  "inputs": [
    {
      "Type": "input_file",
      "FilePaths": [
        "/var/log/*.log"
      ]
    }
  ],
  "processors": [
    {
      "Type": "processor_parse_json_native",
      "SourceKey": "content"
    }
  ],
  "aggregators": [
    {
      "test": "test",
      "test2": 1
    }
  ],
  "flushers": [
    {
      "Type": "flusher_sls",
      "Project": "test_project",
      "Logstore": "test",
      "Region": "cn-hangzhou",
      "Endpoint": "cn-hangzhou-intranet.log.aliyuncs.com",
      "TelemetryType": "log"
    }
  ],
  "createTime": 1655176807,
  "lastModifyTime": 1655176807
}

错误码

访问错误中心查看更多错误码。