volcenginecc.tls.Topic
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as volcenginecc from "@volcengine/pulumi-volcenginecc";
const tlsTopicDemo = new volcenginecc.tls.Topic("TlsTopicDemo", {
ttl: 187,
hotTtl: 8,
coldTtl: 79,
archiveTtl: 100,
shardCount: 2,
autoSplit: true,
maxSplitShard: 256,
tags: [{
key: "env",
value: "test",
}],
timeKey: "time",
timeFormat: "%Y-%m-%d %H:%M:%S",
logPublicIp: false,
topicName: "test",
description: "test",
projectId: "44a425f0-a6ef-4a****",
enableHotTtl: false,
});
import pulumi
import pulumi_volcenginecc as volcenginecc
tls_topic_demo = volcenginecc.tls.Topic("TlsTopicDemo",
ttl=187,
hot_ttl=8,
cold_ttl=79,
archive_ttl=100,
shard_count=2,
auto_split=True,
max_split_shard=256,
tags=[{
"key": "env",
"value": "test",
}],
time_key="time",
time_format="%Y-%m-%d %H:%M:%S",
log_public_ip=False,
topic_name="test",
description="test",
project_id="44a425f0-a6ef-4a****",
enable_hot_ttl=False)
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/tls"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := tls.NewTopic(ctx, "TlsTopicDemo", &tls.TopicArgs{
Ttl: pulumi.Int(187),
HotTtl: pulumi.Int(8),
ColdTtl: pulumi.Int(79),
ArchiveTtl: pulumi.Int(100),
ShardCount: pulumi.Int(2),
AutoSplit: pulumi.Bool(true),
MaxSplitShard: pulumi.Int(256),
Tags: tls.TopicTagArray{
&tls.TopicTagArgs{
Key: pulumi.String("env"),
Value: pulumi.String("test"),
},
},
TimeKey: pulumi.String("time"),
TimeFormat: pulumi.String("%Y-%m-%d %H:%M:%S"),
LogPublicIp: pulumi.Bool(false),
TopicName: pulumi.String("test"),
Description: pulumi.String("test"),
ProjectId: pulumi.String("44a425f0-a6ef-4a****"),
EnableHotTtl: pulumi.Bool(false),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcenginecc = Volcengine.Pulumi.Volcenginecc;
return await Deployment.RunAsync(() =>
{
var tlsTopicDemo = new Volcenginecc.Tls.Topic("TlsTopicDemo", new()
{
Ttl = 187,
HotTtl = 8,
ColdTtl = 79,
ArchiveTtl = 100,
ShardCount = 2,
AutoSplit = true,
MaxSplitShard = 256,
Tags = new[]
{
new Volcenginecc.Tls.Inputs.TopicTagArgs
{
Key = "env",
Value = "test",
},
},
TimeKey = "time",
TimeFormat = "%Y-%m-%d %H:%M:%S",
LogPublicIp = false,
TopicName = "test",
Description = "test",
ProjectId = "44a425f0-a6ef-4a****",
EnableHotTtl = false,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.tls.Topic;
import com.volcengine.volcenginecc.tls.TopicArgs;
import com.pulumi.volcenginecc.tls.inputs.TopicTagArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var tlsTopicDemo = new Topic("tlsTopicDemo", TopicArgs.builder()
.ttl(187)
.hotTtl(8)
.coldTtl(79)
.archiveTtl(100)
.shardCount(2)
.autoSplit(true)
.maxSplitShard(256)
.tags(TopicTagArgs.builder()
.key("env")
.value("test")
.build())
.timeKey("time")
.timeFormat("%Y-%m-%d %H:%M:%S")
.logPublicIp(false)
.topicName("test")
.description("test")
.projectId("44a425f0-a6ef-4a****")
.enableHotTtl(false)
.build());
}
}
resources:
tlsTopicDemo:
type: volcenginecc:tls:Topic
name: TlsTopicDemo
properties:
ttl: 187
hotTtl: 8
coldTtl: 79
archiveTtl: 100
shardCount: 2
autoSplit: true
maxSplitShard: 256
tags:
- key: env
value: test
timeKey: time
timeFormat: '%Y-%m-%d %H:%M:%S'
logPublicIp: false
topicName: test
description: test
projectId: 44a425f0-a6ef-4a****
enableHotTtl: false
Create Topic Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Topic(name: string, args: TopicArgs, opts?: CustomResourceOptions);@overload
def Topic(resource_name: str,
args: TopicArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Topic(resource_name: str,
opts: Optional[ResourceOptions] = None,
project_id: Optional[str] = None,
topic_name: Optional[str] = None,
shard_count: Optional[int] = None,
max_split_shard: Optional[int] = None,
enable_hot_ttl: Optional[bool] = None,
enable_tracking: Optional[bool] = None,
hot_ttl: Optional[int] = None,
log_public_ip: Optional[bool] = None,
archive_ttl: Optional[int] = None,
description: Optional[str] = None,
cold_ttl: Optional[int] = None,
tags: Optional[Sequence[TopicTagArgs]] = None,
time_format: Optional[str] = None,
time_key: Optional[str] = None,
auto_split: Optional[bool] = None,
ttl: Optional[int] = None)func NewTopic(ctx *Context, name string, args TopicArgs, opts ...ResourceOption) (*Topic, error)public Topic(string name, TopicArgs args, CustomResourceOptions? opts = null)type: volcenginecc:tls:Topic
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args TopicArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args TopicArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args TopicArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args TopicArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args TopicArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var topicResource = new Volcenginecc.Tls.Topic("topicResource", new()
{
ProjectId = "string",
TopicName = "string",
ShardCount = 0,
MaxSplitShard = 0,
EnableHotTtl = false,
EnableTracking = false,
HotTtl = 0,
LogPublicIp = false,
ArchiveTtl = 0,
Description = "string",
ColdTtl = 0,
Tags = new[]
{
new Volcenginecc.Tls.Inputs.TopicTagArgs
{
Key = "string",
Value = "string",
},
},
TimeFormat = "string",
TimeKey = "string",
AutoSplit = false,
Ttl = 0,
});
example, err := tls.NewTopic(ctx, "topicResource", &tls.TopicArgs{
ProjectId: pulumi.String("string"),
TopicName: pulumi.String("string"),
ShardCount: pulumi.Int(0),
MaxSplitShard: pulumi.Int(0),
EnableHotTtl: pulumi.Bool(false),
EnableTracking: pulumi.Bool(false),
HotTtl: pulumi.Int(0),
LogPublicIp: pulumi.Bool(false),
ArchiveTtl: pulumi.Int(0),
Description: pulumi.String("string"),
ColdTtl: pulumi.Int(0),
Tags: tls.TopicTagArray{
&tls.TopicTagArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
TimeFormat: pulumi.String("string"),
TimeKey: pulumi.String("string"),
AutoSplit: pulumi.Bool(false),
Ttl: pulumi.Int(0),
})
var topicResource = new Topic("topicResource", TopicArgs.builder()
.projectId("string")
.topicName("string")
.shardCount(0)
.maxSplitShard(0)
.enableHotTtl(false)
.enableTracking(false)
.hotTtl(0)
.logPublicIp(false)
.archiveTtl(0)
.description("string")
.coldTtl(0)
.tags(TopicTagArgs.builder()
.key("string")
.value("string")
.build())
.timeFormat("string")
.timeKey("string")
.autoSplit(false)
.ttl(0)
.build());
topic_resource = volcenginecc.tls.Topic("topicResource",
project_id="string",
topic_name="string",
shard_count=0,
max_split_shard=0,
enable_hot_ttl=False,
enable_tracking=False,
hot_ttl=0,
log_public_ip=False,
archive_ttl=0,
description="string",
cold_ttl=0,
tags=[{
"key": "string",
"value": "string",
}],
time_format="string",
time_key="string",
auto_split=False,
ttl=0)
const topicResource = new volcenginecc.tls.Topic("topicResource", {
projectId: "string",
topicName: "string",
shardCount: 0,
maxSplitShard: 0,
enableHotTtl: false,
enableTracking: false,
hotTtl: 0,
logPublicIp: false,
archiveTtl: 0,
description: "string",
coldTtl: 0,
tags: [{
key: "string",
value: "string",
}],
timeFormat: "string",
timeKey: "string",
autoSplit: false,
ttl: 0,
});
type: volcenginecc:tls:Topic
properties:
archiveTtl: 0
autoSplit: false
coldTtl: 0
description: string
enableHotTtl: false
enableTracking: false
hotTtl: 0
logPublicIp: false
maxSplitShard: 0
projectId: string
shardCount: 0
tags:
- key: string
value: string
timeFormat: string
timeKey: string
topicName: string
ttl: 0
Topic Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Topic resource accepts the following input properties:
- Project
Id string - 日志主题所属的日志项目 ID。
- int
- 日志分区的数量,默认创建 1 个分区,取值范围为 1~10。 每个分区提供的写入能力为 5MiB/s、500 次/s,读取能力为 20 MiB/s、100 次/s。请在创建日志主题时合理规划分区,创建后暂不支持修改分区数量。
- Topic
Name string - 日志主题名称。
- Archive
Ttl int - 归档存储时长。该时长取值范围为 60~3650。满足如下任一条件时,可实现归档存储。标准存储时长 30 天及以上。标准存储时长 7 天及以上且低频存储时长 30 天及以上。此参数仅在 EnableHotTtl 为 true 时生效。
- Auto
Split bool - 是否开启分区的自动分裂功能。true:当写入的数据量连续 5 分钟超过已有分区服务能力时,日志服务会根据数据量自动分裂分区以满足业务需求,但分裂后的分区数量不可超出最大分裂数。最近 15 分钟内分裂出来的新分区不会自动分裂。false:不开启分区的自动分裂。
- Cold
Ttl int - 低频存储时长。该时长取值范围为 30~3650。标准存储时长 7 天及以上可实现低频存储。此参数仅在 EnableHotTtl 为 true 时生效。
- Description string
- 日志主题描述信息。不支持 <>、'、\、\、所有 emoji 表情符号。长度为 0~64 个字符。
- Enable
Hot boolTtl - 是否开启分层存储。开启后,日志服务支持标准存储、低频存储和归档存储。设置 HotTtl、ArchiveTtl、ColdTtl 后,如果数据存储时间超过对应时长,那么数据会自动沉降至低频存储、归档存储进行后续保存,直到日志采集到服务端的总时长达到 Ttl 时,被后端服务自动清理。
- Enable
Tracking bool - 是否开启 WebTracking 功能,开启后,可以通过 WebTracking 快速采集前端埋点数据。true:开启 WebTracking功能。false:(默认)关闭 WebTracking 功能。为日志主题开启 Web Tracking 后,通过 API 接口 WebTracks 写入数据时无需经过鉴权,相当于面向公网开放了匿名写入权限,可能产生脏数据。
- Hot
Ttl int - 标准存储时长。该时长默认为 30 天,取值范围为 7~3650。此参数仅在 EnableHotTtl 为 true 时生效。
- Log
Public boolIp - 是否开启记录外网 IP 功能。默认为开启状态。开启后日志服务会自动在日志内容中添加以下元数据字段。tag****client_ip:日志来源设备的公网 IP 地址。使用日志服务的私网域名写入日志数据时,则记录私网 IP 地址。tag****receive_time:日志达到服务端的时间,格式为 10 位的 Unixtime 时间戳。
- Max
Split intShard - 分区的最大分裂数,即分区分裂后,所有分区的最大数量。取值范围为 1~256,默认为 256。仅在开启自动分裂日志分区,即 AutoSplit 为 true 时必选。MaxSplitShard 必须大于指定的 ShardCount,否则日志服务无法自动分裂分区。
-
List<Volcengine.
Topic Tag> - Time
Format string - 时间格式
- Time
Key string - 时间字段名
- Ttl int
- 日志在日志服务中的总保存时间,超过指定的日志存储时长后,此日志主题中的过期日志会被自动清除。单位为天,默认为 30 天。取值范围为 1~3650,指定为 3650 天表示永久存储。
- Project
Id string - 日志主题所属的日志项目 ID。
- int
- 日志分区的数量,默认创建 1 个分区,取值范围为 1~10。 每个分区提供的写入能力为 5MiB/s、500 次/s,读取能力为 20 MiB/s、100 次/s。请在创建日志主题时合理规划分区,创建后暂不支持修改分区数量。
- Topic
Name string - 日志主题名称。
- Archive
Ttl int - 归档存储时长。该时长取值范围为 60~3650。满足如下任一条件时,可实现归档存储。标准存储时长 30 天及以上。标准存储时长 7 天及以上且低频存储时长 30 天及以上。此参数仅在 EnableHotTtl 为 true 时生效。
- Auto
Split bool - 是否开启分区的自动分裂功能。true:当写入的数据量连续 5 分钟超过已有分区服务能力时,日志服务会根据数据量自动分裂分区以满足业务需求,但分裂后的分区数量不可超出最大分裂数。最近 15 分钟内分裂出来的新分区不会自动分裂。false:不开启分区的自动分裂。
- Cold
Ttl int - 低频存储时长。该时长取值范围为 30~3650。标准存储时长 7 天及以上可实现低频存储。此参数仅在 EnableHotTtl 为 true 时生效。
- Description string
- 日志主题描述信息。不支持 <>、'、\、\、所有 emoji 表情符号。长度为 0~64 个字符。
- Enable
Hot boolTtl - 是否开启分层存储。开启后,日志服务支持标准存储、低频存储和归档存储。设置 HotTtl、ArchiveTtl、ColdTtl 后,如果数据存储时间超过对应时长,那么数据会自动沉降至低频存储、归档存储进行后续保存,直到日志采集到服务端的总时长达到 Ttl 时,被后端服务自动清理。
- Enable
Tracking bool - 是否开启 WebTracking 功能,开启后,可以通过 WebTracking 快速采集前端埋点数据。true:开启 WebTracking功能。false:(默认)关闭 WebTracking 功能。为日志主题开启 Web Tracking 后,通过 API 接口 WebTracks 写入数据时无需经过鉴权,相当于面向公网开放了匿名写入权限,可能产生脏数据。
- Hot
Ttl int - 标准存储时长。该时长默认为 30 天,取值范围为 7~3650。此参数仅在 EnableHotTtl 为 true 时生效。
- Log
Public boolIp - 是否开启记录外网 IP 功能。默认为开启状态。开启后日志服务会自动在日志内容中添加以下元数据字段。tag****client_ip:日志来源设备的公网 IP 地址。使用日志服务的私网域名写入日志数据时,则记录私网 IP 地址。tag****receive_time:日志达到服务端的时间,格式为 10 位的 Unixtime 时间戳。
- Max
Split intShard - 分区的最大分裂数,即分区分裂后,所有分区的最大数量。取值范围为 1~256,默认为 256。仅在开启自动分裂日志分区,即 AutoSplit 为 true 时必选。MaxSplitShard 必须大于指定的 ShardCount,否则日志服务无法自动分裂分区。
-
[]Topic
Tag Args - Time
Format string - 时间格式
- Time
Key string - 时间字段名
- Ttl int
- 日志在日志服务中的总保存时间,超过指定的日志存储时长后,此日志主题中的过期日志会被自动清除。单位为天,默认为 30 天。取值范围为 1~3650,指定为 3650 天表示永久存储。
- project
Id String - 日志主题所属的日志项目 ID。
- Integer
- 日志分区的数量,默认创建 1 个分区,取值范围为 1~10。 每个分区提供的写入能力为 5MiB/s、500 次/s,读取能力为 20 MiB/s、100 次/s。请在创建日志主题时合理规划分区,创建后暂不支持修改分区数量。
- topic
Name String - 日志主题名称。
- archive
Ttl Integer - 归档存储时长。该时长取值范围为 60~3650。满足如下任一条件时,可实现归档存储。标准存储时长 30 天及以上。标准存储时长 7 天及以上且低频存储时长 30 天及以上。此参数仅在 EnableHotTtl 为 true 时生效。
- auto
Split Boolean - 是否开启分区的自动分裂功能。true:当写入的数据量连续 5 分钟超过已有分区服务能力时,日志服务会根据数据量自动分裂分区以满足业务需求,但分裂后的分区数量不可超出最大分裂数。最近 15 分钟内分裂出来的新分区不会自动分裂。false:不开启分区的自动分裂。
- cold
Ttl Integer - 低频存储时长。该时长取值范围为 30~3650。标准存储时长 7 天及以上可实现低频存储。此参数仅在 EnableHotTtl 为 true 时生效。
- description String
- 日志主题描述信息。不支持 <>、'、\、\、所有 emoji 表情符号。长度为 0~64 个字符。
- enable
Hot BooleanTtl - 是否开启分层存储。开启后,日志服务支持标准存储、低频存储和归档存储。设置 HotTtl、ArchiveTtl、ColdTtl 后,如果数据存储时间超过对应时长,那么数据会自动沉降至低频存储、归档存储进行后续保存,直到日志采集到服务端的总时长达到 Ttl 时,被后端服务自动清理。
- enable
Tracking Boolean - 是否开启 WebTracking 功能,开启后,可以通过 WebTracking 快速采集前端埋点数据。true:开启 WebTracking功能。false:(默认)关闭 WebTracking 功能。为日志主题开启 Web Tracking 后,通过 API 接口 WebTracks 写入数据时无需经过鉴权,相当于面向公网开放了匿名写入权限,可能产生脏数据。
- hot
Ttl Integer - 标准存储时长。该时长默认为 30 天,取值范围为 7~3650。此参数仅在 EnableHotTtl 为 true 时生效。
- log
Public BooleanIp - 是否开启记录外网 IP 功能。默认为开启状态。开启后日志服务会自动在日志内容中添加以下元数据字段。tag****client_ip:日志来源设备的公网 IP 地址。使用日志服务的私网域名写入日志数据时,则记录私网 IP 地址。tag****receive_time:日志达到服务端的时间,格式为 10 位的 Unixtime 时间戳。
- max
Split IntegerShard - 分区的最大分裂数,即分区分裂后,所有分区的最大数量。取值范围为 1~256,默认为 256。仅在开启自动分裂日志分区,即 AutoSplit 为 true 时必选。MaxSplitShard 必须大于指定的 ShardCount,否则日志服务无法自动分裂分区。
-
List<Topic
Tag> - time
Format String - 时间格式
- time
Key String - 时间字段名
- ttl Integer
- 日志在日志服务中的总保存时间,超过指定的日志存储时长后,此日志主题中的过期日志会被自动清除。单位为天,默认为 30 天。取值范围为 1~3650,指定为 3650 天表示永久存储。
- project
Id string - 日志主题所属的日志项目 ID。
- number
- 日志分区的数量,默认创建 1 个分区,取值范围为 1~10。 每个分区提供的写入能力为 5MiB/s、500 次/s,读取能力为 20 MiB/s、100 次/s。请在创建日志主题时合理规划分区,创建后暂不支持修改分区数量。
- topic
Name string - 日志主题名称。
- archive
Ttl number - 归档存储时长。该时长取值范围为 60~3650。满足如下任一条件时,可实现归档存储。标准存储时长 30 天及以上。标准存储时长 7 天及以上且低频存储时长 30 天及以上。此参数仅在 EnableHotTtl 为 true 时生效。
- auto
Split boolean - 是否开启分区的自动分裂功能。true:当写入的数据量连续 5 分钟超过已有分区服务能力时,日志服务会根据数据量自动分裂分区以满足业务需求,但分裂后的分区数量不可超出最大分裂数。最近 15 分钟内分裂出来的新分区不会自动分裂。false:不开启分区的自动分裂。
- cold
Ttl number - 低频存储时长。该时长取值范围为 30~3650。标准存储时长 7 天及以上可实现低频存储。此参数仅在 EnableHotTtl 为 true 时生效。
- description string
- 日志主题描述信息。不支持 <>、'、\、\、所有 emoji 表情符号。长度为 0~64 个字符。
- enable
Hot booleanTtl - 是否开启分层存储。开启后,日志服务支持标准存储、低频存储和归档存储。设置 HotTtl、ArchiveTtl、ColdTtl 后,如果数据存储时间超过对应时长,那么数据会自动沉降至低频存储、归档存储进行后续保存,直到日志采集到服务端的总时长达到 Ttl 时,被后端服务自动清理。
- enable
Tracking boolean - 是否开启 WebTracking 功能,开启后,可以通过 WebTracking 快速采集前端埋点数据。true:开启 WebTracking功能。false:(默认)关闭 WebTracking 功能。为日志主题开启 Web Tracking 后,通过 API 接口 WebTracks 写入数据时无需经过鉴权,相当于面向公网开放了匿名写入权限,可能产生脏数据。
- hot
Ttl number - 标准存储时长。该时长默认为 30 天,取值范围为 7~3650。此参数仅在 EnableHotTtl 为 true 时生效。
- log
Public booleanIp - 是否开启记录外网 IP 功能。默认为开启状态。开启后日志服务会自动在日志内容中添加以下元数据字段。tag****client_ip:日志来源设备的公网 IP 地址。使用日志服务的私网域名写入日志数据时,则记录私网 IP 地址。tag****receive_time:日志达到服务端的时间,格式为 10 位的 Unixtime 时间戳。
- max
Split numberShard - 分区的最大分裂数,即分区分裂后,所有分区的最大数量。取值范围为 1~256,默认为 256。仅在开启自动分裂日志分区,即 AutoSplit 为 true 时必选。MaxSplitShard 必须大于指定的 ShardCount,否则日志服务无法自动分裂分区。
-
Topic
Tag[] - time
Format string - 时间格式
- time
Key string - 时间字段名
- ttl number
- 日志在日志服务中的总保存时间,超过指定的日志存储时长后,此日志主题中的过期日志会被自动清除。单位为天,默认为 30 天。取值范围为 1~3650,指定为 3650 天表示永久存储。
- project_
id str - 日志主题所属的日志项目 ID。
- int
- 日志分区的数量,默认创建 1 个分区,取值范围为 1~10。 每个分区提供的写入能力为 5MiB/s、500 次/s,读取能力为 20 MiB/s、100 次/s。请在创建日志主题时合理规划分区,创建后暂不支持修改分区数量。
- topic_
name str - 日志主题名称。
- archive_
ttl int - 归档存储时长。该时长取值范围为 60~3650。满足如下任一条件时,可实现归档存储。标准存储时长 30 天及以上。标准存储时长 7 天及以上且低频存储时长 30 天及以上。此参数仅在 EnableHotTtl 为 true 时生效。
- auto_
split bool - 是否开启分区的自动分裂功能。true:当写入的数据量连续 5 分钟超过已有分区服务能力时,日志服务会根据数据量自动分裂分区以满足业务需求,但分裂后的分区数量不可超出最大分裂数。最近 15 分钟内分裂出来的新分区不会自动分裂。false:不开启分区的自动分裂。
- cold_
ttl int - 低频存储时长。该时长取值范围为 30~3650。标准存储时长 7 天及以上可实现低频存储。此参数仅在 EnableHotTtl 为 true 时生效。
- description str
- 日志主题描述信息。不支持 <>、'、\、\、所有 emoji 表情符号。长度为 0~64 个字符。
- enable_
hot_ boolttl - 是否开启分层存储。开启后,日志服务支持标准存储、低频存储和归档存储。设置 HotTtl、ArchiveTtl、ColdTtl 后,如果数据存储时间超过对应时长,那么数据会自动沉降至低频存储、归档存储进行后续保存,直到日志采集到服务端的总时长达到 Ttl 时,被后端服务自动清理。
- enable_
tracking bool - 是否开启 WebTracking 功能,开启后,可以通过 WebTracking 快速采集前端埋点数据。true:开启 WebTracking功能。false:(默认)关闭 WebTracking 功能。为日志主题开启 Web Tracking 后,通过 API 接口 WebTracks 写入数据时无需经过鉴权,相当于面向公网开放了匿名写入权限,可能产生脏数据。
- hot_
ttl int - 标准存储时长。该时长默认为 30 天,取值范围为 7~3650。此参数仅在 EnableHotTtl 为 true 时生效。
- log_
public_ boolip - 是否开启记录外网 IP 功能。默认为开启状态。开启后日志服务会自动在日志内容中添加以下元数据字段。tag****client_ip:日志来源设备的公网 IP 地址。使用日志服务的私网域名写入日志数据时,则记录私网 IP 地址。tag****receive_time:日志达到服务端的时间,格式为 10 位的 Unixtime 时间戳。
- max_
split_ intshard - 分区的最大分裂数,即分区分裂后,所有分区的最大数量。取值范围为 1~256,默认为 256。仅在开启自动分裂日志分区,即 AutoSplit 为 true 时必选。MaxSplitShard 必须大于指定的 ShardCount,否则日志服务无法自动分裂分区。
-
Sequence[Topic
Tag Args] - time_
format str - 时间格式
- time_
key str - 时间字段名
- ttl int
- 日志在日志服务中的总保存时间,超过指定的日志存储时长后,此日志主题中的过期日志会被自动清除。单位为天,默认为 30 天。取值范围为 1~3650,指定为 3650 天表示永久存储。
- project
Id String - 日志主题所属的日志项目 ID。
- Number
- 日志分区的数量,默认创建 1 个分区,取值范围为 1~10。 每个分区提供的写入能力为 5MiB/s、500 次/s,读取能力为 20 MiB/s、100 次/s。请在创建日志主题时合理规划分区,创建后暂不支持修改分区数量。
- topic
Name String - 日志主题名称。
- archive
Ttl Number - 归档存储时长。该时长取值范围为 60~3650。满足如下任一条件时,可实现归档存储。标准存储时长 30 天及以上。标准存储时长 7 天及以上且低频存储时长 30 天及以上。此参数仅在 EnableHotTtl 为 true 时生效。
- auto
Split Boolean - 是否开启分区的自动分裂功能。true:当写入的数据量连续 5 分钟超过已有分区服务能力时,日志服务会根据数据量自动分裂分区以满足业务需求,但分裂后的分区数量不可超出最大分裂数。最近 15 分钟内分裂出来的新分区不会自动分裂。false:不开启分区的自动分裂。
- cold
Ttl Number - 低频存储时长。该时长取值范围为 30~3650。标准存储时长 7 天及以上可实现低频存储。此参数仅在 EnableHotTtl 为 true 时生效。
- description String
- 日志主题描述信息。不支持 <>、'、\、\、所有 emoji 表情符号。长度为 0~64 个字符。
- enable
Hot BooleanTtl - 是否开启分层存储。开启后,日志服务支持标准存储、低频存储和归档存储。设置 HotTtl、ArchiveTtl、ColdTtl 后,如果数据存储时间超过对应时长,那么数据会自动沉降至低频存储、归档存储进行后续保存,直到日志采集到服务端的总时长达到 Ttl 时,被后端服务自动清理。
- enable
Tracking Boolean - 是否开启 WebTracking 功能,开启后,可以通过 WebTracking 快速采集前端埋点数据。true:开启 WebTracking功能。false:(默认)关闭 WebTracking 功能。为日志主题开启 Web Tracking 后,通过 API 接口 WebTracks 写入数据时无需经过鉴权,相当于面向公网开放了匿名写入权限,可能产生脏数据。
- hot
Ttl Number - 标准存储时长。该时长默认为 30 天,取值范围为 7~3650。此参数仅在 EnableHotTtl 为 true 时生效。
- log
Public BooleanIp - 是否开启记录外网 IP 功能。默认为开启状态。开启后日志服务会自动在日志内容中添加以下元数据字段。tag****client_ip:日志来源设备的公网 IP 地址。使用日志服务的私网域名写入日志数据时,则记录私网 IP 地址。tag****receive_time:日志达到服务端的时间,格式为 10 位的 Unixtime 时间戳。
- max
Split NumberShard - 分区的最大分裂数,即分区分裂后,所有分区的最大数量。取值范围为 1~256,默认为 256。仅在开启自动分裂日志分区,即 AutoSplit 为 true 时必选。MaxSplitShard 必须大于指定的 ShardCount,否则日志服务无法自动分裂分区。
- List<Property Map>
- time
Format String - 时间格式
- time
Key String - 时间字段名
- ttl Number
- 日志在日志服务中的总保存时间,超过指定的日志存储时长后,此日志主题中的过期日志会被自动清除。单位为天,默认为 30 天。取值范围为 1~3650,指定为 3650 天表示永久存储。
Outputs
All input properties are implicitly available as output properties. Additionally, the Topic resource produces the following output properties:
- Created
Time string - 日志主题创建时间。
- Id string
- The provider-assigned unique ID for this managed resource.
- Topic
Id string - 日志主题 ID。
- Updated
Time string - 日志主题修改时间。
- Created
Time string - 日志主题创建时间。
- Id string
- The provider-assigned unique ID for this managed resource.
- Topic
Id string - 日志主题 ID。
- Updated
Time string - 日志主题修改时间。
- created
Time String - 日志主题创建时间。
- id String
- The provider-assigned unique ID for this managed resource.
- topic
Id String - 日志主题 ID。
- updated
Time String - 日志主题修改时间。
- created
Time string - 日志主题创建时间。
- id string
- The provider-assigned unique ID for this managed resource.
- topic
Id string - 日志主题 ID。
- updated
Time string - 日志主题修改时间。
- created_
time str - 日志主题创建时间。
- id str
- The provider-assigned unique ID for this managed resource.
- topic_
id str - 日志主题 ID。
- updated_
time str - 日志主题修改时间。
- created
Time String - 日志主题创建时间。
- id String
- The provider-assigned unique ID for this managed resource.
- topic
Id String - 日志主题 ID。
- updated
Time String - 日志主题修改时间。
Look up Existing Topic Resource
Get an existing Topic resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: TopicState, opts?: CustomResourceOptions): Topic@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
archive_ttl: Optional[int] = None,
auto_split: Optional[bool] = None,
cold_ttl: Optional[int] = None,
created_time: Optional[str] = None,
description: Optional[str] = None,
enable_hot_ttl: Optional[bool] = None,
enable_tracking: Optional[bool] = None,
hot_ttl: Optional[int] = None,
log_public_ip: Optional[bool] = None,
max_split_shard: Optional[int] = None,
project_id: Optional[str] = None,
shard_count: Optional[int] = None,
tags: Optional[Sequence[TopicTagArgs]] = None,
time_format: Optional[str] = None,
time_key: Optional[str] = None,
topic_id: Optional[str] = None,
topic_name: Optional[str] = None,
ttl: Optional[int] = None,
updated_time: Optional[str] = None) -> Topicfunc GetTopic(ctx *Context, name string, id IDInput, state *TopicState, opts ...ResourceOption) (*Topic, error)public static Topic Get(string name, Input<string> id, TopicState? state, CustomResourceOptions? opts = null)public static Topic get(String name, Output<String> id, TopicState state, CustomResourceOptions options)resources: _: type: volcenginecc:tls:Topic get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Archive
Ttl int - 归档存储时长。该时长取值范围为 60~3650。满足如下任一条件时,可实现归档存储。标准存储时长 30 天及以上。标准存储时长 7 天及以上且低频存储时长 30 天及以上。此参数仅在 EnableHotTtl 为 true 时生效。
- Auto
Split bool - 是否开启分区的自动分裂功能。true:当写入的数据量连续 5 分钟超过已有分区服务能力时,日志服务会根据数据量自动分裂分区以满足业务需求,但分裂后的分区数量不可超出最大分裂数。最近 15 分钟内分裂出来的新分区不会自动分裂。false:不开启分区的自动分裂。
- Cold
Ttl int - 低频存储时长。该时长取值范围为 30~3650。标准存储时长 7 天及以上可实现低频存储。此参数仅在 EnableHotTtl 为 true 时生效。
- Created
Time string - 日志主题创建时间。
- Description string
- 日志主题描述信息。不支持 <>、'、\、\、所有 emoji 表情符号。长度为 0~64 个字符。
- Enable
Hot boolTtl - 是否开启分层存储。开启后,日志服务支持标准存储、低频存储和归档存储。设置 HotTtl、ArchiveTtl、ColdTtl 后,如果数据存储时间超过对应时长,那么数据会自动沉降至低频存储、归档存储进行后续保存,直到日志采集到服务端的总时长达到 Ttl 时,被后端服务自动清理。
- Enable
Tracking bool - 是否开启 WebTracking 功能,开启后,可以通过 WebTracking 快速采集前端埋点数据。true:开启 WebTracking功能。false:(默认)关闭 WebTracking 功能。为日志主题开启 Web Tracking 后,通过 API 接口 WebTracks 写入数据时无需经过鉴权,相当于面向公网开放了匿名写入权限,可能产生脏数据。
- Hot
Ttl int - 标准存储时长。该时长默认为 30 天,取值范围为 7~3650。此参数仅在 EnableHotTtl 为 true 时生效。
- Log
Public boolIp - 是否开启记录外网 IP 功能。默认为开启状态。开启后日志服务会自动在日志内容中添加以下元数据字段。tag****client_ip:日志来源设备的公网 IP 地址。使用日志服务的私网域名写入日志数据时,则记录私网 IP 地址。tag****receive_time:日志达到服务端的时间,格式为 10 位的 Unixtime 时间戳。
- Max
Split intShard - 分区的最大分裂数,即分区分裂后,所有分区的最大数量。取值范围为 1~256,默认为 256。仅在开启自动分裂日志分区,即 AutoSplit 为 true 时必选。MaxSplitShard 必须大于指定的 ShardCount,否则日志服务无法自动分裂分区。
- Project
Id string - 日志主题所属的日志项目 ID。
- Shard
Count int - 日志分区的数量,默认创建 1 个分区,取值范围为 1~10。 每个分区提供的写入能力为 5MiB/s、500 次/s,读取能力为 20 MiB/s、100 次/s。请在创建日志主题时合理规划分区,创建后暂不支持修改分区数量。
-
List<Volcengine.
Topic Tag> - Time
Format string - 时间格式
- Time
Key string - 时间字段名
- Topic
Id string - 日志主题 ID。
- Topic
Name string - 日志主题名称。
- Ttl int
- 日志在日志服务中的总保存时间,超过指定的日志存储时长后,此日志主题中的过期日志会被自动清除。单位为天,默认为 30 天。取值范围为 1~3650,指定为 3650 天表示永久存储。
- Updated
Time string - 日志主题修改时间。
- Archive
Ttl int - 归档存储时长。该时长取值范围为 60~3650。满足如下任一条件时,可实现归档存储。标准存储时长 30 天及以上。标准存储时长 7 天及以上且低频存储时长 30 天及以上。此参数仅在 EnableHotTtl 为 true 时生效。
- Auto
Split bool - 是否开启分区的自动分裂功能。true:当写入的数据量连续 5 分钟超过已有分区服务能力时,日志服务会根据数据量自动分裂分区以满足业务需求,但分裂后的分区数量不可超出最大分裂数。最近 15 分钟内分裂出来的新分区不会自动分裂。false:不开启分区的自动分裂。
- Cold
Ttl int - 低频存储时长。该时长取值范围为 30~3650。标准存储时长 7 天及以上可实现低频存储。此参数仅在 EnableHotTtl 为 true 时生效。
- Created
Time string - 日志主题创建时间。
- Description string
- 日志主题描述信息。不支持 <>、'、\、\、所有 emoji 表情符号。长度为 0~64 个字符。
- Enable
Hot boolTtl - 是否开启分层存储。开启后,日志服务支持标准存储、低频存储和归档存储。设置 HotTtl、ArchiveTtl、ColdTtl 后,如果数据存储时间超过对应时长,那么数据会自动沉降至低频存储、归档存储进行后续保存,直到日志采集到服务端的总时长达到 Ttl 时,被后端服务自动清理。
- Enable
Tracking bool - 是否开启 WebTracking 功能,开启后,可以通过 WebTracking 快速采集前端埋点数据。true:开启 WebTracking功能。false:(默认)关闭 WebTracking 功能。为日志主题开启 Web Tracking 后,通过 API 接口 WebTracks 写入数据时无需经过鉴权,相当于面向公网开放了匿名写入权限,可能产生脏数据。
- Hot
Ttl int - 标准存储时长。该时长默认为 30 天,取值范围为 7~3650。此参数仅在 EnableHotTtl 为 true 时生效。
- Log
Public boolIp - 是否开启记录外网 IP 功能。默认为开启状态。开启后日志服务会自动在日志内容中添加以下元数据字段。tag****client_ip:日志来源设备的公网 IP 地址。使用日志服务的私网域名写入日志数据时,则记录私网 IP 地址。tag****receive_time:日志达到服务端的时间,格式为 10 位的 Unixtime 时间戳。
- Max
Split intShard - 分区的最大分裂数,即分区分裂后,所有分区的最大数量。取值范围为 1~256,默认为 256。仅在开启自动分裂日志分区,即 AutoSplit 为 true 时必选。MaxSplitShard 必须大于指定的 ShardCount,否则日志服务无法自动分裂分区。
- Project
Id string - 日志主题所属的日志项目 ID。
- Shard
Count int - 日志分区的数量,默认创建 1 个分区,取值范围为 1~10。 每个分区提供的写入能力为 5MiB/s、500 次/s,读取能力为 20 MiB/s、100 次/s。请在创建日志主题时合理规划分区,创建后暂不支持修改分区数量。
-
[]Topic
Tag Args - Time
Format string - 时间格式
- Time
Key string - 时间字段名
- Topic
Id string - 日志主题 ID。
- Topic
Name string - 日志主题名称。
- Ttl int
- 日志在日志服务中的总保存时间,超过指定的日志存储时长后,此日志主题中的过期日志会被自动清除。单位为天,默认为 30 天。取值范围为 1~3650,指定为 3650 天表示永久存储。
- Updated
Time string - 日志主题修改时间。
- archive
Ttl Integer - 归档存储时长。该时长取值范围为 60~3650。满足如下任一条件时,可实现归档存储。标准存储时长 30 天及以上。标准存储时长 7 天及以上且低频存储时长 30 天及以上。此参数仅在 EnableHotTtl 为 true 时生效。
- auto
Split Boolean - 是否开启分区的自动分裂功能。true:当写入的数据量连续 5 分钟超过已有分区服务能力时,日志服务会根据数据量自动分裂分区以满足业务需求,但分裂后的分区数量不可超出最大分裂数。最近 15 分钟内分裂出来的新分区不会自动分裂。false:不开启分区的自动分裂。
- cold
Ttl Integer - 低频存储时长。该时长取值范围为 30~3650。标准存储时长 7 天及以上可实现低频存储。此参数仅在 EnableHotTtl 为 true 时生效。
- created
Time String - 日志主题创建时间。
- description String
- 日志主题描述信息。不支持 <>、'、\、\、所有 emoji 表情符号。长度为 0~64 个字符。
- enable
Hot BooleanTtl - 是否开启分层存储。开启后,日志服务支持标准存储、低频存储和归档存储。设置 HotTtl、ArchiveTtl、ColdTtl 后,如果数据存储时间超过对应时长,那么数据会自动沉降至低频存储、归档存储进行后续保存,直到日志采集到服务端的总时长达到 Ttl 时,被后端服务自动清理。
- enable
Tracking Boolean - 是否开启 WebTracking 功能,开启后,可以通过 WebTracking 快速采集前端埋点数据。true:开启 WebTracking功能。false:(默认)关闭 WebTracking 功能。为日志主题开启 Web Tracking 后,通过 API 接口 WebTracks 写入数据时无需经过鉴权,相当于面向公网开放了匿名写入权限,可能产生脏数据。
- hot
Ttl Integer - 标准存储时长。该时长默认为 30 天,取值范围为 7~3650。此参数仅在 EnableHotTtl 为 true 时生效。
- log
Public BooleanIp - 是否开启记录外网 IP 功能。默认为开启状态。开启后日志服务会自动在日志内容中添加以下元数据字段。tag****client_ip:日志来源设备的公网 IP 地址。使用日志服务的私网域名写入日志数据时,则记录私网 IP 地址。tag****receive_time:日志达到服务端的时间,格式为 10 位的 Unixtime 时间戳。
- max
Split IntegerShard - 分区的最大分裂数,即分区分裂后,所有分区的最大数量。取值范围为 1~256,默认为 256。仅在开启自动分裂日志分区,即 AutoSplit 为 true 时必选。MaxSplitShard 必须大于指定的 ShardCount,否则日志服务无法自动分裂分区。
- project
Id String - 日志主题所属的日志项目 ID。
- shard
Count Integer - 日志分区的数量,默认创建 1 个分区,取值范围为 1~10。 每个分区提供的写入能力为 5MiB/s、500 次/s,读取能力为 20 MiB/s、100 次/s。请在创建日志主题时合理规划分区,创建后暂不支持修改分区数量。
-
List<Topic
Tag> - time
Format String - 时间格式
- time
Key String - 时间字段名
- topic
Id String - 日志主题 ID。
- topic
Name String - 日志主题名称。
- ttl Integer
- 日志在日志服务中的总保存时间,超过指定的日志存储时长后,此日志主题中的过期日志会被自动清除。单位为天,默认为 30 天。取值范围为 1~3650,指定为 3650 天表示永久存储。
- updated
Time String - 日志主题修改时间。
- archive
Ttl number - 归档存储时长。该时长取值范围为 60~3650。满足如下任一条件时,可实现归档存储。标准存储时长 30 天及以上。标准存储时长 7 天及以上且低频存储时长 30 天及以上。此参数仅在 EnableHotTtl 为 true 时生效。
- auto
Split boolean - 是否开启分区的自动分裂功能。true:当写入的数据量连续 5 分钟超过已有分区服务能力时,日志服务会根据数据量自动分裂分区以满足业务需求,但分裂后的分区数量不可超出最大分裂数。最近 15 分钟内分裂出来的新分区不会自动分裂。false:不开启分区的自动分裂。
- cold
Ttl number - 低频存储时长。该时长取值范围为 30~3650。标准存储时长 7 天及以上可实现低频存储。此参数仅在 EnableHotTtl 为 true 时生效。
- created
Time string - 日志主题创建时间。
- description string
- 日志主题描述信息。不支持 <>、'、\、\、所有 emoji 表情符号。长度为 0~64 个字符。
- enable
Hot booleanTtl - 是否开启分层存储。开启后,日志服务支持标准存储、低频存储和归档存储。设置 HotTtl、ArchiveTtl、ColdTtl 后,如果数据存储时间超过对应时长,那么数据会自动沉降至低频存储、归档存储进行后续保存,直到日志采集到服务端的总时长达到 Ttl 时,被后端服务自动清理。
- enable
Tracking boolean - 是否开启 WebTracking 功能,开启后,可以通过 WebTracking 快速采集前端埋点数据。true:开启 WebTracking功能。false:(默认)关闭 WebTracking 功能。为日志主题开启 Web Tracking 后,通过 API 接口 WebTracks 写入数据时无需经过鉴权,相当于面向公网开放了匿名写入权限,可能产生脏数据。
- hot
Ttl number - 标准存储时长。该时长默认为 30 天,取值范围为 7~3650。此参数仅在 EnableHotTtl 为 true 时生效。
- log
Public booleanIp - 是否开启记录外网 IP 功能。默认为开启状态。开启后日志服务会自动在日志内容中添加以下元数据字段。tag****client_ip:日志来源设备的公网 IP 地址。使用日志服务的私网域名写入日志数据时,则记录私网 IP 地址。tag****receive_time:日志达到服务端的时间,格式为 10 位的 Unixtime 时间戳。
- max
Split numberShard - 分区的最大分裂数,即分区分裂后,所有分区的最大数量。取值范围为 1~256,默认为 256。仅在开启自动分裂日志分区,即 AutoSplit 为 true 时必选。MaxSplitShard 必须大于指定的 ShardCount,否则日志服务无法自动分裂分区。
- project
Id string - 日志主题所属的日志项目 ID。
- shard
Count number - 日志分区的数量,默认创建 1 个分区,取值范围为 1~10。 每个分区提供的写入能力为 5MiB/s、500 次/s,读取能力为 20 MiB/s、100 次/s。请在创建日志主题时合理规划分区,创建后暂不支持修改分区数量。
-
Topic
Tag[] - time
Format string - 时间格式
- time
Key string - 时间字段名
- topic
Id string - 日志主题 ID。
- topic
Name string - 日志主题名称。
- ttl number
- 日志在日志服务中的总保存时间,超过指定的日志存储时长后,此日志主题中的过期日志会被自动清除。单位为天,默认为 30 天。取值范围为 1~3650,指定为 3650 天表示永久存储。
- updated
Time string - 日志主题修改时间。
- archive_
ttl int - 归档存储时长。该时长取值范围为 60~3650。满足如下任一条件时,可实现归档存储。标准存储时长 30 天及以上。标准存储时长 7 天及以上且低频存储时长 30 天及以上。此参数仅在 EnableHotTtl 为 true 时生效。
- auto_
split bool - 是否开启分区的自动分裂功能。true:当写入的数据量连续 5 分钟超过已有分区服务能力时,日志服务会根据数据量自动分裂分区以满足业务需求,但分裂后的分区数量不可超出最大分裂数。最近 15 分钟内分裂出来的新分区不会自动分裂。false:不开启分区的自动分裂。
- cold_
ttl int - 低频存储时长。该时长取值范围为 30~3650。标准存储时长 7 天及以上可实现低频存储。此参数仅在 EnableHotTtl 为 true 时生效。
- created_
time str - 日志主题创建时间。
- description str
- 日志主题描述信息。不支持 <>、'、\、\、所有 emoji 表情符号。长度为 0~64 个字符。
- enable_
hot_ boolttl - 是否开启分层存储。开启后,日志服务支持标准存储、低频存储和归档存储。设置 HotTtl、ArchiveTtl、ColdTtl 后,如果数据存储时间超过对应时长,那么数据会自动沉降至低频存储、归档存储进行后续保存,直到日志采集到服务端的总时长达到 Ttl 时,被后端服务自动清理。
- enable_
tracking bool - 是否开启 WebTracking 功能,开启后,可以通过 WebTracking 快速采集前端埋点数据。true:开启 WebTracking功能。false:(默认)关闭 WebTracking 功能。为日志主题开启 Web Tracking 后,通过 API 接口 WebTracks 写入数据时无需经过鉴权,相当于面向公网开放了匿名写入权限,可能产生脏数据。
- hot_
ttl int - 标准存储时长。该时长默认为 30 天,取值范围为 7~3650。此参数仅在 EnableHotTtl 为 true 时生效。
- log_
public_ boolip - 是否开启记录外网 IP 功能。默认为开启状态。开启后日志服务会自动在日志内容中添加以下元数据字段。tag****client_ip:日志来源设备的公网 IP 地址。使用日志服务的私网域名写入日志数据时,则记录私网 IP 地址。tag****receive_time:日志达到服务端的时间,格式为 10 位的 Unixtime 时间戳。
- max_
split_ intshard - 分区的最大分裂数,即分区分裂后,所有分区的最大数量。取值范围为 1~256,默认为 256。仅在开启自动分裂日志分区,即 AutoSplit 为 true 时必选。MaxSplitShard 必须大于指定的 ShardCount,否则日志服务无法自动分裂分区。
- project_
id str - 日志主题所属的日志项目 ID。
- shard_
count int - 日志分区的数量,默认创建 1 个分区,取值范围为 1~10。 每个分区提供的写入能力为 5MiB/s、500 次/s,读取能力为 20 MiB/s、100 次/s。请在创建日志主题时合理规划分区,创建后暂不支持修改分区数量。
-
Sequence[Topic
Tag Args] - time_
format str - 时间格式
- time_
key str - 时间字段名
- topic_
id str - 日志主题 ID。
- topic_
name str - 日志主题名称。
- ttl int
- 日志在日志服务中的总保存时间,超过指定的日志存储时长后,此日志主题中的过期日志会被自动清除。单位为天,默认为 30 天。取值范围为 1~3650,指定为 3650 天表示永久存储。
- updated_
time str - 日志主题修改时间。
- archive
Ttl Number - 归档存储时长。该时长取值范围为 60~3650。满足如下任一条件时,可实现归档存储。标准存储时长 30 天及以上。标准存储时长 7 天及以上且低频存储时长 30 天及以上。此参数仅在 EnableHotTtl 为 true 时生效。
- auto
Split Boolean - 是否开启分区的自动分裂功能。true:当写入的数据量连续 5 分钟超过已有分区服务能力时,日志服务会根据数据量自动分裂分区以满足业务需求,但分裂后的分区数量不可超出最大分裂数。最近 15 分钟内分裂出来的新分区不会自动分裂。false:不开启分区的自动分裂。
- cold
Ttl Number - 低频存储时长。该时长取值范围为 30~3650。标准存储时长 7 天及以上可实现低频存储。此参数仅在 EnableHotTtl 为 true 时生效。
- created
Time String - 日志主题创建时间。
- description String
- 日志主题描述信息。不支持 <>、'、\、\、所有 emoji 表情符号。长度为 0~64 个字符。
- enable
Hot BooleanTtl - 是否开启分层存储。开启后,日志服务支持标准存储、低频存储和归档存储。设置 HotTtl、ArchiveTtl、ColdTtl 后,如果数据存储时间超过对应时长,那么数据会自动沉降至低频存储、归档存储进行后续保存,直到日志采集到服务端的总时长达到 Ttl 时,被后端服务自动清理。
- enable
Tracking Boolean - 是否开启 WebTracking 功能,开启后,可以通过 WebTracking 快速采集前端埋点数据。true:开启 WebTracking功能。false:(默认)关闭 WebTracking 功能。为日志主题开启 Web Tracking 后,通过 API 接口 WebTracks 写入数据时无需经过鉴权,相当于面向公网开放了匿名写入权限,可能产生脏数据。
- hot
Ttl Number - 标准存储时长。该时长默认为 30 天,取值范围为 7~3650。此参数仅在 EnableHotTtl 为 true 时生效。
- log
Public BooleanIp - 是否开启记录外网 IP 功能。默认为开启状态。开启后日志服务会自动在日志内容中添加以下元数据字段。tag****client_ip:日志来源设备的公网 IP 地址。使用日志服务的私网域名写入日志数据时,则记录私网 IP 地址。tag****receive_time:日志达到服务端的时间,格式为 10 位的 Unixtime 时间戳。
- max
Split NumberShard - 分区的最大分裂数,即分区分裂后,所有分区的最大数量。取值范围为 1~256,默认为 256。仅在开启自动分裂日志分区,即 AutoSplit 为 true 时必选。MaxSplitShard 必须大于指定的 ShardCount,否则日志服务无法自动分裂分区。
- project
Id String - 日志主题所属的日志项目 ID。
- shard
Count Number - 日志分区的数量,默认创建 1 个分区,取值范围为 1~10。 每个分区提供的写入能力为 5MiB/s、500 次/s,读取能力为 20 MiB/s、100 次/s。请在创建日志主题时合理规划分区,创建后暂不支持修改分区数量。
- List<Property Map>
- time
Format String - 时间格式
- time
Key String - 时间字段名
- topic
Id String - 日志主题 ID。
- topic
Name String - 日志主题名称。
- ttl Number
- 日志在日志服务中的总保存时间,超过指定的日志存储时长后,此日志主题中的过期日志会被自动清除。单位为天,默认为 30 天。取值范围为 1~3650,指定为 3650 天表示永久存储。
- updated
Time String - 日志主题修改时间。
Supporting Types
TopicTag, TopicTagArgs
Import
$ pulumi import volcenginecc:tls/topic:Topic example "topic_id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- volcenginecc volcengine/pulumi-volcenginecc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
volcengineccTerraform Provider.
