All Products
Search
Document Center

Common data structures

Last Updated: May 19, 2022

ConsumerGroup

The data structure of a consumer group.

Parameter

Type

Example

Description

name

String

test-consumer-group

The name of the consumer group.

timeout

Integer

300

The timeout period. If Log Service does not receive heartbeats from a consumer within the timeout period, Log Service deletes the consumer. Unit: seconds.

order

Boolean

false

Specifies whether to consume data in sequence. Valid values:

  • true: consumes data in sequence. After a shard is split, the data in the original shard is consumed first, and then the data in the new shards is consumed at the same time. After multiple shards are merged, the data that is being consumed in the original shards is consumed first, and then the other data in the new shard is consumed.
  • false: does not consume data in sequence. The data in all shards is consumed at the same time. If shards are split or merged, the data in the new shards are immediately consumed together with the data in the original shards.

EncryptConf

The data structure of an encryption configuration.

Parameter

Type

Example

Description

enable

Boolean

true

Specifies whether to enable data encryption. Valid values:

  • true: enables data encryption
  • false: does not enable data encryption

encrypt_type

String

default

The encryption algorithm. Valid values: default and m4.

user_cmk_info

EncryptUserCmkConf

{ "cmk_key_id" : "f5136b95-2420-ab31-xxxxxxxxx" "arn" : "acs:ram::13234:role/logsource" "region_id" : "cn-hangzhou" }

Optional. If you configure this parameter, the bring-your-own-key (BYOK) key is used. If you do not configure this parameter, the service key of Log Service is used.

EncryptUserCmkConf

The data structure of a user-defined encryption configuration.

Parameter

Type

Example

Description

cmk_key_id

String

f5136b95-2420-ab31-xxxxxxxxx

The ID of the customer master key (CMK) that uses the BYOK.

arn

String

acs:ram::13234:role/logsource

The Alibaba Cloud Resource Name (ARN) of the RAM role.

region_id

String

cn-hangzhou

The ID of the region where the CMK resides.

Histogram

The data structure of log distribution.

Parameter

Type

Example

Description

from

Integer

1409529600

The start time of the subinterval. This value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

to

Integer

1409569200

The end time of the subinterval. This value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

count

Long

2

The number of logs that are generated during the subinterval.

progress

String

Complete

Specifies whether the query result in the subinterval is complete. Valid values:

  • Complete: The query is successful, and a complete query result is returned.
  • Incomplete: The query is successful, but the query result is incomplete. To obtain the complete query result, you must repeat the request.

SavedSearch

The data structure of a saved search.

Parameter

Type

Example

Description

savedsearchName

String

savedsearch-name

The name of the saved search.

searchQuery

String

status: 401 | SELECT remote_addr,COUNT(*) as pv GROUP by remote_addr ORDER by pv desc limit 5

The search statement or analytic statement.

logstore

String

aliyun-test-logstore

The name of the Logstore.

topic

String

topic

The topic of the log. The default value is double quotation marks ("").

displayName

String

Method statistics

The display name of the saved search.

logstore

The data structure of a Logstore.

Parameter

Type

Example

Description

logstoreName

String

my-logstore

The name of the Logstore.

ttl

Integer

1

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

shardCount

Integer

2

The number of shards.

enable_tracking

Boolean

false

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

  • true: enables the WebTracking feature
  • false: disables the WebTracking feature

autoSplit

Boolean

true

Specifies whether to enable automatic sharding. Valid values:

  • true: enables automatic sharding
  • false: disables automatic sharding

maxSplitShard

Integer

6

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

appendMeta

Boolean

false

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

  • true: records public IP addresses
  • false: does not record public IP addresses

telemetryType

String

Metrics

The type of the data that you want to query. Valid values:

  • Metrics: metric data
  • None: non-metric data

createTime

Integer

1453949705

The time at which the Logstore was created. This value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

lastModifyTime

Integer

1524155379

The time at which the Logstore was last modified. This value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

encrypt_conf

EncryptConf

The data encryption configurations.

project

The data structure of a Log Service project.

Parameter

Type

Example

Description

createTime

String

2020-11-18 16:55:57

The time at which the project was created.

lastModifyTime

String

1447833064

The time at which the project was last modified. This value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.

description

String

Description of my-project-test

The description of the project.

owner

String

174****745

The ID of the Alibaba Cloud account that is used to create the project.

projectName

String

ali-test-project

The name of the project. The name is included in the value of the Host header. The name must be unique in a region. You cannot change the name after you create the project.

region

String

cn-hangzhou

The ID of the region where the project resides.

status

String

Normal

The status of the project. Valid values:

  • Normal: The status of the project is normal.
  • Disable: The status of the project is disabled.

shard

The data structure of a shard.

Parameter

Type

Example

Description

shardId

Integer

0

The ID of the shard.

status

String

readwrite

The status of the shard. After you create a shard, the shard is in the readwrite state by default. If you split a shard or merge shards, the shard status changes to readonly. The newly generated shards are in the readwrite state. The status of a shard does not affect the performance of reading data from the shard. Data can be written to the shards that are in the readwrite state, but cannot be written to the shards that are in the readonly state. Valid values:

  • readwrite
  • readonly

inclusiveBeginKey

String

00000000000000000000000000000000

The start of the MD5 hash range. The value is included in the MD5 hash range of the shard.

exclusiveEndKey

String

8000000000000000000000000000000

The end of the MD5 hash range.

createTime

Integer

1524222931

The time at which the shard was created. This value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.