GetConfig_日志服务_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • Host 由 Project 名称和日志服务 Endpoint 构成,您需要在 Host 中指定 Project。
  • 已创建并获取 AccessKey。更多信息,请参见访问密钥

阿里云账号 AccessKey 拥有所有 API 的访问权限,风险很高。强烈建议您创建并使用 RAM 用户进行 API 访问或日常运维。RAM 用户需具备操作日志服务资源的权限。具体操作,请参见创建 RAM 用户及授权

  • 已明确您查询日志所属的 Project 名称、所属地域等。如何查询,请参见管理 Project

  • 已获取 Logtail 采集配置名称。更多信息,请参见 ListConfig

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
log:GetConfig
Get
Project
acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logtailconfig/{#LogtailConfigName}
log:TLSVersion

请求语法

GET /configs/{configName} HTTP/1.1

路径参数

字段名称字段详情
configNamestring

Logtail 配置名称。

示例值:logtail-config-sample

请求参数

字段名称字段详情
projectstring

Project 名称。

示例值:ali-test-project

返回参数

字段名称字段详情
configNamestring

Logtail 配置的名称,在其所属 Project 内必须唯一。创建 Logtail 配置成功后,无法修改其名称。命名规则如下:展开详情

示例值:test-config
logSamplestring

日志样例。

示例值:2022-06-14 11:13:29.796 | DEBUG | __main__:<module>:1 - hello world
inputTypestring

日志输入的方式。可选值如下:展开详情

示例值:file
inputDetailobject

日志输入的相关配置。更多信息,请参见 inputDetail 参数说明

示例值:"logType": "common_reg_log", "logPath": "/var/log/httpd/", "filePattern": "access*.log", "localStorage": true, "timeFormat": "%Y/%m/%d %H:%M:%S", "logBeginRegex": ".*", "regex": "(\w+)(\s+)", "key" :["key1", "key2"], "filterKey":["key1"], "filterRegex":["regex1"], "fileEncoding":"utf8", "topicFormat": "none"
outputTypestring

日志输出的方式,只支持 LogService,即只支持将数据上传到日志服务。

示例值:LogService
outputDetailobject

日志输出的相关配置。更多信息,请参见 outputDetail 参数说明

createTimeinteger<int64>

Logtail 配置创建时间。UNIX 时间戳格式,表示从 1970-1-1 00:00:00 UTC 计算起的秒数。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:1655176807
lastModifyTimeinteger<int64>

Logtail 配置最后一次更新时间。UNIX 时间戳格式,表示从 1970-1-1 00:00:00 UTC 计算起的秒数。

注意 请注意,该值为 Long 类型,在某些语言中可能存在精度丢失的风险,请小心使用。
示例值:1655176807

返回示例

变更历史

暂无变更历史

相关示例