All Products
Search
Document Center

Simple Log Service:UpdateLogtailPipelineConfig

Last Updated:Sep 18, 2024

Updates 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:UpdateLogtailPipelineConfigupdate
  • All Resources
    *
  • log:TLSVersion
none

Request syntax

PUT /pipelineconfigs/{configName}

Request parameters

ParameterTypeRequiredDescriptionExample
projectstringYes

The name of the project.

test-project
configNamestringYes

The name of the Logtail pipeline configuration.

test-config
bodyobjectNo

The content of the Logtail pipeline configuration.

configNamestringYes

The name of the configuration.

test-config
logSamplestringNo

The sample log.

2022-06-14 11:13:29.796 | DEBUG | __main__:<module>:1 - hello world
globalobjectNo

The global configuration.

inputsarray<object>Yes

The data source plug-ins.

objectNo

The data source plug-in.

{ "Type": "input_file", "FilePaths": ["/var/log/*.log"] }
processorsarray<object>No

The processing plug-ins.

objectNo

The processing plug-in.

{ "Type": "processor_parse_json_native", "SourceKey": "content" }
aggregatorsarray<object>No

The aggregation plug-ins.

objectNo

The aggregation plug-in.

flushersarray<object>Yes

The data output plug-ins.

objectNo

The data output plug-in.

{ "Type": "flusher_sls", "Logstore": "test" }

Response parameters

ParameterTypeDescriptionExample
headersobject
Serverstring

The name of the server.

nginx
Content-Typestring

The content type of the response body.

application/json
Content-Lengthstring

The content length of the response body.

0
Connectionstring

Indicates whether the connection is persistent. Valid values: close and keep-alive. close: The connection is non-persistent. A new TCP connection is established for each HTTP request. keep-alive: The connection is persistent. After a TCP connection is established, the connection remains open, and no more time or bandwidth is consumed to establish new connections.

close
Datestring

The time when the response was returned.

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

The request ID.

5B0A6B60BB6EE39764D458B5

Examples

Sample success responses

JSONformat

{}

Error codes

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