1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. tls
  5. getTopic
Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.tls.getTopic

bytepluscc logo
Viewing docs for bytepluscc v0.0.21
published on Thursday, Apr 2, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    Data Source schema for Byteplus::TLS::Topic

    Using getTopic

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getTopic(args: GetTopicArgs, opts?: InvokeOptions): Promise<GetTopicResult>
function getTopicOutput(args: GetTopicOutputArgs, opts?: InvokeOptions): Output<GetTopicResult>
    def get_topic(id: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetTopicResult
def get_topic_output(id: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetTopicResult]
    func LookupTopic(ctx *Context, args *LookupTopicArgs, opts ...InvokeOption) (*LookupTopicResult, error)
func LookupTopicOutput(ctx *Context, args *LookupTopicOutputArgs, opts ...InvokeOption) LookupTopicResultOutput

    > Note: This function is named LookupTopic in the Go SDK.

    public static class GetTopic 
{
    public static Task<GetTopicResult> InvokeAsync(GetTopicArgs args, InvokeOptions? opts = null)
    public static Output<GetTopicResult> Invoke(GetTopicInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetTopicResult> getTopic(GetTopicArgs args, InvokeOptions options)
public static Output<GetTopicResult> getTopic(GetTopicArgs args, InvokeOptions options)

    fn::invoke:
  function: bytepluscc:tls/getTopic:getTopic
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    Uniquely identifies the resource.
    Id string
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.
    id string
    Uniquely identifies the resource.
    id str
    Uniquely identifies the resource.
    id String
    Uniquely identifies the resource.

    getTopic Result

    The following output properties are available:

    AllowConsume bool
    Indicates whether Kafka protocol consumption is enabled for the log topic. true: enabled. false: not enabled.
    ArchiveTtl int
    Archive storage duration. The value range is 60~3650. Archive storage can be enabled if any of the following conditions are met: Standard storage duration is 30 days or longer; standard storage duration is 7 days or longer and infrequent storage duration is 30 days or longer. This parameter is only effective when EnableHotTtl is set to true.
    AutoSplit bool
    Enable automatic partition splitting. true: If the amount of data written exceeds the capacity of existing partitions for 5 consecutive minutes, the log service will automatically split partitions based on data volume to meet business needs, but the number of partitions after splitting cannot exceed the maximum split limit. New partitions created within the last 15 minutes will not be automatically split. false: Disable automatic partition splitting.
    ColdTtl int
    Low-frequency storage duration. Value range: 30–3650. Low-frequency storage is available when standard storage duration is 7 days or longer. This parameter is effective only when EnableHotTtl is true.
    ConsumeTopic string
    Kafka protocol consumption topic ID, formatted as out+log topic ID. When consuming log data from this log topic via the Kafka protocol, set Topic to this ID.
    CreatedTime string
    Log topic creation time.
    Description string
    Log topic description. Does not support <>, ', , , or any emoji symbols. Length: 0–64 characters.
    EnableHotTtl bool
    Enable tiered storage. When enabled, the log service supports standard storage, low-frequency storage, and archive storage. After setting HotTtl, ArchiveTtl, and ColdTtl, if data storage duration exceeds the corresponding value, data will automatically move to low-frequency or archive storage for continued retention until the total log retention duration reaches Ttl, after which backend services will automatically clean up the data.
    EnableTracking bool
    Enable WebTracking. When enabled, you can quickly collect frontend tracking data using WebTracking. true: Enable WebTracking. false (default): Disable WebTracking. After enabling Web Tracking for the log topic, data written via the WebTracks API does not require authentication, which grants anonymous write access to the public network and may result in dirty data.
    HotTtl int
    Standard storage duration. Default is 30 days; value range: 7–3650. This parameter is effective only when EnableHotTtl is true.
    Id string
    Uniquely identifies the resource.
    LogPublicIp bool
    Enable external IP recording. Enabled by default. When enabled, the log service automatically adds the following metadata fields to the log content: tag****client_ip: Public IP address of the device sending the log. If logs are written using the log service's private domain name, the private IP address is recorded. tag****receive_time: Time when the log reaches the server, formatted as a 10-digit Unix timestamp.
    MaxSplitShard int
    Maximum partition split count, which is the maximum number of partitions after splitting. Value range: 1–256, default is 256. Required only when automatic log partition splitting is enabled (AutoSplit is true). MaxSplitShard must be greater than the specified ShardCount; otherwise, the log service cannot automatically split partitions.
    ProjectId string
    Log project ID to which the log topic belongs.
    ShardCount int
    Number of log partitions. By default, 1 partition is created; value range: 1–10. Each partition provides write capacity of 5 MiB/s, 500 ops/s, and read capacity of 20 MiB/s, 100 ops/s. Plan partitions appropriately when creating a log topic; partition count cannot be modified after creation.
    Tags List<Byteplus.GetTopicTag>
    Tag list.
    TimeFormat string
    Time format
    TimeKey string
    Time field name
    TopicId string
    Log topic ID.
    TopicName string
    Log topic name.
    Ttl int
    Total log retention time in the log service. After the specified log storage duration is exceeded, expired logs in this log topic will be automatically cleared. Unit: days. Default is 30 days. Value range is 1–3650. Setting to 3650 days means permanent storage.
    UpdatedTime string
    Log topic modification time.
    AllowConsume bool
    Indicates whether Kafka protocol consumption is enabled for the log topic. true: enabled. false: not enabled.
    ArchiveTtl int
    Archive storage duration. The value range is 60~3650. Archive storage can be enabled if any of the following conditions are met: Standard storage duration is 30 days or longer; standard storage duration is 7 days or longer and infrequent storage duration is 30 days or longer. This parameter is only effective when EnableHotTtl is set to true.
    AutoSplit bool
    Enable automatic partition splitting. true: If the amount of data written exceeds the capacity of existing partitions for 5 consecutive minutes, the log service will automatically split partitions based on data volume to meet business needs, but the number of partitions after splitting cannot exceed the maximum split limit. New partitions created within the last 15 minutes will not be automatically split. false: Disable automatic partition splitting.
    ColdTtl int
    Low-frequency storage duration. Value range: 30–3650. Low-frequency storage is available when standard storage duration is 7 days or longer. This parameter is effective only when EnableHotTtl is true.
    ConsumeTopic string
    Kafka protocol consumption topic ID, formatted as out+log topic ID. When consuming log data from this log topic via the Kafka protocol, set Topic to this ID.
    CreatedTime string
    Log topic creation time.
    Description string
    Log topic description. Does not support <>, ', , , or any emoji symbols. Length: 0–64 characters.
    EnableHotTtl bool
    Enable tiered storage. When enabled, the log service supports standard storage, low-frequency storage, and archive storage. After setting HotTtl, ArchiveTtl, and ColdTtl, if data storage duration exceeds the corresponding value, data will automatically move to low-frequency or archive storage for continued retention until the total log retention duration reaches Ttl, after which backend services will automatically clean up the data.
    EnableTracking bool
    Enable WebTracking. When enabled, you can quickly collect frontend tracking data using WebTracking. true: Enable WebTracking. false (default): Disable WebTracking. After enabling Web Tracking for the log topic, data written via the WebTracks API does not require authentication, which grants anonymous write access to the public network and may result in dirty data.
    HotTtl int
    Standard storage duration. Default is 30 days; value range: 7–3650. This parameter is effective only when EnableHotTtl is true.
    Id string
    Uniquely identifies the resource.
    LogPublicIp bool
    Enable external IP recording. Enabled by default. When enabled, the log service automatically adds the following metadata fields to the log content: tag****client_ip: Public IP address of the device sending the log. If logs are written using the log service's private domain name, the private IP address is recorded. tag****receive_time: Time when the log reaches the server, formatted as a 10-digit Unix timestamp.
    MaxSplitShard int
    Maximum partition split count, which is the maximum number of partitions after splitting. Value range: 1–256, default is 256. Required only when automatic log partition splitting is enabled (AutoSplit is true). MaxSplitShard must be greater than the specified ShardCount; otherwise, the log service cannot automatically split partitions.
    ProjectId string
    Log project ID to which the log topic belongs.
    ShardCount int
    Number of log partitions. By default, 1 partition is created; value range: 1–10. Each partition provides write capacity of 5 MiB/s, 500 ops/s, and read capacity of 20 MiB/s, 100 ops/s. Plan partitions appropriately when creating a log topic; partition count cannot be modified after creation.
    Tags []GetTopicTag
    Tag list.
    TimeFormat string
    Time format
    TimeKey string
    Time field name
    TopicId string
    Log topic ID.
    TopicName string
    Log topic name.
    Ttl int
    Total log retention time in the log service. After the specified log storage duration is exceeded, expired logs in this log topic will be automatically cleared. Unit: days. Default is 30 days. Value range is 1–3650. Setting to 3650 days means permanent storage.
    UpdatedTime string
    Log topic modification time.
    allowConsume Boolean
    Indicates whether Kafka protocol consumption is enabled for the log topic. true: enabled. false: not enabled.
    archiveTtl Integer
    Archive storage duration. The value range is 60~3650. Archive storage can be enabled if any of the following conditions are met: Standard storage duration is 30 days or longer; standard storage duration is 7 days or longer and infrequent storage duration is 30 days or longer. This parameter is only effective when EnableHotTtl is set to true.
    autoSplit Boolean
    Enable automatic partition splitting. true: If the amount of data written exceeds the capacity of existing partitions for 5 consecutive minutes, the log service will automatically split partitions based on data volume to meet business needs, but the number of partitions after splitting cannot exceed the maximum split limit. New partitions created within the last 15 minutes will not be automatically split. false: Disable automatic partition splitting.
    coldTtl Integer
    Low-frequency storage duration. Value range: 30–3650. Low-frequency storage is available when standard storage duration is 7 days or longer. This parameter is effective only when EnableHotTtl is true.
    consumeTopic String
    Kafka protocol consumption topic ID, formatted as out+log topic ID. When consuming log data from this log topic via the Kafka protocol, set Topic to this ID.
    createdTime String
    Log topic creation time.
    description String
    Log topic description. Does not support <>, ', , , or any emoji symbols. Length: 0–64 characters.
    enableHotTtl Boolean
    Enable tiered storage. When enabled, the log service supports standard storage, low-frequency storage, and archive storage. After setting HotTtl, ArchiveTtl, and ColdTtl, if data storage duration exceeds the corresponding value, data will automatically move to low-frequency or archive storage for continued retention until the total log retention duration reaches Ttl, after which backend services will automatically clean up the data.
    enableTracking Boolean
    Enable WebTracking. When enabled, you can quickly collect frontend tracking data using WebTracking. true: Enable WebTracking. false (default): Disable WebTracking. After enabling Web Tracking for the log topic, data written via the WebTracks API does not require authentication, which grants anonymous write access to the public network and may result in dirty data.
    hotTtl Integer
    Standard storage duration. Default is 30 days; value range: 7–3650. This parameter is effective only when EnableHotTtl is true.
    id String
    Uniquely identifies the resource.
    logPublicIp Boolean
    Enable external IP recording. Enabled by default. When enabled, the log service automatically adds the following metadata fields to the log content: tag****client_ip: Public IP address of the device sending the log. If logs are written using the log service's private domain name, the private IP address is recorded. tag****receive_time: Time when the log reaches the server, formatted as a 10-digit Unix timestamp.
    maxSplitShard Integer
    Maximum partition split count, which is the maximum number of partitions after splitting. Value range: 1–256, default is 256. Required only when automatic log partition splitting is enabled (AutoSplit is true). MaxSplitShard must be greater than the specified ShardCount; otherwise, the log service cannot automatically split partitions.
    projectId String
    Log project ID to which the log topic belongs.
    shardCount Integer
    Number of log partitions. By default, 1 partition is created; value range: 1–10. Each partition provides write capacity of 5 MiB/s, 500 ops/s, and read capacity of 20 MiB/s, 100 ops/s. Plan partitions appropriately when creating a log topic; partition count cannot be modified after creation.
    tags List<GetTopicTag>
    Tag list.
    timeFormat String
    Time format
    timeKey String
    Time field name
    topicId String
    Log topic ID.
    topicName String
    Log topic name.
    ttl Integer
    Total log retention time in the log service. After the specified log storage duration is exceeded, expired logs in this log topic will be automatically cleared. Unit: days. Default is 30 days. Value range is 1–3650. Setting to 3650 days means permanent storage.
    updatedTime String
    Log topic modification time.
    allowConsume boolean
    Indicates whether Kafka protocol consumption is enabled for the log topic. true: enabled. false: not enabled.
    archiveTtl number
    Archive storage duration. The value range is 60~3650. Archive storage can be enabled if any of the following conditions are met: Standard storage duration is 30 days or longer; standard storage duration is 7 days or longer and infrequent storage duration is 30 days or longer. This parameter is only effective when EnableHotTtl is set to true.
    autoSplit boolean
    Enable automatic partition splitting. true: If the amount of data written exceeds the capacity of existing partitions for 5 consecutive minutes, the log service will automatically split partitions based on data volume to meet business needs, but the number of partitions after splitting cannot exceed the maximum split limit. New partitions created within the last 15 minutes will not be automatically split. false: Disable automatic partition splitting.
    coldTtl number
    Low-frequency storage duration. Value range: 30–3650. Low-frequency storage is available when standard storage duration is 7 days or longer. This parameter is effective only when EnableHotTtl is true.
    consumeTopic string
    Kafka protocol consumption topic ID, formatted as out+log topic ID. When consuming log data from this log topic via the Kafka protocol, set Topic to this ID.
    createdTime string
    Log topic creation time.
    description string
    Log topic description. Does not support <>, ', , , or any emoji symbols. Length: 0–64 characters.
    enableHotTtl boolean
    Enable tiered storage. When enabled, the log service supports standard storage, low-frequency storage, and archive storage. After setting HotTtl, ArchiveTtl, and ColdTtl, if data storage duration exceeds the corresponding value, data will automatically move to low-frequency or archive storage for continued retention until the total log retention duration reaches Ttl, after which backend services will automatically clean up the data.
    enableTracking boolean
    Enable WebTracking. When enabled, you can quickly collect frontend tracking data using WebTracking. true: Enable WebTracking. false (default): Disable WebTracking. After enabling Web Tracking for the log topic, data written via the WebTracks API does not require authentication, which grants anonymous write access to the public network and may result in dirty data.
    hotTtl number
    Standard storage duration. Default is 30 days; value range: 7–3650. This parameter is effective only when EnableHotTtl is true.
    id string
    Uniquely identifies the resource.
    logPublicIp boolean
    Enable external IP recording. Enabled by default. When enabled, the log service automatically adds the following metadata fields to the log content: tag****client_ip: Public IP address of the device sending the log. If logs are written using the log service's private domain name, the private IP address is recorded. tag****receive_time: Time when the log reaches the server, formatted as a 10-digit Unix timestamp.
    maxSplitShard number
    Maximum partition split count, which is the maximum number of partitions after splitting. Value range: 1–256, default is 256. Required only when automatic log partition splitting is enabled (AutoSplit is true). MaxSplitShard must be greater than the specified ShardCount; otherwise, the log service cannot automatically split partitions.
    projectId string
    Log project ID to which the log topic belongs.
    shardCount number
    Number of log partitions. By default, 1 partition is created; value range: 1–10. Each partition provides write capacity of 5 MiB/s, 500 ops/s, and read capacity of 20 MiB/s, 100 ops/s. Plan partitions appropriately when creating a log topic; partition count cannot be modified after creation.
    tags GetTopicTag[]
    Tag list.
    timeFormat string
    Time format
    timeKey string
    Time field name
    topicId string
    Log topic ID.
    topicName string
    Log topic name.
    ttl number
    Total log retention time in the log service. After the specified log storage duration is exceeded, expired logs in this log topic will be automatically cleared. Unit: days. Default is 30 days. Value range is 1–3650. Setting to 3650 days means permanent storage.
    updatedTime string
    Log topic modification time.
    allow_consume bool
    Indicates whether Kafka protocol consumption is enabled for the log topic. true: enabled. false: not enabled.
    archive_ttl int
    Archive storage duration. The value range is 60~3650. Archive storage can be enabled if any of the following conditions are met: Standard storage duration is 30 days or longer; standard storage duration is 7 days or longer and infrequent storage duration is 30 days or longer. This parameter is only effective when EnableHotTtl is set to true.
    auto_split bool
    Enable automatic partition splitting. true: If the amount of data written exceeds the capacity of existing partitions for 5 consecutive minutes, the log service will automatically split partitions based on data volume to meet business needs, but the number of partitions after splitting cannot exceed the maximum split limit. New partitions created within the last 15 minutes will not be automatically split. false: Disable automatic partition splitting.
    cold_ttl int
    Low-frequency storage duration. Value range: 30–3650. Low-frequency storage is available when standard storage duration is 7 days or longer. This parameter is effective only when EnableHotTtl is true.
    consume_topic str
    Kafka protocol consumption topic ID, formatted as out+log topic ID. When consuming log data from this log topic via the Kafka protocol, set Topic to this ID.
    created_time str
    Log topic creation time.
    description str
    Log topic description. Does not support <>, ', , , or any emoji symbols. Length: 0–64 characters.
    enable_hot_ttl bool
    Enable tiered storage. When enabled, the log service supports standard storage, low-frequency storage, and archive storage. After setting HotTtl, ArchiveTtl, and ColdTtl, if data storage duration exceeds the corresponding value, data will automatically move to low-frequency or archive storage for continued retention until the total log retention duration reaches Ttl, after which backend services will automatically clean up the data.
    enable_tracking bool
    Enable WebTracking. When enabled, you can quickly collect frontend tracking data using WebTracking. true: Enable WebTracking. false (default): Disable WebTracking. After enabling Web Tracking for the log topic, data written via the WebTracks API does not require authentication, which grants anonymous write access to the public network and may result in dirty data.
    hot_ttl int
    Standard storage duration. Default is 30 days; value range: 7–3650. This parameter is effective only when EnableHotTtl is true.
    id str
    Uniquely identifies the resource.
    log_public_ip bool
    Enable external IP recording. Enabled by default. When enabled, the log service automatically adds the following metadata fields to the log content: tag****client_ip: Public IP address of the device sending the log. If logs are written using the log service's private domain name, the private IP address is recorded. tag****receive_time: Time when the log reaches the server, formatted as a 10-digit Unix timestamp.
    max_split_shard int
    Maximum partition split count, which is the maximum number of partitions after splitting. Value range: 1–256, default is 256. Required only when automatic log partition splitting is enabled (AutoSplit is true). MaxSplitShard must be greater than the specified ShardCount; otherwise, the log service cannot automatically split partitions.
    project_id str
    Log project ID to which the log topic belongs.
    shard_count int
    Number of log partitions. By default, 1 partition is created; value range: 1–10. Each partition provides write capacity of 5 MiB/s, 500 ops/s, and read capacity of 20 MiB/s, 100 ops/s. Plan partitions appropriately when creating a log topic; partition count cannot be modified after creation.
    tags Sequence[GetTopicTag]
    Tag list.
    time_format str
    Time format
    time_key str
    Time field name
    topic_id str
    Log topic ID.
    topic_name str
    Log topic name.
    ttl int
    Total log retention time in the log service. After the specified log storage duration is exceeded, expired logs in this log topic will be automatically cleared. Unit: days. Default is 30 days. Value range is 1–3650. Setting to 3650 days means permanent storage.
    updated_time str
    Log topic modification time.
    allowConsume Boolean
    Indicates whether Kafka protocol consumption is enabled for the log topic. true: enabled. false: not enabled.
    archiveTtl Number
    Archive storage duration. The value range is 60~3650. Archive storage can be enabled if any of the following conditions are met: Standard storage duration is 30 days or longer; standard storage duration is 7 days or longer and infrequent storage duration is 30 days or longer. This parameter is only effective when EnableHotTtl is set to true.
    autoSplit Boolean
    Enable automatic partition splitting. true: If the amount of data written exceeds the capacity of existing partitions for 5 consecutive minutes, the log service will automatically split partitions based on data volume to meet business needs, but the number of partitions after splitting cannot exceed the maximum split limit. New partitions created within the last 15 minutes will not be automatically split. false: Disable automatic partition splitting.
    coldTtl Number
    Low-frequency storage duration. Value range: 30–3650. Low-frequency storage is available when standard storage duration is 7 days or longer. This parameter is effective only when EnableHotTtl is true.
    consumeTopic String
    Kafka protocol consumption topic ID, formatted as out+log topic ID. When consuming log data from this log topic via the Kafka protocol, set Topic to this ID.
    createdTime String
    Log topic creation time.
    description String
    Log topic description. Does not support <>, ', , , or any emoji symbols. Length: 0–64 characters.
    enableHotTtl Boolean
    Enable tiered storage. When enabled, the log service supports standard storage, low-frequency storage, and archive storage. After setting HotTtl, ArchiveTtl, and ColdTtl, if data storage duration exceeds the corresponding value, data will automatically move to low-frequency or archive storage for continued retention until the total log retention duration reaches Ttl, after which backend services will automatically clean up the data.
    enableTracking Boolean
    Enable WebTracking. When enabled, you can quickly collect frontend tracking data using WebTracking. true: Enable WebTracking. false (default): Disable WebTracking. After enabling Web Tracking for the log topic, data written via the WebTracks API does not require authentication, which grants anonymous write access to the public network and may result in dirty data.
    hotTtl Number
    Standard storage duration. Default is 30 days; value range: 7–3650. This parameter is effective only when EnableHotTtl is true.
    id String
    Uniquely identifies the resource.
    logPublicIp Boolean
    Enable external IP recording. Enabled by default. When enabled, the log service automatically adds the following metadata fields to the log content: tag****client_ip: Public IP address of the device sending the log. If logs are written using the log service's private domain name, the private IP address is recorded. tag****receive_time: Time when the log reaches the server, formatted as a 10-digit Unix timestamp.
    maxSplitShard Number
    Maximum partition split count, which is the maximum number of partitions after splitting. Value range: 1–256, default is 256. Required only when automatic log partition splitting is enabled (AutoSplit is true). MaxSplitShard must be greater than the specified ShardCount; otherwise, the log service cannot automatically split partitions.
    projectId String
    Log project ID to which the log topic belongs.
    shardCount Number
    Number of log partitions. By default, 1 partition is created; value range: 1–10. Each partition provides write capacity of 5 MiB/s, 500 ops/s, and read capacity of 20 MiB/s, 100 ops/s. Plan partitions appropriately when creating a log topic; partition count cannot be modified after creation.
    tags List<Property Map>
    Tag list.
    timeFormat String
    Time format
    timeKey String
    Time field name
    topicId String
    Log topic ID.
    topicName String
    Log topic name.
    ttl Number
    Total log retention time in the log service. After the specified log storage duration is exceeded, expired logs in this log topic will be automatically cleared. Unit: days. Default is 30 days. Value range is 1–3650. Setting to 3650 days means permanent storage.
    updatedTime String
    Log topic modification time.

    Supporting Types

    GetTopicTag

    Key string
    User tag key.
    Value string
    User tag value.
    Key string
    User tag key.
    Value string
    User tag value.
    key String
    User tag key.
    value String
    User tag value.
    key string
    User tag key.
    value string
    User tag value.
    key str
    User tag key.
    value str
    User tag value.
    key String
    User tag key.
    value String
    User tag value.

    Package Details

    Repository
    bytepluscc byteplus-sdk/pulumi-bytepluscc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the bytepluscc Terraform Provider.
    bytepluscc logo
    Viewing docs for bytepluscc v0.0.21
    published on Thursday, Apr 2, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc
      Try Pulumi Cloud free. Your team will thank you.