All Products
Search
Document Center

Simple Log Service:update_logstore

Last Updated:Feb 25, 2025

Updates the basic information about a logstore.

Usage notes

Before you run this CLI command, make sure that the following conditions are met:

Command syntax

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>]

Command parameters

The following table describes the required parameters of this command and the parameters that are specific to this command.

Parameter

Type

Required

Example

Description

--project_name

String

Yes

aliyun-test-project

The name of the project. The project in Simple Log Service is used to isolate the resources of different users and control access to specific resources. For more information, see Manage a project.

--logstore_name

String

Yes

logstore-a

The name of the logstore. The name must be globally unique. You cannot change the name after you create the project.

The name must meet the following requirements:

  • Can contain lowercase letters, digits, hyphens (-), and underscores (_).

  • Must start with a lowercase letter and end with a lowercase letter or a digit.

  • Must be 3 to 63 characters in length.

--ttl

Integer

No

30

The data retention period. Unit: days. Valid values: 1 to 3650. If you set this parameter to 3650, data is permanently stored. If the specified retention period elapses, log data is deleted.

The data retention period specified by the ttl parameter is the sum of the following time values:

  • The data retention period for the hot storage tier, which is specified by the hot_ttl parameter

  • The data retention period for the Infrequent Access (IA) storage tier, which is specified by the infrequent_access_ttl parameter

  • The data retention period for the Archive storage tier

Important

If you change the retention period, Simple Log Service deletes all expired data within 1 hour. The data volume that is displayed for Usage Details on the homepage of the Simple Log Service console is updated the next day. For example, if you change the retention period from five days to one day, Simple Log Service deletes the log data of the previous four days within 1 hour.

--shard_count

Integer

No

2

The number of shards. Valid values: 1 to 10. For more information, see MD5 value range.

Important

You cannot change the number of shards by running the update_logstore command. To change the number of shards, you can call the SplitShard and MergeShard operations.

--enable_tracking

Boolean

No

true

Specifies whether to enable the web tracking feature. Valid values:

  • true

  • false

--append_meta

Boolean

No

false

Specifies whether to record public IP addresses. Valid values:

  • true

  • false

--auto_split

Boolean

No

true

Specifies whether to enable automatic sharding. Valid values:

  • true

  • false

--max_split_shard

Integer

No

64

The maximum number of shards into which existing shards can be automatically split. Valid values: 1 to 256. If you set --autoSplit to true, you must specify this parameter.

--encrypt_conf

String

No

None

The data structure of the encryption configuration.

For more information, see EncryptConf.

--telemetry_type

String

No

None

The type of the observable data. Valid values:

  • None (default): logs

  • Metrics: metrics

--hot_ttl

Integer

No

7

The data retention period for the hot storage tier. Unit: days. The minimum value is 7, and the maximum value cannot exceed the ttl parameter. If you set this parameter to -1, all data is stored in the hot storage tier.

After the data retention period that is specified for the hot storage tier elapses, the data is moved to the IA storage tier. For more information about the storage tiers and movements of data between storage tiers, see Configure intelligent tiered storage.

  • Data in the hot storage tier must be stored for at least seven days before the data can be moved to the IA storage tier. Data in the IA storage tier must be stored for at least 30 days before the data can be moved to the Archive storage tier.

  • Data in the hot storage tier must be stored for at least 30 days before the data can be moved to the Archive storage tier.

--mode

String

No

standard

The type of the logstore. Simple Log Service provides two types of logstores: Standard logstores and Query logstores. Valid values:

  • standard: Standard logstore. This type of logstore supports the log analysis feature and is suitable for scenarios such as real-time monitoring and interactive analysis. You can also use this type of logstore to build a comprehensive observability system.

  • query: Query logstore. This type of logstore supports high-performance queries. The index traffic fee of a Query logstore is approximately half that of a Standard logstore. Query logstores do not support SELECT statements. Query logstores are suitable for scenarios in which the amount of data is large, the log retention period is long, or log analysis is not required. If logs are stored for weeks or months, the log retention period is considered long. For more information, see Appendix: logstore comparison by type.

--infrequent_access_ttl

Integer

No

30

The data retention period for the IA storage tier. Unit: days. Data in the IA storage tier must be stored for at least 30 days before the data can be moved to the Archive storage tier. For more information, see Configure intelligent tiered storage.

For more information about the global parameters of this command, see Global parameters.

Command examples

  • Command

    Use the default account to update the information about logstore-a.

    aliyunlog log update_logstore --project_name="aliyun-test-project" --logstore_name="logstore-a" --ttl=30 --enable_tracking=true 
  • Output

    If the command is successfully run, no responses are returned. You can run the following command to query the details of the logstore:

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

References