All Products
Search
Document Center

Simple Log Service:GetLogtailPipelineConfig

Last Updated:Sep 18, 2024

Queries the information about a Logtail pipeline configuration.

Operation description

The UK (London) region is supported. Supported regions are constantly updated.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
log:GetLogtailPipelineConfigget
  • All Resources
    *
  • log:TLSVersion
none

Request syntax

GET /pipelineconfigs/{configName}

Request parameters

ParameterTypeRequiredDescriptionExample
projectstringYes

The name of the project.

test-project
configNamestringYes

The name of the Logtail pipeline configuration.

test-config

Response parameters

ParameterTypeDescriptionExample
headersobject
Serverstring
nginx
Content-Typestring
application/json
Content-Lengthstring
0
Connectionstring
close
Datestring
Sun, 27 May 2018 08:25:04 GMT
x-log-requestidstring
5B0A6B60BB6EE39764D458B5
LogtailPipelineConfig

The Logtail pipeline configuration.

Examples

Sample success responses

JSONformat

{
  "configName": "test-config",
  "logSample": "127.0.0.1 - - [10/Jun/2022:12:36:49 +0800] \"GET /index.html HTTP/1.1\" 200",
  "global": {
    "TopicType": "custom",
    "TopicFormat": "aaa",
    "EnableAlwaysOnline": true,
    "EnableTimestampNanosecond": true,
    "UsingOldContentTag": true
  },
  "inputs": [
    {
      "Type": "input_file",
      "FilePaths": [
        "/home/**/*.log"
      ],
      "MaxDirSearchDepth": 10,
      "Multiline": {
        "StartPattern": "\\d+"
      },
      "TailSizeKB": 1024
    }
  ],
  "processors": [
    {
      "Type": "processor_regex",
      "SourceKey": "content",
      "Regex": "(\\d+).*([^;])",
      "Keys": [
        "k1",
        "k2"
      ]
    }
  ],
  "aggregators": [
    {
      "Type": "aggregator_shardhash",
      "SourceKeys": [
        "__source__"
      ]
    }
  ],
  "flushers": [
    {
      "Type": "flusher_sls",
      "Logstore": "test_logstore",
      "Endpoint": "cn-hangzhou-intranet.aliyuncs.com",
      "Region": "cn-hangzhou",
      "FlowControlExpireTime": 2,
      "MaxSendRate": 3,
      "EnableShardHash": true,
      "TelemetryType": "log"
    }
  ],
  "createTime": 1655176807,
  "lastModifyTime": 1655176807
}

Error codes

For a list of error codes, visit the Service error codes.