Modifies the parameters of a Logstore.

Description

Only the ttl and shard-related parameters can be modified.

Request syntax

PUT /logstores/{logstoreName} HTTP/1.1
Authorization: <AuthorizationString> 
Date: <GMT Date>
Host: <Project Endpoint>
x-log-apiversion: 0.6.0
x-log-signaturemethod: hmac-sha1
{
    "logstoreName": <logstoreName>,
    "ttl": <ttl>,
    "shardCount": <shardCount>,
    "autoSplit": <autoSplit>,
    "maxSplitShard": <maxSplitShard>
}

Request parameters

  • Request headers

    The UpdateLogstore operation does not have operation-specific request headers. For information about the common request headers of Log Service API operations, see Common request headers.

  • Parameters
    Parameter Type Required Example Description
    logstoreName string Yes test-logstore The name of the Logstore. The name must be unique in a project.
    ttl integer Yes 1 The time to live (TTL) of log data. Unit: days. Valid values: 1 to 3600.
    shardCount integer Yes 2 The number of shards.
    Note
    • This operation modifies only the parameters of a Logstore. The number of shards in the Logstore remains unchanged.
    • You can only call the SplitShard or MergeShards operation to modify the number of shards.
    enable_tracking bool No None. Specifies whether to enable the WebTracking feature.
    autoSplit bool No true Specifies whether to enable automatic sharding.
    maxSplitShard int No 64 The maximum number of shards for automatic sharding. Valid values: 1 to 64.
    Note This parameter must be specified if the autoSplit parameter is set to true.

Response parameters

  • Response headers

    The UpdateLogstore operation does not have operation-specific response headers. For information about the common response headers of Log Service API operations, see Common response headers.

  • Response elements

    The HTTP status code 200 is returned.

Examples

  • Sample requests
    PUT /logstores/test-logstore HTTP/1.1
    Header:
    {
    x-log-apiversion=0.6.0, 
    Authorization=LOG <yourAccessKeyId>:<yourSignature>, 
    Host=ali-test-project.cn-hangzhou-devcommon-intranet.sls.aliyuncs.com, 
    Date=Wed, 11 Nov 2015 08:28:19 GMT, 
    Content-Length=55, 
    x-log-signaturemethod=hmac-sha1, 
    Content-MD5=757C60FC41CC7D3F60B88E0D916D051E, 
    User-Agent=sls-java-sdk-v-0.6.0, 
    Content-Type=application/json
    }
    Body : 
    {
        "logstoreName": "test-logstore",
        "ttl": 1,
        "shardCount": 2,
        "autoSplit": true,
        "maxSplitShard": 64
    }
  • Sample success responses
    HTTP/1.1 200 OK
    Header:
    {
    Date=Wed, 11 Nov 2015 08:28:20 GMT, 
    Content-Length=0, 
    x-log-requestid=5642FC2399248C8F7B0145FD, 
    Connection=close, 
    Server=nginx/1.6.1
    }

Error codes

HTTP status code Error code Error message Description
404 ProjectNotExist Project {ProjectName} does not exist. The error message returned because the specified project does not exist.
404 LogStoreNotExist logstore {logstoreName} does not exist. The error message returned because the specified Logstore does not exist.
400 LogStoreAlreadyExist logstore {logstoreName} already exists. The error message returned because the specified Logstore already exists.
500 InternalServerError Specified Server Error Message. The error message returned because an internal server error has occurred.
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 modify the number of shards by calling only the SplitShard or MergeShards operation.

For more information about the error codes, see Common error codes.