Updates the attributes of a Logstore.

Description

You can call the UpdateLogStore operation to update only the ttl attribute, which specifies the maximum retention period of data.

Request headers

This operation uses only common request headers. For more information, see Common request headers.

Request syntax

PUT /logstores/{logstore} HTTP/1.1

Request parameters

Parameter Type Location Required Example Description
project String Host Yes ali-test-project

The name of the project.

logstore String Path Yes test-logstore

The name of the Logstore.

Object Body Yes

The body of the request.

logstoreName String Body Yes test-logstore

The name of the Logstore.

shardCount Integer Body Yes 2

The number of shards.

Note You cannot call the UpdateLogStore operation to update the number of shards. You can call the SplitShard or MergeShards operation to change the number of shards.
ttl Integer Body Yes 30

The data retention period. Unit: days. Valid values: 1 to 3650. If you set the value to 3650, data is permanently stored.

encrypt_conf EncryptConf Body No

The data structure of the encryption configuration.

autoSplit Boolean Body No true

Specifies whether to enable automatic sharding. Valid values:

  • true: enables automatic sharding.
  • false: disables automatic sharding.
enable_tracking Boolean Body No false

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

  • true: enables the web tracking feature.
  • false: disables the web tracking feature.
appendMeta Boolean Body No false

Specifies whether to record public IP addresses. Default value: false. Valid values:

  • true: records public IP addresses.
  • false: does not record public IP addresses.
maxSplitShard Integer Body No 64

The maximum number of shards into which a shard can be automatically split. Valid values: 1 to 64.

Note If you set the autoSplit parameter to true, you must configure the maxSplitShard parameter.
telemetryType String Body No None

The type of the log data that you want to query. Valid values:

  • None: queries all types of log data.
  • Metrics: queries metrics.
hot_ttl Integer Body No 60

The period of time during which you want to store logs in the hot storage tier of the Logstore. Minimum value: 30. Unit: days. You can specify a value that ranges from 30 to the value of the ttl parameter.

When the period of time during which logs are stored in the hot storage tier of the Logstore exceeds the period of time specified by the hot_ttl parameter, the logs are stored in the cold storage tier of the Logstore. For more information, see Enable the hot and cold-tiered storage feature.

Response parameters

Parameter Type Example Description
Server String nginx

The name of the server.

Content-Type String application/json

The content type of the response body.

Content-Length String 0

The length of the content.

Connection String close

Indicates whether the connection is persistent. Valid values:

  • close: The connection is non-persistent. A new TCP connection is established for each HTTP request.
  • keep-alive: The connection is persistent. After a TCP connection is established, the connection remains open, and no more time or bandwidth is consumed to establish new connections.
Date String Sun, 27 May 2018 08:25:04 GMT

The time.

x-log-requestid String 5B0A6B60BB6EE39764D458B5

The ID of the request.

Examples

Sample requests

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

{
  "appendMeta" : false,
  "autoSplit" : true,
  "enable_tracking" : false,
  "encrypt_conf" : {
    "user_cmk_info" : { }
  },
  "logstoreName" : "test-logstore",
  "maxSplitShard" : 64,
  "shardCount" : 2,
  "ttl" : 30
}

Sample success responses

JSON format

HTTP/1.1 200 OK

Error codes

For a list of error codes, visit the API Error Center.

HTTP status code

Error code

Error message

Description

404

ProjectNotExist

Project does not exist.

The error message returned because the specified project does not exist.

404

LogStoreNotExist

Logstore does not exist.

The error message returned because the specified Logstore does not exist.

400

LogStoreAlreadyExist

Logstore already exists.

The error message returned because the specified Logstore already exists.

400

ParameterInvalid

invalid shard count,you can only modify shardCount by split& merge shard.

The error message returned because the specified number of shards is invalid. You can change the number of shards that is specified by shardCount by calling only the SplitShard or MergeShards operation.

500

InternalServerError

Specified Server Error Message.

The error message returned because an internal server error has occurred.

For more information, see Common error codes.