Queries the details of a Logtail configuration.
Usage notes
Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.
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 name of the required Logtail configuration is obtained. For more information, see ListConfig.
Debugging
Request headers
This operation uses only common request headers. For more information, see Common request headers.
Request syntax
GET /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 | logtail-config-sample | The name of the Logtail configuration. |
Response parameters
Parameter | Type | Example | Description |
Server | String | nginx | The name of the server. |
Content-Type | String | application/json | The content type of the response body. |
Content-Length | String | 0 | The content 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 at which the response was returned. |
x-log-requestid | String | 5B0A6B60BB6EE39764D458B5 | The request ID. |
The data structure of the Logtail configuration. |
Examples
Sample requests
GET /configs/logtail-config-sample HTTP/1.1
Host:ali-project-test.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json
Sample success responses
JSON
format
HTTP/1.1 200 OK
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
}
Error codes
For a list of error codes, see Service error codes.
HTTP status code | Error code | Error message | Description |
404 | ProjectNotExist | Project does not exist. | The specified project does not exist. |
404 | ConfigNotExist | Config configName does not exist. | The specified Logtail configuration does not exist. |
500 | InternalServerError | Specified Server Error Message. | An internal server error has occurred. |
For more information, see Common error codes.