调用UpdateLogStore接口更新Logstore的属性信息。

接口说明

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

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

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

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

调试

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

请求头

该接口使用公共请求头，无特殊请求头。请参见公共请求参数文档。

请求语法

PUT /logstores/{logstore} HTTP/1.1

请求参数

名称 类型 位置 是否必选 示例值 描述
project String Host 是 ali-test-project

Project名称。
logstore String Path 是 test-logstore

Logstore名称。
Object Body 是

请求体参数。
logstoreName String Body 是 test-logstore

Logstore名称。
shardCount Integer Body 是 2

Shard分区个数。

说明 该接口不支持更新分区个数。只能通过SplitShard或MergeShards接口修改分区个数。
ttl Integer Body 是 30

数据的保存时间，单位为天。取值范围为1~3650。如果配置为3650，表示永久保存。
encrypt_conf EncryptConf Body 否

加密配置数据结构。
autoSplit Boolean Body 否 true

是否自动分裂Shard。

  • true：自动分裂Shard。
  • false：不自动分裂Shard。
enable_tracking Boolean Body 否 false

是否开启WebTracking功能。默认值为false。

  • true：开启WebTracking。
  • false：不开启WebTracking。
appendMeta Boolean Body 否 false

是否记录外网IP地址功能。默认值为false。

  • true：记录外网IP地址。
  • false：不记录外网IP地址。
maxSplitShard Integer Body 否 64

自动分裂时最大的Shard个数，最小值是1，最大值是256。

说明 当autoSplit为true时必须指定。
telemetryType String Body 否 None

可观测数据类型。取值包括：

  • None：日志数据。默认为日志数据。
  • Metrics：时序数据。
hot_ttl Integer Body 否 60

数据在Logstore热存储层中的存储时间，最少为7天。单位：天，取值范围：7~3000。

当数据的存储时间超过您所配置的热存储层数据保存时间后，数据将转为冷存储。更多信息，请参见智能冷热分层存储。
mode String Body 否 standard

日志服务提供标准型（Standard）和查询型（Query）两种类型的Logstore。

  • standard：支持日志服务一站式数据分析功能，适用于实时监控、交互式分析以及构建完整的可观测性系统等场景。
  • query：支持高性能查询，索引流量费用约为Standard的一半，但不支持SQL分析，适用于数据量大、存储周期长（周、月级别以上）、无日志分析的场景。

返回数据

名称 类型 示例值 描述
Server String nginx

服务器名称。
Content-Type String application/json

返回的响应体的内容格式。
Content-Length String 0

内容长度。
Connection String close

是否长链接。取值包括：

  • close：不是长链接，则每个HTTP请求都会重新建立TCP连接。
  • keep-alive：长链接，TCP连接建立后保持连接状态，节省连接所需时间和带宽。
Date String Sun, 27 May 2018 08:25:04 GMT

时间。
x-log-requestid String 5B0A6B60BB6EE39764D458B5

返回的请求ID。

示例

请求示例

PUT /logstores/test-logstore HTTP/1.1
Host:ali-test-project.cn-hangzhou.log.aliyuncs.com
Content-Type:application/json

{
  "logstoreName" : "test-logstore",
  "shardCount" : 2,
  "ttl" : 30,
  "encrypt_conf" : {
    "encrypt_type" : "default",
    "user_cmk_info" : { }
  },
  "autoSplit" : true,
  "enable_tracking" : false,
  "appendMeta" : false,
  "maxSplitShard" : 64,
  "telemetryType" : "None",
  "hot_ttl" : 60,
  "mode" : "standard"
}

正常返回示例

JSON格式

HTTP/1.1 200 OK

错误码

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

HttpStatusCode

ErrorCode

ErrorMessage

错误码描述

404

ProjectNotExist

Project does not exist.

Project不存在。

404

LogStoreNotExist

Logstore does not exist.

Logstore不存在。

500

InternalServerError

Specified Server Error Message.

内部服务调用错误。

更多信息，请参见通用错误码。