All Products
Search

This Product

    :CreateLogStore

    Document Center

    :CreateLogStore

    Last Updated:Apr 25, 2024

    Create a Logstore

    Operation description

    Usage notes

    Host consists of a project name and a Log Service endpoint. You must specify a project in Host.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

    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.
    OperationAccess levelResource typeCondition keyAssociated operation
    log:CreateLogStoreWrite
    • LogStore
      acs:log:{#regionId}:{#accountId}:project/{#project}/logstore/{#logstoreName}
    • log:TLSVersion
    • log:Encrypted
    		none

    Request syntax

    POST /logstores

    Request parameters

    ParameterTypeRequiredDescriptionExample
    bodyobjectYes

    The request body.

    logstoreNamestringYes

    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.
    		my-logstore
    shardCountintegerYes

    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.
    		2
    ttlintegerYes

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

    		1
    encrypt_confEncryptConfNo

    The data structure of the encryption configuration.

    autoSplitbooleanNo

    Specifies whether to enable automatic sharding. Valid values:

    • true
    • false
    		true
    enable_trackingbooleanNo

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

    • true
    • false
    		false
    maxSplitShardintegerNo

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

    Note If you set autoSplit to true, you must configure this parameter.
    		64
    appendMetabooleanNo

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

    • true
    • false
    		false
    telemetryTypestringNo

    The type of the observable data. Valid values:

    • None: logs
    • Metrics: metrics
    		None
    hot_ttlintegerNo

    The retention period of data in the hot storage tier of the Logstore. Unit: days. You can specify a value that ranges from 30 to the value of ttl.

    Hot data that is stored for longer than the period specified by hot_ttl is converted to cold data. For more information, see Enable hot and cold-tiered storage for a Logstore.

    		60
    modestringNo

    The type of the Logstore. Log Service provides the following 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. Log retention periods of weeks or months are considered long.
    		standard

    Response parameters

    ParameterTypeDescriptionExample
    headersobject
    Serverstring

    The name of the server.

    		nginx
    Content-Typestring

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

    		application/json
    Content-Lengthstring

    The content length of the response body.

    		0
    Connectionstring

    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 are consumed to re-establish connections.
    		close
    Datestring

    The time when the response was returned.

    		Sun, 27 May 2018 08:25:04 GMT
    x-log-requestidstring

    The request ID.

    		5B0A6B60BB6EE39764D458B5

    Examples

    Sample success responses

    JSONformat

    {}

    Error codes

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