UpdateLogStore - Simple Log Service - Alibaba Cloud Documentation Center

Updates the attributes of a Logstore.

Operation description

Usage notes

Host consists of a project name and a Log Service endpoint. You must specify a project in Host.
You can call the UpdateLogStore operation to change only the time-to-live (TTL) attribute.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
log:UpdateLogStore	update	*LogStore `acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstore}`	log:TLSVersion log:Encrypted	none

Request syntax

PUT /logstores/{logstore} HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
project	string	Yes	The name of the project.	ali-test-project
logstore	string	Yes	The name of the Logstore.	test-logstore
body	object	Yes	The request body.
logstoreName	string	Yes	The name of the Logstore.	test-logstore
shardCount`deprecated`	integer	No	The number of shards. Note You cannot call the UpdateLogStore operation to change the number of shards. You can call the SplitShard or MergeShards operation to change the number of shards.	2
ttl	integer	Yes	The retention period of data. Unit: days. Valid values: 1 to 3650. If you set this parameter to 3650, logs are permanently stored.	30
encrypt_conf	EncryptConf	No	The data structure of the encryption configuration.
autoSplit	boolean	No	Specifies whether to enable automatic sharding. Valid values: true false	true
enable_tracking	boolean	No	Specifies whether to enable the web tracking feature. Default value: false. Valid values: true false	false
appendMeta	boolean	No	Specifies whether to record public IP addresses. Default value: false. Valid values: true false	false
maxSplitShard	integer	No	The maximum number of shards into which existing shards can be automatically split. Valid values: 1 to 256. Note If you set autoSplit to true, you must specify maxSplitShard.	64
telemetryType`deprecated`	string	No	The type of the observable data. Valid values: None (default): log data. Metrics: metric data.	None
hot_ttl	integer	No	The retention period of data in the hot storage tier of the Logstore. Valid values: 7 to 3000. Unit: days. After the retention period that is specified for the hot storage tier elapses, the data is moved to the Infrequent Access (IA) storage tier. For more information, see Enable hot and cold-tiered storage for a Logstore.	60
mode	string	No	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 SQL analysis. 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.	standard
infrequentAccessTTL	integer	No	The retention period of data in the IA storage tier of the Logstore. You must set this parameter to at least 30 days. After the data retention period that you specify for the IA storage tier elapses, the data is moved to the Archive storage tier.	30

Response parameters

Parameter	Type	Description	Example
headers	object
Server	string	The name of the server.	nginx
Content-Type	string	The format in which the response body is returned.	application/json
Content-Length	string	The length of the response body.	0
Connection	string	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.	close
Date	string	The time when the response was returned.	Sun, 27 May 2018 08:25:04 GMT
x-log-requestid	string	The request ID.	5B0A6B60BB6EE39764D458B5

Examples

Sample success responses

JSONformat

{}

Error codes

For a list of error codes, visit the Service error codes.