GetLogStoreConfig - 获取日志库配置

更新时间:
复制为 MD 格式

获取日志库配置

接口说明

接口说明

  • 请求语法中的 Host 由 Project 名称和日志服务 Endpoint 构成,您需要在 Host 中指定 Project。

  • 已创建并获取 AccessKey。更多信息,请参见访问密钥

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

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

鉴权资源

下表列出了 API 对应的授权信息。您可以在 RAM 权限策略语句的 Action 元素中添加该信息,用于为 RAM 用户或 RAM 角色授予调用此 API 的权限。

动作(Action)授权策略中的资源描述方式(Resource)
log:GetLogStoreConfigacs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

GET /logstores/{logstore}/config HTTP/1.1

路径参数

名称

类型

必填

描述

示例值

logstore

string

LogStore 名称。

ali-test-logstore

请求参数

名称

类型

必填

描述

示例值

project

string

Project 名称。

ali-test-project

返回参数

名称

类型

描述

示例值

object

clientIpHeaders

array

配置 logstore 写入时提取 IP 地址的来源 header keys。顺序敏感,大小写不敏感。配置后需要打开 logstore 的 appendMeta 记录外网 Ip 来源功能才会生效,将从请求的 Header 中按照配置的 keys 提取 IP,添加到日志 Tag 中。

string

配置 logstore 写入时提取 IP 地址的来源 header key。大小写不敏感,例如 X-Forwarded-For。

X-Forwarded-For

示例

正常返回示例

JSON格式

{
  "clientIpHeaders": [
    "X-Forwarded-For"
  ]
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情