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

bytepluscc.kafka.getInstance

bytepluscc logo
Viewing docs for bytepluscc v0.0.20
published on Thursday, Mar 26, 2026 by Byteplus
Schema (JSON)
byteplus-sdk/pulumi-bytepluscc

    Data Source schema for Byteplus::Kafka::Instance

    Using getInstance

    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 getInstance(args: GetInstanceArgs, opts?: InvokeOptions): Promise<GetInstanceResult>
function getInstanceOutput(args: GetInstanceOutputArgs, opts?: InvokeOptions): Output<GetInstanceResult>
    def get_instance(id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetInstanceResult
def get_instance_output(id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetInstanceResult]
    func LookupInstance(ctx *Context, args *LookupInstanceArgs, opts ...InvokeOption) (*LookupInstanceResult, error)
func LookupInstanceOutput(ctx *Context, args *LookupInstanceOutputArgs, opts ...InvokeOption) LookupInstanceResultOutput

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

    public static class GetInstance 
{
    public static Task<GetInstanceResult> InvokeAsync(GetInstanceArgs args, InvokeOptions? opts = null)
    public static Output<GetInstanceResult> Invoke(GetInstanceInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)
public static Output<GetInstanceResult> getInstance(GetInstanceArgs args, InvokeOptions options)

    fn::invoke:
  function: bytepluscc:kafka/getInstance:getInstance
  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.

    getInstance Result

    The following output properties are available:

    AccountId string
    创建实例的主账号 ID。
    ChargeInfo Byteplus.GetInstanceChargeInfo
    Kafka 实例的计费类型等计费信息。
    ComputeSpec string
    实例的计算规格。
    ConnectionInfos List<Byteplus.GetInstanceConnectionInfo>
    Kafka 实例的连接信息。
    CreatedTime string
    实例的创建时间，时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
    EipId string
    EIP 的 ID。
    Id string
    Uniquely identifies the resource.
    InstanceDescription string
    Kafka 实例的简单描述。长度范围为 1~128 个字符。
    InstanceId string
    Kafka 实例的 ID。
    InstanceName string
    Kafka 实例的名称。只能包含中文、字母、数字、下划线（_）和连字符（-）。不能以数字和连字符（-）开头。长度范围为 1~128 个字符。
    InstanceStatus string
    Kafka 实例的状态。Error：错误, Deleting：删除中, Creating：部署中, Upgrading：升级中, Updating：变更中, Running：运行中, Scaling：更配中, Rebuilding：重建中, Destroying：销毁中, Restarting：重启中, Migrating：迁移中, Restoring：恢复中, Importing：导入中, NetCreating：申请公网中, NetReleasing：释放公网中, Rollingback：回滚中, CreateFailed：创建失败, UpgradeFailed：升级失败, ScaleFailed：更配失败, RestartFailed：重启失败
    IpWhiteLists List<string>
    实例绑定的白名单 ID 列表。绑定白名单后，仅配置在白名单中的 IP 地址与地址段才能访问此实例。若未设置此参数，新 Kafka 实例将绑定白名单 default，对应 IP 地址为 0.0.0.0，表示允许所有地址访问该 Kafka 实例。
    NeedRebalance bool
    是否开启再均衡。
    Parameters string
    Kafka 实例的初始参数配置,格式为json,参数列表: 最大消息大小(MessageMaxByte)1-12MB 默认10, 消息保留时间(LogRetentionHours)0-2160Hour 默认72, 消费位点保留时长(OffsetRetentionMinutes)1-10080Min 默认4320 消息时间类型(MessageTimestampType)LogAppendTime/CreateTime 消息写入到服务端时间、producer创建消息时间。
    PartitionNumber int
    分区数量。
    PrivateDomainOnPublic bool
    是否开启公网解析。
    ProjectName string
    当前创建的 Kafka 实例所属的 IAM 项目。
    StorageSpace int
    实例的存储空间，单位为 GiB, 必须指定为 100 的倍数。
    StorageType string
    Kafka 实例数据存储的云盘类型。可设置为 ESSDFlexPL 或 ESSDPL0，默认为 ESSD_FlexPL。
    SubnetId string
    实例所在的 VPC 子网 ID。
    Tags List<Byteplus.GetInstanceTag>
    云资源标签。可以将实例通过标签进行归类，便于实例的搜索和资源聚合。
    Topics List<string>
    一个 Kafka 实例下的 Topic 列表
    UsableGroupNumber int
    当前实例剩余可用消费组个数。
    UsablePartitionNumber int
    当前实例剩余可用分区数。
    UsedGroupNumber int
    当前实例已经创建的消费组(Group)个数。
    UsedPartitionNumber int
    当前实例已经使用的分区个数。
    UsedStorageSpace int
    实例已用储空间，单位为 GiB。
    UsedTopicNumber int
    当前实例已创建的 Topic 个数。
    UserName string
    SASL/PLAIN 用户名称，需要满足以下要求: 1.由小写字母、数字、连字符（-）或下划线组成。2.长度为 3~64 个字符。3.用户名不支持设置为 admin 或 monitor,且实例内用户名称唯一。
    UserPassword string
    SASL/PLAIN 用户的密码，需要满足以下要求: 1.长度在8到32个字符 2.由大写字母、小写字母、数字、特殊字符中的任意三种组成 3.支持的特殊字符包括 !@#$%^&*()_+-=。
    Version string
    支持的 Kafka 版本，当前支持的版本包括 2.2.2, 2.8.2。
    VpcId string
    实例所在的私有网络 (VPC) ID。
    ZoneId string
    实例所在的可用区 ID。消息队列 Kafka版实例支持跨 AZ 部署, 多个可用区ID之间以逗号间隔。
    AccountId string
    创建实例的主账号 ID。
    ChargeInfo GetInstanceChargeInfo
    Kafka 实例的计费类型等计费信息。
    ComputeSpec string
    实例的计算规格。
    ConnectionInfos []GetInstanceConnectionInfo
    Kafka 实例的连接信息。
    CreatedTime string
    实例的创建时间，时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
    EipId string
    EIP 的 ID。
    Id string
    Uniquely identifies the resource.
    InstanceDescription string
    Kafka 实例的简单描述。长度范围为 1~128 个字符。
    InstanceId string
    Kafka 实例的 ID。
    InstanceName string
    Kafka 实例的名称。只能包含中文、字母、数字、下划线（_）和连字符（-）。不能以数字和连字符（-）开头。长度范围为 1~128 个字符。
    InstanceStatus string
    Kafka 实例的状态。Error：错误, Deleting：删除中, Creating：部署中, Upgrading：升级中, Updating：变更中, Running：运行中, Scaling：更配中, Rebuilding：重建中, Destroying：销毁中, Restarting：重启中, Migrating：迁移中, Restoring：恢复中, Importing：导入中, NetCreating：申请公网中, NetReleasing：释放公网中, Rollingback：回滚中, CreateFailed：创建失败, UpgradeFailed：升级失败, ScaleFailed：更配失败, RestartFailed：重启失败
    IpWhiteLists []string
    实例绑定的白名单 ID 列表。绑定白名单后，仅配置在白名单中的 IP 地址与地址段才能访问此实例。若未设置此参数，新 Kafka 实例将绑定白名单 default，对应 IP 地址为 0.0.0.0，表示允许所有地址访问该 Kafka 实例。
    NeedRebalance bool
    是否开启再均衡。
    Parameters string
    Kafka 实例的初始参数配置,格式为json,参数列表: 最大消息大小(MessageMaxByte)1-12MB 默认10, 消息保留时间(LogRetentionHours)0-2160Hour 默认72, 消费位点保留时长(OffsetRetentionMinutes)1-10080Min 默认4320 消息时间类型(MessageTimestampType)LogAppendTime/CreateTime 消息写入到服务端时间、producer创建消息时间。
    PartitionNumber int
    分区数量。
    PrivateDomainOnPublic bool
    是否开启公网解析。
    ProjectName string
    当前创建的 Kafka 实例所属的 IAM 项目。
    StorageSpace int
    实例的存储空间，单位为 GiB, 必须指定为 100 的倍数。
    StorageType string
    Kafka 实例数据存储的云盘类型。可设置为 ESSDFlexPL 或 ESSDPL0，默认为 ESSD_FlexPL。
    SubnetId string
    实例所在的 VPC 子网 ID。
    Tags []GetInstanceTag
    云资源标签。可以将实例通过标签进行归类，便于实例的搜索和资源聚合。
    Topics []string
    一个 Kafka 实例下的 Topic 列表
    UsableGroupNumber int
    当前实例剩余可用消费组个数。
    UsablePartitionNumber int
    当前实例剩余可用分区数。
    UsedGroupNumber int
    当前实例已经创建的消费组(Group)个数。
    UsedPartitionNumber int
    当前实例已经使用的分区个数。
    UsedStorageSpace int
    实例已用储空间，单位为 GiB。
    UsedTopicNumber int
    当前实例已创建的 Topic 个数。
    UserName string
    SASL/PLAIN 用户名称，需要满足以下要求: 1.由小写字母、数字、连字符（-）或下划线组成。2.长度为 3~64 个字符。3.用户名不支持设置为 admin 或 monitor,且实例内用户名称唯一。
    UserPassword string
    SASL/PLAIN 用户的密码，需要满足以下要求: 1.长度在8到32个字符 2.由大写字母、小写字母、数字、特殊字符中的任意三种组成 3.支持的特殊字符包括 !@#$%^&*()_+-=。
    Version string
    支持的 Kafka 版本，当前支持的版本包括 2.2.2, 2.8.2。
    VpcId string
    实例所在的私有网络 (VPC) ID。
    ZoneId string
    实例所在的可用区 ID。消息队列 Kafka版实例支持跨 AZ 部署, 多个可用区ID之间以逗号间隔。
    accountId String
    创建实例的主账号 ID。
    chargeInfo GetInstanceChargeInfo
    Kafka 实例的计费类型等计费信息。
    computeSpec String
    实例的计算规格。
    connectionInfos List<GetInstanceConnectionInfo>
    Kafka 实例的连接信息。
    createdTime String
    实例的创建时间，时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
    eipId String
    EIP 的 ID。
    id String
    Uniquely identifies the resource.
    instanceDescription String
    Kafka 实例的简单描述。长度范围为 1~128 个字符。
    instanceId String
    Kafka 实例的 ID。
    instanceName String
    Kafka 实例的名称。只能包含中文、字母、数字、下划线（_）和连字符（-）。不能以数字和连字符（-）开头。长度范围为 1~128 个字符。
    instanceStatus String
    Kafka 实例的状态。Error：错误, Deleting：删除中, Creating：部署中, Upgrading：升级中, Updating：变更中, Running：运行中, Scaling：更配中, Rebuilding：重建中, Destroying：销毁中, Restarting：重启中, Migrating：迁移中, Restoring：恢复中, Importing：导入中, NetCreating：申请公网中, NetReleasing：释放公网中, Rollingback：回滚中, CreateFailed：创建失败, UpgradeFailed：升级失败, ScaleFailed：更配失败, RestartFailed：重启失败
    ipWhiteLists List<String>
    实例绑定的白名单 ID 列表。绑定白名单后，仅配置在白名单中的 IP 地址与地址段才能访问此实例。若未设置此参数，新 Kafka 实例将绑定白名单 default，对应 IP 地址为 0.0.0.0，表示允许所有地址访问该 Kafka 实例。
    needRebalance Boolean
    是否开启再均衡。
    parameters String
    Kafka 实例的初始参数配置,格式为json,参数列表: 最大消息大小(MessageMaxByte)1-12MB 默认10, 消息保留时间(LogRetentionHours)0-2160Hour 默认72, 消费位点保留时长(OffsetRetentionMinutes)1-10080Min 默认4320 消息时间类型(MessageTimestampType)LogAppendTime/CreateTime 消息写入到服务端时间、producer创建消息时间。
    partitionNumber Integer
    分区数量。
    privateDomainOnPublic Boolean
    是否开启公网解析。
    projectName String
    当前创建的 Kafka 实例所属的 IAM 项目。
    storageSpace Integer
    实例的存储空间，单位为 GiB, 必须指定为 100 的倍数。
    storageType String
    Kafka 实例数据存储的云盘类型。可设置为 ESSDFlexPL 或 ESSDPL0，默认为 ESSD_FlexPL。
    subnetId String
    实例所在的 VPC 子网 ID。
    tags List<GetInstanceTag>
    云资源标签。可以将实例通过标签进行归类，便于实例的搜索和资源聚合。
    topics List<String>
    一个 Kafka 实例下的 Topic 列表
    usableGroupNumber Integer
    当前实例剩余可用消费组个数。
    usablePartitionNumber Integer
    当前实例剩余可用分区数。
    usedGroupNumber Integer
    当前实例已经创建的消费组(Group)个数。
    usedPartitionNumber Integer
    当前实例已经使用的分区个数。
    usedStorageSpace Integer
    实例已用储空间，单位为 GiB。
    usedTopicNumber Integer
    当前实例已创建的 Topic 个数。
    userName String
    SASL/PLAIN 用户名称，需要满足以下要求: 1.由小写字母、数字、连字符（-）或下划线组成。2.长度为 3~64 个字符。3.用户名不支持设置为 admin 或 monitor,且实例内用户名称唯一。
    userPassword String
    SASL/PLAIN 用户的密码，需要满足以下要求: 1.长度在8到32个字符 2.由大写字母、小写字母、数字、特殊字符中的任意三种组成 3.支持的特殊字符包括 !@#$%^&*()_+-=。
    version String
    支持的 Kafka 版本，当前支持的版本包括 2.2.2, 2.8.2。
    vpcId String
    实例所在的私有网络 (VPC) ID。
    zoneId String
    实例所在的可用区 ID。消息队列 Kafka版实例支持跨 AZ 部署, 多个可用区ID之间以逗号间隔。
    accountId string
    创建实例的主账号 ID。
    chargeInfo GetInstanceChargeInfo
    Kafka 实例的计费类型等计费信息。
    computeSpec string
    实例的计算规格。
    connectionInfos GetInstanceConnectionInfo[]
    Kafka 实例的连接信息。
    createdTime string
    实例的创建时间，时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
    eipId string
    EIP 的 ID。
    id string
    Uniquely identifies the resource.
    instanceDescription string
    Kafka 实例的简单描述。长度范围为 1~128 个字符。
    instanceId string
    Kafka 实例的 ID。
    instanceName string
    Kafka 实例的名称。只能包含中文、字母、数字、下划线（_）和连字符（-）。不能以数字和连字符（-）开头。长度范围为 1~128 个字符。
    instanceStatus string
    Kafka 实例的状态。Error：错误, Deleting：删除中, Creating：部署中, Upgrading：升级中, Updating：变更中, Running：运行中, Scaling：更配中, Rebuilding：重建中, Destroying：销毁中, Restarting：重启中, Migrating：迁移中, Restoring：恢复中, Importing：导入中, NetCreating：申请公网中, NetReleasing：释放公网中, Rollingback：回滚中, CreateFailed：创建失败, UpgradeFailed：升级失败, ScaleFailed：更配失败, RestartFailed：重启失败
    ipWhiteLists string[]
    实例绑定的白名单 ID 列表。绑定白名单后，仅配置在白名单中的 IP 地址与地址段才能访问此实例。若未设置此参数，新 Kafka 实例将绑定白名单 default，对应 IP 地址为 0.0.0.0，表示允许所有地址访问该 Kafka 实例。
    needRebalance boolean
    是否开启再均衡。
    parameters string
    Kafka 实例的初始参数配置,格式为json,参数列表: 最大消息大小(MessageMaxByte)1-12MB 默认10, 消息保留时间(LogRetentionHours)0-2160Hour 默认72, 消费位点保留时长(OffsetRetentionMinutes)1-10080Min 默认4320 消息时间类型(MessageTimestampType)LogAppendTime/CreateTime 消息写入到服务端时间、producer创建消息时间。
    partitionNumber number
    分区数量。
    privateDomainOnPublic boolean
    是否开启公网解析。
    projectName string
    当前创建的 Kafka 实例所属的 IAM 项目。
    storageSpace number
    实例的存储空间，单位为 GiB, 必须指定为 100 的倍数。
    storageType string
    Kafka 实例数据存储的云盘类型。可设置为 ESSDFlexPL 或 ESSDPL0，默认为 ESSD_FlexPL。
    subnetId string
    实例所在的 VPC 子网 ID。
    tags GetInstanceTag[]
    云资源标签。可以将实例通过标签进行归类，便于实例的搜索和资源聚合。
    topics string[]
    一个 Kafka 实例下的 Topic 列表
    usableGroupNumber number
    当前实例剩余可用消费组个数。
    usablePartitionNumber number
    当前实例剩余可用分区数。
    usedGroupNumber number
    当前实例已经创建的消费组(Group)个数。
    usedPartitionNumber number
    当前实例已经使用的分区个数。
    usedStorageSpace number
    实例已用储空间，单位为 GiB。
    usedTopicNumber number
    当前实例已创建的 Topic 个数。
    userName string
    SASL/PLAIN 用户名称，需要满足以下要求: 1.由小写字母、数字、连字符（-）或下划线组成。2.长度为 3~64 个字符。3.用户名不支持设置为 admin 或 monitor,且实例内用户名称唯一。
    userPassword string
    SASL/PLAIN 用户的密码，需要满足以下要求: 1.长度在8到32个字符 2.由大写字母、小写字母、数字、特殊字符中的任意三种组成 3.支持的特殊字符包括 !@#$%^&*()_+-=。
    version string
    支持的 Kafka 版本，当前支持的版本包括 2.2.2, 2.8.2。
    vpcId string
    实例所在的私有网络 (VPC) ID。
    zoneId string
    实例所在的可用区 ID。消息队列 Kafka版实例支持跨 AZ 部署, 多个可用区ID之间以逗号间隔。
    account_id str
    创建实例的主账号 ID。
    charge_info GetInstanceChargeInfo
    Kafka 实例的计费类型等计费信息。
    compute_spec str
    实例的计算规格。
    connection_infos Sequence[GetInstanceConnectionInfo]
    Kafka 实例的连接信息。
    created_time str
    实例的创建时间，时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
    eip_id str
    EIP 的 ID。
    id str
    Uniquely identifies the resource.
    instance_description str
    Kafka 实例的简单描述。长度范围为 1~128 个字符。
    instance_id str
    Kafka 实例的 ID。
    instance_name str
    Kafka 实例的名称。只能包含中文、字母、数字、下划线（_）和连字符（-）。不能以数字和连字符（-）开头。长度范围为 1~128 个字符。
    instance_status str
    Kafka 实例的状态。Error：错误, Deleting：删除中, Creating：部署中, Upgrading：升级中, Updating：变更中, Running：运行中, Scaling：更配中, Rebuilding：重建中, Destroying：销毁中, Restarting：重启中, Migrating：迁移中, Restoring：恢复中, Importing：导入中, NetCreating：申请公网中, NetReleasing：释放公网中, Rollingback：回滚中, CreateFailed：创建失败, UpgradeFailed：升级失败, ScaleFailed：更配失败, RestartFailed：重启失败
    ip_white_lists Sequence[str]
    实例绑定的白名单 ID 列表。绑定白名单后，仅配置在白名单中的 IP 地址与地址段才能访问此实例。若未设置此参数，新 Kafka 实例将绑定白名单 default，对应 IP 地址为 0.0.0.0，表示允许所有地址访问该 Kafka 实例。
    need_rebalance bool
    是否开启再均衡。
    parameters str
    Kafka 实例的初始参数配置,格式为json,参数列表: 最大消息大小(MessageMaxByte)1-12MB 默认10, 消息保留时间(LogRetentionHours)0-2160Hour 默认72, 消费位点保留时长(OffsetRetentionMinutes)1-10080Min 默认4320 消息时间类型(MessageTimestampType)LogAppendTime/CreateTime 消息写入到服务端时间、producer创建消息时间。
    partition_number int
    分区数量。
    private_domain_on_public bool
    是否开启公网解析。
    project_name str
    当前创建的 Kafka 实例所属的 IAM 项目。
    storage_space int
    实例的存储空间，单位为 GiB, 必须指定为 100 的倍数。
    storage_type str
    Kafka 实例数据存储的云盘类型。可设置为 ESSDFlexPL 或 ESSDPL0，默认为 ESSD_FlexPL。
    subnet_id str
    实例所在的 VPC 子网 ID。
    tags Sequence[GetInstanceTag]
    云资源标签。可以将实例通过标签进行归类，便于实例的搜索和资源聚合。
    topics Sequence[str]
    一个 Kafka 实例下的 Topic 列表
    usable_group_number int
    当前实例剩余可用消费组个数。
    usable_partition_number int
    当前实例剩余可用分区数。
    used_group_number int
    当前实例已经创建的消费组(Group)个数。
    used_partition_number int
    当前实例已经使用的分区个数。
    used_storage_space int
    实例已用储空间，单位为 GiB。
    used_topic_number int
    当前实例已创建的 Topic 个数。
    user_name str
    SASL/PLAIN 用户名称，需要满足以下要求: 1.由小写字母、数字、连字符（-）或下划线组成。2.长度为 3~64 个字符。3.用户名不支持设置为 admin 或 monitor,且实例内用户名称唯一。
    user_password str
    SASL/PLAIN 用户的密码，需要满足以下要求: 1.长度在8到32个字符 2.由大写字母、小写字母、数字、特殊字符中的任意三种组成 3.支持的特殊字符包括 !@#$%^&*()_+-=。
    version str
    支持的 Kafka 版本，当前支持的版本包括 2.2.2, 2.8.2。
    vpc_id str
    实例所在的私有网络 (VPC) ID。
    zone_id str
    实例所在的可用区 ID。消息队列 Kafka版实例支持跨 AZ 部署, 多个可用区ID之间以逗号间隔。
    accountId String
    创建实例的主账号 ID。
    chargeInfo Property Map
    Kafka 实例的计费类型等计费信息。
    computeSpec String
    实例的计算规格。
    connectionInfos List<Property Map>
    Kafka 实例的连接信息。
    createdTime String
    实例的创建时间，时间显示格式为 YYYY-MM-DD'T'HH:MM:SS'Z'。
    eipId String
    EIP 的 ID。
    id String
    Uniquely identifies the resource.
    instanceDescription String
    Kafka 实例的简单描述。长度范围为 1~128 个字符。
    instanceId String
    Kafka 实例的 ID。
    instanceName String
    Kafka 实例的名称。只能包含中文、字母、数字、下划线（_）和连字符（-）。不能以数字和连字符（-）开头。长度范围为 1~128 个字符。
    instanceStatus String
    Kafka 实例的状态。Error：错误, Deleting：删除中, Creating：部署中, Upgrading：升级中, Updating：变更中, Running：运行中, Scaling：更配中, Rebuilding：重建中, Destroying：销毁中, Restarting：重启中, Migrating：迁移中, Restoring：恢复中, Importing：导入中, NetCreating：申请公网中, NetReleasing：释放公网中, Rollingback：回滚中, CreateFailed：创建失败, UpgradeFailed：升级失败, ScaleFailed：更配失败, RestartFailed：重启失败
    ipWhiteLists List<String>
    实例绑定的白名单 ID 列表。绑定白名单后，仅配置在白名单中的 IP 地址与地址段才能访问此实例。若未设置此参数，新 Kafka 实例将绑定白名单 default，对应 IP 地址为 0.0.0.0，表示允许所有地址访问该 Kafka 实例。
    needRebalance Boolean
    是否开启再均衡。
    parameters String
    Kafka 实例的初始参数配置,格式为json,参数列表: 最大消息大小(MessageMaxByte)1-12MB 默认10, 消息保留时间(LogRetentionHours)0-2160Hour 默认72, 消费位点保留时长(OffsetRetentionMinutes)1-10080Min 默认4320 消息时间类型(MessageTimestampType)LogAppendTime/CreateTime 消息写入到服务端时间、producer创建消息时间。
    partitionNumber Number
    分区数量。
    privateDomainOnPublic Boolean
    是否开启公网解析。
    projectName String
    当前创建的 Kafka 实例所属的 IAM 项目。
    storageSpace Number
    实例的存储空间，单位为 GiB, 必须指定为 100 的倍数。
    storageType String
    Kafka 实例数据存储的云盘类型。可设置为 ESSDFlexPL 或 ESSDPL0，默认为 ESSD_FlexPL。
    subnetId String
    实例所在的 VPC 子网 ID。
    tags List<Property Map>
    云资源标签。可以将实例通过标签进行归类，便于实例的搜索和资源聚合。
    topics List<String>
    一个 Kafka 实例下的 Topic 列表
    usableGroupNumber Number
    当前实例剩余可用消费组个数。
    usablePartitionNumber Number
    当前实例剩余可用分区数。
    usedGroupNumber Number
    当前实例已经创建的消费组(Group)个数。
    usedPartitionNumber Number
    当前实例已经使用的分区个数。
    usedStorageSpace Number
    实例已用储空间，单位为 GiB。
    usedTopicNumber Number
    当前实例已创建的 Topic 个数。
    userName String
    SASL/PLAIN 用户名称，需要满足以下要求: 1.由小写字母、数字、连字符（-）或下划线组成。2.长度为 3~64 个字符。3.用户名不支持设置为 admin 或 monitor,且实例内用户名称唯一。
    userPassword String
    SASL/PLAIN 用户的密码，需要满足以下要求: 1.长度在8到32个字符 2.由大写字母、小写字母、数字、特殊字符中的任意三种组成 3.支持的特殊字符包括 !@#$%^&*()_+-=。
    version String
    支持的 Kafka 版本，当前支持的版本包括 2.2.2, 2.8.2。
    vpcId String
    实例所在的私有网络 (VPC) ID。
    zoneId String
    实例所在的可用区 ID。消息队列 Kafka版实例支持跨 AZ 部署, 多个可用区ID之间以逗号间隔。

    Supporting Types

    GetInstanceChargeInfo

    AutoRenew bool
    包年包月实例到期后是否自动续费，true-自动续费 false(默认)-不自动续费,到期实例关停。
    ChargeExpireTime string
    包年包月实例的到期时间。
    ChargeStartTime string
    实例的计费开始时间。
    ChargeStatus string
    实例的计费状态，支持的类型包括: Normal-正常, Overdue-按量计费欠费, Expired-包年包月到期
    ChargeType string
    实例的计费类型，支持的类型包括: PostPaid-按量付费, PrePaid-包年包月。
    OverdueReclaimTime string
    实例欠费关停后的预计释放时间。
    OverdueTime string
    实例的欠费关停时间。
    Period int
    包年包月类型实例的购买时长。
    PeriodUnit string
    包年包月类型实例的生命周期单位，即指定以月（Month/Monthly）或以年（Year/Yearly）为单位购买。
    AutoRenew bool
    包年包月实例到期后是否自动续费，true-自动续费 false(默认)-不自动续费,到期实例关停。
    ChargeExpireTime string
    包年包月实例的到期时间。
    ChargeStartTime string
    实例的计费开始时间。
    ChargeStatus string
    实例的计费状态，支持的类型包括: Normal-正常, Overdue-按量计费欠费, Expired-包年包月到期
    ChargeType string
    实例的计费类型，支持的类型包括: PostPaid-按量付费, PrePaid-包年包月。
    OverdueReclaimTime string
    实例欠费关停后的预计释放时间。
    OverdueTime string
    实例的欠费关停时间。
    Period int
    包年包月类型实例的购买时长。
    PeriodUnit string
    包年包月类型实例的生命周期单位，即指定以月（Month/Monthly）或以年（Year/Yearly）为单位购买。
    autoRenew Boolean
    包年包月实例到期后是否自动续费，true-自动续费 false(默认)-不自动续费,到期实例关停。
    chargeExpireTime String
    包年包月实例的到期时间。
    chargeStartTime String
    实例的计费开始时间。
    chargeStatus String
    实例的计费状态，支持的类型包括: Normal-正常, Overdue-按量计费欠费, Expired-包年包月到期
    chargeType String
    实例的计费类型，支持的类型包括: PostPaid-按量付费, PrePaid-包年包月。
    overdueReclaimTime String
    实例欠费关停后的预计释放时间。
    overdueTime String
    实例的欠费关停时间。
    period Integer
    包年包月类型实例的购买时长。
    periodUnit String
    包年包月类型实例的生命周期单位，即指定以月（Month/Monthly）或以年（Year/Yearly）为单位购买。
    autoRenew boolean
    包年包月实例到期后是否自动续费，true-自动续费 false(默认)-不自动续费,到期实例关停。
    chargeExpireTime string
    包年包月实例的到期时间。
    chargeStartTime string
    实例的计费开始时间。
    chargeStatus string
    实例的计费状态，支持的类型包括: Normal-正常, Overdue-按量计费欠费, Expired-包年包月到期
    chargeType string
    实例的计费类型，支持的类型包括: PostPaid-按量付费, PrePaid-包年包月。
    overdueReclaimTime string
    实例欠费关停后的预计释放时间。
    overdueTime string
    实例的欠费关停时间。
    period number
    包年包月类型实例的购买时长。
    periodUnit string
    包年包月类型实例的生命周期单位，即指定以月（Month/Monthly）或以年（Year/Yearly）为单位购买。
    auto_renew bool
    包年包月实例到期后是否自动续费，true-自动续费 false(默认)-不自动续费,到期实例关停。
    charge_expire_time str
    包年包月实例的到期时间。
    charge_start_time str
    实例的计费开始时间。
    charge_status str
    实例的计费状态，支持的类型包括: Normal-正常, Overdue-按量计费欠费, Expired-包年包月到期
    charge_type str
    实例的计费类型，支持的类型包括: PostPaid-按量付费, PrePaid-包年包月。
    overdue_reclaim_time str
    实例欠费关停后的预计释放时间。
    overdue_time str
    实例的欠费关停时间。
    period int
    包年包月类型实例的购买时长。
    period_unit str
    包年包月类型实例的生命周期单位，即指定以月（Month/Monthly）或以年（Year/Yearly）为单位购买。
    autoRenew Boolean
    包年包月实例到期后是否自动续费，true-自动续费 false(默认)-不自动续费,到期实例关停。
    chargeExpireTime String
    包年包月实例的到期时间。
    chargeStartTime String
    实例的计费开始时间。
    chargeStatus String
    实例的计费状态，支持的类型包括: Normal-正常, Overdue-按量计费欠费, Expired-包年包月到期
    chargeType String
    实例的计费类型，支持的类型包括: PostPaid-按量付费, PrePaid-包年包月。
    overdueReclaimTime String
    实例欠费关停后的预计释放时间。
    overdueTime String
    实例的欠费关停时间。
    period Number
    包年包月类型实例的购买时长。
    periodUnit String
    包年包月类型实例的生命周期单位，即指定以月（Month/Monthly）或以年（Year/Yearly）为单位购买。

    GetInstanceConnectionInfo

    EndpointType string
    实例的接入点类型。PLAINTEXT：默认接入点。SASLPLAINTEXT：SASL接入点（私网）。SASLSSL：SASL接入点（公网）。未开启公网访问时，不提供此接入点。
    InternalEndpoint string
    实例私网访问域名。
    NetworkType string
    接入点的网络类型。统一为 PrivateNetwork。
    PublicEndpoint string
    实例公网访问域名。
    EndpointType string
    实例的接入点类型。PLAINTEXT：默认接入点。SASLPLAINTEXT：SASL接入点（私网）。SASLSSL：SASL接入点（公网）。未开启公网访问时，不提供此接入点。
    InternalEndpoint string
    实例私网访问域名。
    NetworkType string
    接入点的网络类型。统一为 PrivateNetwork。
    PublicEndpoint string
    实例公网访问域名。
    endpointType String
    实例的接入点类型。PLAINTEXT：默认接入点。SASLPLAINTEXT：SASL接入点（私网）。SASLSSL：SASL接入点（公网）。未开启公网访问时，不提供此接入点。
    internalEndpoint String
    实例私网访问域名。
    networkType String
    接入点的网络类型。统一为 PrivateNetwork。
    publicEndpoint String
    实例公网访问域名。
    endpointType string
    实例的接入点类型。PLAINTEXT：默认接入点。SASLPLAINTEXT：SASL接入点（私网）。SASLSSL：SASL接入点（公网）。未开启公网访问时，不提供此接入点。
    internalEndpoint string
    实例私网访问域名。
    networkType string
    接入点的网络类型。统一为 PrivateNetwork。
    publicEndpoint string
    实例公网访问域名。
    endpoint_type str
    实例的接入点类型。PLAINTEXT：默认接入点。SASLPLAINTEXT：SASL接入点（私网）。SASLSSL：SASL接入点（公网）。未开启公网访问时，不提供此接入点。
    internal_endpoint str
    实例私网访问域名。
    network_type str
    接入点的网络类型。统一为 PrivateNetwork。
    public_endpoint str
    实例公网访问域名。
    endpointType String
    实例的接入点类型。PLAINTEXT：默认接入点。SASLPLAINTEXT：SASL接入点（私网）。SASLSSL：SASL接入点（公网）。未开启公网访问时，不提供此接入点。
    internalEndpoint String
    实例私网访问域名。
    networkType String
    接入点的网络类型。统一为 PrivateNetwork。
    publicEndpoint String
    实例公网访问域名。

    GetInstanceTag

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