获取Logtail配置的详细信息。
接口说明
- Host 由 Project 名称和日志服务 Endpoint 构成,您需要在 Host 中指定 Project。
- 已创建并获取 AccessKey。更多信息,请参见访问密钥。
阿里云账号 AccessKey 拥有所有 API 的访问权限,风险很高。强烈建议您创建并使用 RAM 用户进行 API 访问或日常运维。RAM 用户需具备操作日志服务资源的权限。具体操作,请参见创建 RAM 用户及授权。
-
已明确您查询日志所属的 Project 名称、所属地域等。如何查询,请参见管理 Project。
-
已获取 Logtail 采集配置名称。更多信息,请参见 ListConfig 。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求语法
GET /configs/{configName}
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
project | string | 是 | Project 名称。 | ali-test-project |
configName | string | 是 | Logtail 配置名称。 | logtail-config-sample |
返回参数
示例
正常返回示例
JSON
格式
{
"configName": "test-config",
"logSample": "2022-06-14 11:13:29.796 | DEBUG | __main__:<module>:1 - hello world",
"inputType": "file",
"inputDetail": {
"test": "test",
"test2": 1
},
"outputType": "LogService",
"outputDetail": {
"endpoint": "cn-hangzhou-intranet.log.aliyuncs.com",
"logstoreName": "test-logstore",
"region": "cn-hangzhou"
},
"createTime": 1655176807,
"lastModifyTime": 1655176807
}
错误码
访问错误中心查看更多错误码。
HttpStatusCode | ErrorCode | ErrorMessage | 错误码描述 |
---|---|---|---|
404 | ProjectNotExist | Project does not exist. | Project 不存在。 |
404 | ConfigNotExist | Config configName does not exist. | Logtail 配置不存在。 |
500 | InternalServerError | Specified Server Error Message. | 内部服务调用错误。 |
更多信息,请参见通用错误码。