All Products
Search
Document Center

Simple Log Service:CreateLogStore

Last Updated:Feb 02, 2024

Creates a Logstore.

Usage notes

  • 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 and the region of the project. For more information, see Manage a project.

  • You can create up to 200 Logstores in a project.

  • If the retention period of a log reaches the data retention period that you specified for the Logstore, the log is deleted.

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

log:CreateLogStore

acs:log:{#regionId}:{#accountId}:project/{#ProjectName}/logstore/{#LogstoreName}

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses only common request headers and does not have operation-specific request headers. For more information, see Common request headers.

Request syntax

POST /logstores HTTP/1.1

Request parameters

Parameter

Type

Position

Required

Example

Description

project

String

Host

Yes

ali-test-project

The name of the project.

Object

Body

Yes

The request body.

logstoreName

String

Body

Yes

my-logstore

The name of the Logstore. The name must meet the following requirements:

  • The name must be unique in a project.

  • The name can contain only lowercase letters, digits, hyphens (-), and underscores (_).

  • The name must start and end with a lowercase letter or a digit.

  • The name must be 3 to 63 characters in length.

shardCount

Integer

Body

Yes

2

The number of shards.

Note

You cannot call the CreateLogStore 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

1

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

encrypt_conf

EncryptConf

Body

No

The data structure of the encryption configuration. The following parameters are included: enable, encrypt_type, and user_cmk_info. For more information, see EncryptConf.

autoSplit

Boolean

Body

No

true

Specifies whether to enable automatic sharding. Valid values:

  • true

  • false

enable_tracking

Boolean

Body

No

false

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

  • true

  • false

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.

appendMeta

Boolean

Body

No

false

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

  • true

  • false

telemetryType

String

Body

No

None

The type of the observable data. Valid values:

  • None (default): log data

  • Metrics: metric data

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.

If the retention period of data in the hot storage tier exceeds the period specified by --hot_ttl, the data is transferred to the Infrequent Access (IA) storage tier. For more information, see Enable the intelligent 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.

  • 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 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.

Response parameters

Parameter

Type

Example

Description

Server

String

nginx

The name of the server.

Content-Type

String

application/json

The type of the response body. Valid values: application/json and application/x-protobuf.

Content-Length

String

0

The length of the response body.

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 at which the response was returned.

x-log-requestid

String

5B0A6B60BB6EE39764D458B5

The request ID.

Examples

Sample requests

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

{
  "logstoreName" : "my-logstore",
  "shardCount" : 2,
  "ttl" : 1,
  "encrypt_conf" : {
    "encrypt_type" : "default",
    "user_cmk_info" : { }
  },
  "autoSplit" : true,
  "enable_tracking" : false,
  "maxSplitShard" : 64,
  "appendMeta" : false,
  "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.

HttpStatusCode

ErrorCode

ErrorMessage

Description

404

ProjectNotExist

Project does not exist.

The specified project does not exist.

400

LogstoreAlreadyExist

Logstore already exists.

The specified Logstore already exists.

400

LogStoreInfoInvalid

Logstore info is invalid

The Logstore information is invalid.

400

ProjectQuotaExceed

Project Quota Exceed.

The project quota is exhausted.

500

InternalServerError

Specified Server Error Message.

An internal server error has occurred.

For more information, see Common error codes.