Modifies a Logtail configuration.
Usage notes
- Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.
- After you modify a Logtail configuration that is applied to a machine group, the changes immediately take effect.
-
An AccessKey pair is created and obtained. For more information, see AccessKey pair.
The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see Create a RAM user and authorize the RAM user to access Simple Log Service.
- The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong and the region of the project. For more information, see Manage a project.
- The details of the Logtail configuration are obtained. For more information, see Logtail configurations.
Debugging
Request headers
This operation uses only common request headers and does not have operation-specific request headers. For more information, see Common request parameters.
Request syntax
PUT /configs/{configName} HTTP/1.1
Request parameters
Parameter |
Type |
Position |
Required |
Example |
Description |
project | String | Host | Yes | ali-test-project | The name of the project. |
configName | String | Path | Yes | test-sample | The name of the Logtail configuration. |
LogtailConfig | Body | No | The request body. |
Response parameters
Parameter |
Type |
Example |
Description |
Server | String | nginx | The name of the server. |
Content-Type | String | application/json | The format of the response body. |
Content-Length | String | 0 | The length of the response body. |
Connection | String | close | Indicates whether the connection is persistent. Valid values:
|
Date | String | Sun, 27 May 2018 08:25:04 GMT | The time when the response was returned. |
x-log-requestid | String | 5B0A6B60BB6EE39764D458B5 | The request ID. |
Examples
Sample requests
PUT /configs/test-sample HTTP/1.1
Host:ali-project-test.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json
{
"configName" : "test-config",
"logSample" : "2022-06-14 11:13:29.796 | DEBUG | __main__:<module>:1 - hello world",
"inputType" : "file",
"outputType" : "LogService",
"outputDetail" : {
"endpoint" : "cn-hangzhou-intranet.log.aliyuncs.com",
"logstoreName" : "test-logstore",
"region" : "cn-hangzhou"
},
"createTime" : 1655176807,
"lastModifyTime" : 1655176807
}
Sample success responses
JSON
format
HTTP/1.1 200 OK
Error codes
For a list of error codes, see Service error codes.
HttpStatusCode |
ErrorCode |
ErrorMessage |
Description |
404 |
ConfigNotExist |
Config configName does not exist. |
The specified Logtail configuration does not exist. |
400 |
InvalidParameter |
invalid config resource json. |
A parameter value is invalid. |
400 |
BadRequest |
Config resource configname does not match with request. |
The name of the Logtail configuration is invalid. |
500 |
InternalServerError |
Specified Server Error Message. |
An internal server error has occurred. |
For more information, see Common error codes.