1. Packages
  2. Bytepluscc Provider
  3. API Docs
  4. kafka
  5. getTopic
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

bytepluscc.kafka.getTopic

bytepluscc logo
Viewing docs for bytepluscc v0.0.16
published on Monday, Mar 9, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    Data Source schema for Byteplus::Kafka::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:kafka/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:

    AccessPolicies List<Byteplus.GetTopicAccessPolicy>
    自定义权限配置，即为某些用户设置对于此 Topic 的自定义权限。仅在 AllAuthority 为 False 时需要设置。
    AllAuthority bool
    待创建的Topic默认是否对所有用户都开启读写权限。true：（默认）所有用户都具备此 Topic 的读写权限。false：并非所有用户都具备此 Topic 的读写权限。默认情况下，用户对于此 Topic 的权限沿用用户的默认权限，如果默认权限不满足需求，您也可以通过 AccessPolicies 指定某个用户对于此 Topic 的自定义权限。
    CleanupPolicies List<string>
    Topic 的消息清理策略，支持以下三种取值方式：[delete]：默认的消息清理策略。在磁盘容量充足的情况下，保留在最长保留时间范围内的消息；在磁盘容量不足时，将提前删除旧消息，以保证服务可用性。[compact]：COMPACT 消息清理策略针对每个消息的 Key 进行整合，对于有相同 Key 的消息，只保留最新的 value 值，旧的记录则会被清除。[delete,compact]：同时配置 DELETE 和 COMPACT 两种消息清理策略。只要消息满足任一条清理策略时，都将被清除。
    CreatedTime string
    Topic 的创建时间。
    Description string
    Topic 的描述信息。长度不超过 128 个字符。
    Id string
    Uniquely identifies the resource.
    InstanceId string
    实例 ID。
    LogRetentionHours int
    消息保留时长，单位小时。Topic维度的消息保留时长，取值范围：1 - 2160小时（90天）。
    Parameters string
    Topic 级别的参数配置。Parameters 参数说明 MinInsyncReplicaNumber:2：最小同步副本个数。当同步副本个数小于配置值时，消息将无法写入对应 Topic。配置值越大，数据可靠性增加，但是可用性将会降低。默认值为副本数减 1。考虑到 Topic 的可用性，建议设置为副本数减 1。MessageMaxByte:12：最大消息大小。单位为 MB，取值范围为 1～12。默认沿用实例的最大消息大小设置。LogRetentionHours:72：消息保留时长。单位为小时，取值范围为 0～2160，即消息最久保留 90 天。默认沿用实例的消息保留时长设置。
    PartitionNumber int
    Topic 分区数。取值范围为 1~300，如果实例中已创建了其他 Topic，则所有 Topic 的分区数之和不超过该实例的分区数上限。如果分区数无法满足业务需求，您可以购买更多分区，提升实例的分区数量上限。
    ReplicaNumber int
    Topic 副本个数。可设置为为 2 或 3，默认值为 3。
    Status string
    Topic 的状态。
    Tags List<Byteplus.GetTopicTag>
    Topic 的标签信息
    TopicName string
    待创建的 Topic 名称。3～64 个字符。必须以英文或数字开头。支持的字符包括英文、数字、连字符（-）、下划线（_）和英文句号（.）。
    UsedStoragePercentageInInstance double
    当前 Topic 总数据量占实例总存储空间的比例，控制台页面显示为保留两位小数的百分数。
    UsedStorageSpaceInBytes int
    当前 Topic 已使用的总存储空间大小。
    AccessPolicies []GetTopicAccessPolicy
    自定义权限配置，即为某些用户设置对于此 Topic 的自定义权限。仅在 AllAuthority 为 False 时需要设置。
    AllAuthority bool
    待创建的Topic默认是否对所有用户都开启读写权限。true：（默认）所有用户都具备此 Topic 的读写权限。false：并非所有用户都具备此 Topic 的读写权限。默认情况下，用户对于此 Topic 的权限沿用用户的默认权限，如果默认权限不满足需求，您也可以通过 AccessPolicies 指定某个用户对于此 Topic 的自定义权限。
    CleanupPolicies []string
    Topic 的消息清理策略，支持以下三种取值方式：[delete]：默认的消息清理策略。在磁盘容量充足的情况下，保留在最长保留时间范围内的消息；在磁盘容量不足时，将提前删除旧消息，以保证服务可用性。[compact]：COMPACT 消息清理策略针对每个消息的 Key 进行整合，对于有相同 Key 的消息，只保留最新的 value 值，旧的记录则会被清除。[delete,compact]：同时配置 DELETE 和 COMPACT 两种消息清理策略。只要消息满足任一条清理策略时，都将被清除。
    CreatedTime string
    Topic 的创建时间。
    Description string
    Topic 的描述信息。长度不超过 128 个字符。
    Id string
    Uniquely identifies the resource.
    InstanceId string
    实例 ID。
    LogRetentionHours int
    消息保留时长，单位小时。Topic维度的消息保留时长，取值范围：1 - 2160小时（90天）。
    Parameters string
    Topic 级别的参数配置。Parameters 参数说明 MinInsyncReplicaNumber:2：最小同步副本个数。当同步副本个数小于配置值时，消息将无法写入对应 Topic。配置值越大，数据可靠性增加，但是可用性将会降低。默认值为副本数减 1。考虑到 Topic 的可用性，建议设置为副本数减 1。MessageMaxByte:12：最大消息大小。单位为 MB，取值范围为 1～12。默认沿用实例的最大消息大小设置。LogRetentionHours:72：消息保留时长。单位为小时，取值范围为 0～2160，即消息最久保留 90 天。默认沿用实例的消息保留时长设置。
    PartitionNumber int
    Topic 分区数。取值范围为 1~300，如果实例中已创建了其他 Topic，则所有 Topic 的分区数之和不超过该实例的分区数上限。如果分区数无法满足业务需求，您可以购买更多分区，提升实例的分区数量上限。
    ReplicaNumber int
    Topic 副本个数。可设置为为 2 或 3，默认值为 3。
    Status string
    Topic 的状态。
    Tags []GetTopicTag
    Topic 的标签信息
    TopicName string
    待创建的 Topic 名称。3～64 个字符。必须以英文或数字开头。支持的字符包括英文、数字、连字符（-）、下划线（_）和英文句号（.）。
    UsedStoragePercentageInInstance float64
    当前 Topic 总数据量占实例总存储空间的比例，控制台页面显示为保留两位小数的百分数。
    UsedStorageSpaceInBytes int
    当前 Topic 已使用的总存储空间大小。
    accessPolicies List<GetTopicAccessPolicy>
    自定义权限配置，即为某些用户设置对于此 Topic 的自定义权限。仅在 AllAuthority 为 False 时需要设置。
    allAuthority Boolean
    待创建的Topic默认是否对所有用户都开启读写权限。true：（默认）所有用户都具备此 Topic 的读写权限。false：并非所有用户都具备此 Topic 的读写权限。默认情况下，用户对于此 Topic 的权限沿用用户的默认权限，如果默认权限不满足需求，您也可以通过 AccessPolicies 指定某个用户对于此 Topic 的自定义权限。
    cleanupPolicies List<String>
    Topic 的消息清理策略，支持以下三种取值方式：[delete]：默认的消息清理策略。在磁盘容量充足的情况下，保留在最长保留时间范围内的消息；在磁盘容量不足时，将提前删除旧消息，以保证服务可用性。[compact]：COMPACT 消息清理策略针对每个消息的 Key 进行整合，对于有相同 Key 的消息，只保留最新的 value 值，旧的记录则会被清除。[delete,compact]：同时配置 DELETE 和 COMPACT 两种消息清理策略。只要消息满足任一条清理策略时，都将被清除。
    createdTime String
    Topic 的创建时间。
    description String
    Topic 的描述信息。长度不超过 128 个字符。
    id String
    Uniquely identifies the resource.
    instanceId String
    实例 ID。
    logRetentionHours Integer
    消息保留时长，单位小时。Topic维度的消息保留时长，取值范围：1 - 2160小时（90天）。
    parameters String
    Topic 级别的参数配置。Parameters 参数说明 MinInsyncReplicaNumber:2：最小同步副本个数。当同步副本个数小于配置值时，消息将无法写入对应 Topic。配置值越大，数据可靠性增加，但是可用性将会降低。默认值为副本数减 1。考虑到 Topic 的可用性，建议设置为副本数减 1。MessageMaxByte:12：最大消息大小。单位为 MB，取值范围为 1～12。默认沿用实例的最大消息大小设置。LogRetentionHours:72：消息保留时长。单位为小时，取值范围为 0～2160，即消息最久保留 90 天。默认沿用实例的消息保留时长设置。
    partitionNumber Integer
    Topic 分区数。取值范围为 1~300，如果实例中已创建了其他 Topic，则所有 Topic 的分区数之和不超过该实例的分区数上限。如果分区数无法满足业务需求，您可以购买更多分区，提升实例的分区数量上限。
    replicaNumber Integer
    Topic 副本个数。可设置为为 2 或 3，默认值为 3。
    status String
    Topic 的状态。
    tags List<GetTopicTag>
    Topic 的标签信息
    topicName String
    待创建的 Topic 名称。3～64 个字符。必须以英文或数字开头。支持的字符包括英文、数字、连字符（-）、下划线（_）和英文句号（.）。
    usedStoragePercentageInInstance Double
    当前 Topic 总数据量占实例总存储空间的比例，控制台页面显示为保留两位小数的百分数。
    usedStorageSpaceInBytes Integer
    当前 Topic 已使用的总存储空间大小。
    accessPolicies GetTopicAccessPolicy[]
    自定义权限配置，即为某些用户设置对于此 Topic 的自定义权限。仅在 AllAuthority 为 False 时需要设置。
    allAuthority boolean
    待创建的Topic默认是否对所有用户都开启读写权限。true：（默认）所有用户都具备此 Topic 的读写权限。false：并非所有用户都具备此 Topic 的读写权限。默认情况下，用户对于此 Topic 的权限沿用用户的默认权限，如果默认权限不满足需求，您也可以通过 AccessPolicies 指定某个用户对于此 Topic 的自定义权限。
    cleanupPolicies string[]
    Topic 的消息清理策略，支持以下三种取值方式：[delete]：默认的消息清理策略。在磁盘容量充足的情况下，保留在最长保留时间范围内的消息；在磁盘容量不足时，将提前删除旧消息，以保证服务可用性。[compact]：COMPACT 消息清理策略针对每个消息的 Key 进行整合，对于有相同 Key 的消息，只保留最新的 value 值，旧的记录则会被清除。[delete,compact]：同时配置 DELETE 和 COMPACT 两种消息清理策略。只要消息满足任一条清理策略时，都将被清除。
    createdTime string
    Topic 的创建时间。
    description string
    Topic 的描述信息。长度不超过 128 个字符。
    id string
    Uniquely identifies the resource.
    instanceId string
    实例 ID。
    logRetentionHours number
    消息保留时长，单位小时。Topic维度的消息保留时长，取值范围：1 - 2160小时（90天）。
    parameters string
    Topic 级别的参数配置。Parameters 参数说明 MinInsyncReplicaNumber:2：最小同步副本个数。当同步副本个数小于配置值时，消息将无法写入对应 Topic。配置值越大，数据可靠性增加，但是可用性将会降低。默认值为副本数减 1。考虑到 Topic 的可用性，建议设置为副本数减 1。MessageMaxByte:12：最大消息大小。单位为 MB，取值范围为 1～12。默认沿用实例的最大消息大小设置。LogRetentionHours:72：消息保留时长。单位为小时，取值范围为 0～2160，即消息最久保留 90 天。默认沿用实例的消息保留时长设置。
    partitionNumber number
    Topic 分区数。取值范围为 1~300，如果实例中已创建了其他 Topic，则所有 Topic 的分区数之和不超过该实例的分区数上限。如果分区数无法满足业务需求，您可以购买更多分区，提升实例的分区数量上限。
    replicaNumber number
    Topic 副本个数。可设置为为 2 或 3，默认值为 3。
    status string
    Topic 的状态。
    tags GetTopicTag[]
    Topic 的标签信息
    topicName string
    待创建的 Topic 名称。3～64 个字符。必须以英文或数字开头。支持的字符包括英文、数字、连字符（-）、下划线（_）和英文句号（.）。
    usedStoragePercentageInInstance number
    当前 Topic 总数据量占实例总存储空间的比例，控制台页面显示为保留两位小数的百分数。
    usedStorageSpaceInBytes number
    当前 Topic 已使用的总存储空间大小。
    access_policies Sequence[GetTopicAccessPolicy]
    自定义权限配置，即为某些用户设置对于此 Topic 的自定义权限。仅在 AllAuthority 为 False 时需要设置。
    all_authority bool
    待创建的Topic默认是否对所有用户都开启读写权限。true：（默认）所有用户都具备此 Topic 的读写权限。false：并非所有用户都具备此 Topic 的读写权限。默认情况下，用户对于此 Topic 的权限沿用用户的默认权限，如果默认权限不满足需求，您也可以通过 AccessPolicies 指定某个用户对于此 Topic 的自定义权限。
    cleanup_policies Sequence[str]
    Topic 的消息清理策略，支持以下三种取值方式：[delete]：默认的消息清理策略。在磁盘容量充足的情况下，保留在最长保留时间范围内的消息；在磁盘容量不足时，将提前删除旧消息，以保证服务可用性。[compact]：COMPACT 消息清理策略针对每个消息的 Key 进行整合，对于有相同 Key 的消息，只保留最新的 value 值，旧的记录则会被清除。[delete,compact]：同时配置 DELETE 和 COMPACT 两种消息清理策略。只要消息满足任一条清理策略时，都将被清除。
    created_time str
    Topic 的创建时间。
    description str
    Topic 的描述信息。长度不超过 128 个字符。
    id str
    Uniquely identifies the resource.
    instance_id str
    实例 ID。
    log_retention_hours int
    消息保留时长，单位小时。Topic维度的消息保留时长，取值范围：1 - 2160小时（90天）。
    parameters str
    Topic 级别的参数配置。Parameters 参数说明 MinInsyncReplicaNumber:2：最小同步副本个数。当同步副本个数小于配置值时，消息将无法写入对应 Topic。配置值越大，数据可靠性增加，但是可用性将会降低。默认值为副本数减 1。考虑到 Topic 的可用性，建议设置为副本数减 1。MessageMaxByte:12：最大消息大小。单位为 MB，取值范围为 1～12。默认沿用实例的最大消息大小设置。LogRetentionHours:72：消息保留时长。单位为小时，取值范围为 0～2160，即消息最久保留 90 天。默认沿用实例的消息保留时长设置。
    partition_number int
    Topic 分区数。取值范围为 1~300，如果实例中已创建了其他 Topic，则所有 Topic 的分区数之和不超过该实例的分区数上限。如果分区数无法满足业务需求，您可以购买更多分区，提升实例的分区数量上限。
    replica_number int
    Topic 副本个数。可设置为为 2 或 3，默认值为 3。
    status str
    Topic 的状态。
    tags Sequence[GetTopicTag]
    Topic 的标签信息
    topic_name str
    待创建的 Topic 名称。3～64 个字符。必须以英文或数字开头。支持的字符包括英文、数字、连字符（-）、下划线（_）和英文句号（.）。
    used_storage_percentage_in_instance float
    当前 Topic 总数据量占实例总存储空间的比例，控制台页面显示为保留两位小数的百分数。
    used_storage_space_in_bytes int
    当前 Topic 已使用的总存储空间大小。
    accessPolicies List<Property Map>
    自定义权限配置，即为某些用户设置对于此 Topic 的自定义权限。仅在 AllAuthority 为 False 时需要设置。
    allAuthority Boolean
    待创建的Topic默认是否对所有用户都开启读写权限。true：（默认）所有用户都具备此 Topic 的读写权限。false：并非所有用户都具备此 Topic 的读写权限。默认情况下，用户对于此 Topic 的权限沿用用户的默认权限，如果默认权限不满足需求，您也可以通过 AccessPolicies 指定某个用户对于此 Topic 的自定义权限。
    cleanupPolicies List<String>
    Topic 的消息清理策略，支持以下三种取值方式：[delete]：默认的消息清理策略。在磁盘容量充足的情况下，保留在最长保留时间范围内的消息；在磁盘容量不足时，将提前删除旧消息，以保证服务可用性。[compact]：COMPACT 消息清理策略针对每个消息的 Key 进行整合，对于有相同 Key 的消息，只保留最新的 value 值，旧的记录则会被清除。[delete,compact]：同时配置 DELETE 和 COMPACT 两种消息清理策略。只要消息满足任一条清理策略时，都将被清除。
    createdTime String
    Topic 的创建时间。
    description String
    Topic 的描述信息。长度不超过 128 个字符。
    id String
    Uniquely identifies the resource.
    instanceId String
    实例 ID。
    logRetentionHours Number
    消息保留时长，单位小时。Topic维度的消息保留时长，取值范围：1 - 2160小时（90天）。
    parameters String
    Topic 级别的参数配置。Parameters 参数说明 MinInsyncReplicaNumber:2：最小同步副本个数。当同步副本个数小于配置值时，消息将无法写入对应 Topic。配置值越大，数据可靠性增加，但是可用性将会降低。默认值为副本数减 1。考虑到 Topic 的可用性，建议设置为副本数减 1。MessageMaxByte:12：最大消息大小。单位为 MB，取值范围为 1～12。默认沿用实例的最大消息大小设置。LogRetentionHours:72：消息保留时长。单位为小时，取值范围为 0～2160，即消息最久保留 90 天。默认沿用实例的消息保留时长设置。
    partitionNumber Number
    Topic 分区数。取值范围为 1~300，如果实例中已创建了其他 Topic，则所有 Topic 的分区数之和不超过该实例的分区数上限。如果分区数无法满足业务需求，您可以购买更多分区，提升实例的分区数量上限。
    replicaNumber Number
    Topic 副本个数。可设置为为 2 或 3，默认值为 3。
    status String
    Topic 的状态。
    tags List<Property Map>
    Topic 的标签信息
    topicName String
    待创建的 Topic 名称。3～64 个字符。必须以英文或数字开头。支持的字符包括英文、数字、连字符（-）、下划线（_）和英文句号（.）。
    usedStoragePercentageInInstance Number
    当前 Topic 总数据量占实例总存储空间的比例，控制台页面显示为保留两位小数的百分数。
    usedStorageSpaceInBytes Number
    当前 Topic 已使用的总存储空间大小。

    Supporting Types

    GetTopicAccessPolicy

    AccessPolicy string
    SASL 用户对于当前 Topic 的访问权限。PubSub：拥有发布、订阅权限。Pub：拥有发布权限。Sub：拥有订阅权限。
    UserName string
    SASL 用户名称。
    AccessPolicy string
    SASL 用户对于当前 Topic 的访问权限。PubSub：拥有发布、订阅权限。Pub：拥有发布权限。Sub：拥有订阅权限。
    UserName string
    SASL 用户名称。
    accessPolicy String
    SASL 用户对于当前 Topic 的访问权限。PubSub：拥有发布、订阅权限。Pub：拥有发布权限。Sub：拥有订阅权限。
    userName String
    SASL 用户名称。
    accessPolicy string
    SASL 用户对于当前 Topic 的访问权限。PubSub：拥有发布、订阅权限。Pub：拥有发布权限。Sub：拥有订阅权限。
    userName string
    SASL 用户名称。
    access_policy str
    SASL 用户对于当前 Topic 的访问权限。PubSub：拥有发布、订阅权限。Pub：拥有发布权限。Sub：拥有订阅权限。
    user_name str
    SASL 用户名称。
    accessPolicy String
    SASL 用户对于当前 Topic 的访问权限。PubSub：拥有发布、订阅权限。Pub：拥有发布权限。Sub：拥有订阅权限。
    userName String
    SASL 用户名称。

    GetTopicTag

    Key string
    标签键。
    Value string
    标签值。
    Key string
    标签键。
    Value string
    标签值。
    key String
    标签键。
    value String
    标签值。
    key string
    标签键。
    value string
    标签值。
    key str
    标签键。
    value str
    标签值。
    key String
    标签键。
    value String
    标签值。

    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.16
    published on Monday, Mar 9, 2026 by Byteplus
    Schema (JSON)
    byteplus-sdk/pulumi-bytepluscc
      Try Pulumi Cloud free. Your team will thank you.