全部产品
Search
文档中心

日志服务:update_logstore

更新时间:Aug 28, 2024

调用CLI命令修改Logstore基本信息。

注意事项

在使用CLI命令之前,您需要注意以下事项:

命令格式

aliyunlog log update_logstore --project_name=<value> --logstore_name=<value> [--ttl=<value>] [--enable_tracking=<value>] [--shard_count=<value>] [--append_meta=<value>] [--auto_split=<value>] [--max_split_shard=<value>] [--preserve_storage=<value>] [--encrypt_conf=<value>] [--hot_ttl=<value>] [--mode=<value>] [--telemetry_type=<value>] [--access-id=<value>] [--access-key=<value>] [--sts-token=<value>] [--region-endpoint=<value>] [--client-name=<value>] [--jmes-filter=<value>] [--format-output=<value>] [--decode-output=<value>] [--profile=<value>]

命令参数

该命令的必选和特有参数描述如下。

参数名称

数值类型

是否必选

示例值

描述

--project_name

String

aliyun-test-project

Project名称。

--logstore_name

String

logstore-a

Logstore名称。

--ttl

Integer

30

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

--shard_count

Integer

2

Shard分区个数。

重要

不支持通过update_logstore修改分区个数,只能通过SplitShard增加或MergeShard减少。

--enable_tracking

Boolean

true

是否开启WebTracking。

  • true:开启WebTracking。

  • false:不开启WebTracking。

--append_meta

Boolean

false

是否开启记录外网IP地址。

  • true:开启记录外网IP地址。

  • false:不开启记录外网IP地址。

--auto_split

Boolean

true

是否自动分裂Shard。

  • true:自动分裂Shard。

  • false:不自动分裂Shard。

--max_split_shard

Integer

64

自动分裂Shard时的最大分裂数。取值范围为1~256。当--autoSplit参数为true时必须设置。

--encrypt_conf

String

加密配置数据结构。

更多信息,请参见EncryptConf

--telemetry_type

String

None

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

  • None:日志数据。默认为日志数据。

  • Metrics:时序数据。

--hot_ttl

Integer

60

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

当数据的存储时间超过您所配置的热存储层数据保存时间后,数据将转为低频存储。更多信息,请参见开启智能存储分层

--mode

String

standard

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

  • standard:支持日志服务一站式数据分析功能,适用于实时监控、交互式分析以及构建完整的可观测性系统等场景。

  • query:支持高性能查询,索引流量费用约为Standard的一半,但不支持SQL分析,适用于数据量大、存储周期长(周、月级别以上)、无日志分析的场景。

关于该命令的全局参数,请参见全局参数

命令示例

  • 请求示例

    使用默认账号修改logstore-a信息。

    aliyunlog log update_logstore --project_name="aliyun-test-project" --logstore_name="logstore-a" --ttl=30 --enable_tracking=true 
  • 返回示例

    命令执行成功后,无响应消息。您可以执行如下命令查询Logstore详细信息。

    aliyunlog log get_logstore --project_name="aliyun-test-project" --logstore_name="logstore-a" --format-output=json

相关文档

  • 在调用API接口过程中,若服务端返回结果中包含错误信息,则表示调用API接口失败。您可以参考API错误码对照表查找对应的解决方法。更多信息,请参见API错误处理对照表

  • 阿里云OpenAPI开发者门户提供调试、SDK、示例和配套文档。通过OpenAPI,您无需手动封装请求和签名操作,就可以快速对日志服务API进行调试。更多信息,请参见OpenAPI开发者门户

  • 关于该API接口的详细信息,请参见UpdateLogStore

  • 日志服务提供基于Java SDK和Python SDK的管理Logstore示例代码。更多信息,请参见使用Java SDK管理日志库Logstore使用Python SDK管理日志库Logstore