Updates the attributes of a Logstore.
Usage notes
Before you update the attributes of a Logstore, you must call the GetLogStore operation to query the original configuration of the Logstore. Then, modify the attributes based on the original configuration and pass the new attributes as parameters to the UpdateLogStore operation.
Host consists of a project name and a Simple Log Service endpoint. You must specify a project in Host.
An AccessKey pair is created and obtained. For more information, see AccessKey pair.
The AccessKey pair of an Alibaba Cloud account has permissions on all API operations. Using these credentials to perform operations in Simple Log Service is a high-risk operation. We recommend that you use a RAM user to call API operations or perform routine O&M. To create a RAM user, log on to the RAM console. Make sure that the RAM user has the management permissions on Simple Log Service resources. For more information, see Create a RAM user and authorize the RAM user to access Simple Log Service.
The information that is required to query logs is obtained. The information includes the name of the project to which the logs belong, the region of the project, and the name of the Logstore to which the logs belong. For more information, see Manage a project and Manage a Logstore.
Authentication resources
The following table describes the authorization information that is required for this operation. You can add the information to the Action element of a RAM policy statement to grant a RAM user or a RAM role the permissions to call this operation.
Action | Resource |
|
|
Debugging
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 | Position | 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 request body. | ||
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 change the number of shards. You can call the SplitShard or MergeShards operation to change the number of shards. |
ttl | Integer | Body | Yes | 30 | The retention period of data. Unit: days. Valid values: 1 to 3650. If you set this parameter to 3650, data is permanently stored. |
encrypt_conf | Body | No | The data structure of the encryption configuration. | ||
autoSplit | Boolean | Body | No | true | Specifies whether to enable automatic sharding. Valid values:
|
enable_tracking | Boolean | Body | No | false | Specifies whether to enable the web tracking feature. Default value: false. Valid values:
|
appendMeta | Boolean | Body | No | false | Specifies whether to record public IP addresses. Default value: false. Valid values:
|
maxSplitShard | Integer | Body | No | 64 | 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. |
telemetryType | String | Body | No | None | The type of the observable data. Valid values:
|
hot_ttl | Integer | Body | No | 60 | 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 the hot and cold-tiered storage feature. |
mode | String | Body | No | standard | The type of the Logstore. Simple Log Service provides two types of Logstores: Standard Logstores and Query Logstores.
|
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 content length of the response body. |
Connection | String | close | Indicates whether the connection is persistent. Valid values:
|
Date | String | Sun, 27 May 2018 08:25:04 GMT | The time. |
x-log-requestid | String | 5B0A6B60BB6EE39764D458B5 | The request ID. |
Examples
Sample requests
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"
}
Sample success responses
JSON
format
HTTP/1.1 200 OK
Error codes
For a list of error codes, see Service error codes.
HTTP status code | Error code | Error message | Description |
404 | ProjectNotExist | Project does not exist. | The specified project does not exist. |
404 | LogStoreNotExist | Logstore does not exist. | The specified Logstore does not exist. |
500 | InternalServerError | Specified Server Error Message. | An internal server error has occurred. |
For more information, see Common error codes.