1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. getClickhouseInstances
Viewing docs for tencentcloud 1.82.79
published on Friday, Mar 27, 2026 by tencentcloudstack
Schema (JSON)
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getClickhouseInstances

tencentcloud logo
Viewing docs for tencentcloud 1.82.79
published on Friday, Mar 27, 2026 by tencentcloudstack
Schema (JSON)
tencentcloudstack/terraform-provider-tencentcloud

    Provides a list of ClickHouse (TCHouse-C) instances.

    Example Usage

    Query all instances

    import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";

const all = tencentcloud.getClickhouseInstances({});

    import pulumi
import pulumi_tencentcloud as tencentcloud

all = tencentcloud.get_clickhouse_instances()

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.GetClickhouseInstances(ctx, &tencentcloud.GetClickhouseInstancesArgs{}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var all = Tencentcloud.GetClickhouseInstances.Invoke();

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetClickhouseInstancesArgs;
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) {
        final var all = TencentcloudFunctions.getClickhouseInstances(GetClickhouseInstancesArgs.builder()
            .build());

    }
}

    variables:
  all:
    fn::invoke:
      function: tencentcloud:getClickhouseInstances
      arguments: {}

    Query by instance ID

    import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";

const byId = tencentcloud.getClickhouseInstances({
    instanceId: "cdwch-xxxxxx",
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

by_id = tencentcloud.get_clickhouse_instances(instance_id="cdwch-xxxxxx")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.GetClickhouseInstances(ctx, &tencentcloud.GetClickhouseInstancesArgs{
			InstanceId: pulumi.StringRef("cdwch-xxxxxx"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var byId = Tencentcloud.GetClickhouseInstances.Invoke(new()
    {
        InstanceId = "cdwch-xxxxxx",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetClickhouseInstancesArgs;
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) {
        final var byId = TencentcloudFunctions.getClickhouseInstances(GetClickhouseInstancesArgs.builder()
            .instanceId("cdwch-xxxxxx")
            .build());

    }
}

    variables:
  byId:
    fn::invoke:
      function: tencentcloud:getClickhouseInstances
      arguments:
        instanceId: cdwch-xxxxxx

    Query by instance name

    import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";

const byName = tencentcloud.getClickhouseInstances({
    instanceName: "my-clickhouse-cluster",
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

by_name = tencentcloud.get_clickhouse_instances(instance_name="my-clickhouse-cluster")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.GetClickhouseInstances(ctx, &tencentcloud.GetClickhouseInstancesArgs{
			InstanceName: pulumi.StringRef("my-clickhouse-cluster"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var byName = Tencentcloud.GetClickhouseInstances.Invoke(new()
    {
        InstanceName = "my-clickhouse-cluster",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetClickhouseInstancesArgs;
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) {
        final var byName = TencentcloudFunctions.getClickhouseInstances(GetClickhouseInstancesArgs.builder()
            .instanceName("my-clickhouse-cluster")
            .build());

    }
}

    variables:
  byName:
    fn::invoke:
      function: tencentcloud:getClickhouseInstances
      arguments:
        instanceName: my-clickhouse-cluster

    Query by tags

    import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";

const byTags = tencentcloud.getClickhouseInstances({
    tags: {
        env: "production",
        app: "analytics",
    },
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

by_tags = tencentcloud.get_clickhouse_instances(tags={
    "env": "production",
    "app": "analytics",
})

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tencentcloud.GetClickhouseInstances(ctx, &tencentcloud.GetClickhouseInstancesArgs{
			Tags: map[string]interface{}{
				"env": "production",
				"app": "analytics",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var byTags = Tencentcloud.GetClickhouseInstances.Invoke(new()
    {
        Tags = 
        {
            { "env", "production" },
            { "app", "analytics" },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetClickhouseInstancesArgs;
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) {
        final var byTags = TencentcloudFunctions.getClickhouseInstances(GetClickhouseInstancesArgs.builder()
            .tags(Map.ofEntries(
                Map.entry("env", "production"),
                Map.entry("app", "analytics")
            ))
            .build());

    }
}

    variables:
  byTags:
    fn::invoke:
      function: tencentcloud:getClickhouseInstances
      arguments:
        tags:
          env: production
          app: analytics

    Query with multiple filters

    import * as pulumi from "@pulumi/pulumi";
import * as tencentcloud from "@pulumi/tencentcloud";

const filtered = tencentcloud.getClickhouseInstances({
    instanceName: "test",
    tags: {
        env: "test",
    },
    isSimple: true,
    resultOutputFile: "clickhouse_instances.json",
});
export const instanceCount = filtered.then(filtered => filtered.instanceLists).length;
export const firstInstance = pulumi.all([filtered.then(filtered => filtered.instanceLists).length, filtered]).apply(([length, filtered]) => length > 0 ? filtered.instanceLists?.[0] : null);

    import pulumi
import pulumi_tencentcloud as tencentcloud

filtered = tencentcloud.get_clickhouse_instances(instance_name="test",
    tags={
        "env": "test",
    },
    is_simple=True,
    result_output_file="clickhouse_instances.json")
pulumi.export("instanceCount", len(filtered.instance_lists))
pulumi.export("firstInstance", len(filtered.instance_lists).apply(lambda length: filtered.instance_lists[0] if length > 0 else None))

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
filtered, err := tencentcloud.GetClickhouseInstances(ctx, &tencentcloud.GetClickhouseInstancesArgs{
InstanceName: pulumi.StringRef("test"),
Tags: map[string]interface{}{
"env": "test",
},
IsSimple: pulumi.BoolRef(true),
ResultOutputFile: pulumi.StringRef("clickhouse_instances.json"),
}, nil);
if err != nil {
return err
}
ctx.Export("instanceCount", len(filtered.InstanceLists))
var tmp0 
if length > 0 {
tmp0 = filtered.InstanceLists[0]
} else {
tmp0 = nil
}
ctx.Export("firstInstance", len(filtered.InstanceLists).ApplyT(func(length int) (tencentcloud.GetClickhouseInstancesInstanceList, error) {
return tmp0, nil
}).(tencentcloud.GetClickhouseInstancesInstanceListOutput))
return nil
})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var filtered = Tencentcloud.GetClickhouseInstances.Invoke(new()
    {
        InstanceName = "test",
        Tags = 
        {
            { "env", "test" },
        },
        IsSimple = true,
        ResultOutputFile = "clickhouse_instances.json",
    });

    return new Dictionary<string, object?>
    {
        ["instanceCount"] = filtered.Apply(getClickhouseInstancesResult => getClickhouseInstancesResult.InstanceLists).Length,
        ["firstInstance"] = Output.Tuple(filtered.Apply(getClickhouseInstancesResult => getClickhouseInstancesResult.InstanceLists).Length, filtered).Apply(values =>
        {
            var length = values.Item1;
            var filtered = values.Item2;
            return length > 0 ? filtered.Apply(getClickhouseInstancesResult => getClickhouseInstancesResult.InstanceLists[0]) : null;
        }),
    };
});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetClickhouseInstancesArgs;
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) {
        final var filtered = TencentcloudFunctions.getClickhouseInstances(GetClickhouseInstancesArgs.builder()
            .instanceName("test")
            .tags(Map.of("env", "test"))
            .isSimple(true)
            .resultOutputFile("clickhouse_instances.json")
            .build());

        ctx.export("instanceCount", filtered.instanceLists().length());
        ctx.export("firstInstance", filtered.instanceLists().length().applyValue(_length -> _length > 0 ? filtered.instanceLists()[0] : null));
    }
}

    Example coming soon!

    Using getClickhouseInstances

    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 getClickhouseInstances(args: GetClickhouseInstancesArgs, opts?: InvokeOptions): Promise<GetClickhouseInstancesResult>
function getClickhouseInstancesOutput(args: GetClickhouseInstancesOutputArgs, opts?: InvokeOptions): Output<GetClickhouseInstancesResult>
    def get_clickhouse_instances(id: Optional[str] = None,
                             instance_id: Optional[str] = None,
                             instance_name: Optional[str] = None,
                             is_simple: Optional[bool] = None,
                             result_output_file: Optional[str] = None,
                             tags: Optional[Mapping[str, str]] = None,
                             vips: Optional[Sequence[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> GetClickhouseInstancesResult
def get_clickhouse_instances_output(id: Optional[pulumi.Input[str]] = None,
                             instance_id: Optional[pulumi.Input[str]] = None,
                             instance_name: Optional[pulumi.Input[str]] = None,
                             is_simple: Optional[pulumi.Input[bool]] = None,
                             result_output_file: Optional[pulumi.Input[str]] = None,
                             tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                             vips: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetClickhouseInstancesResult]
    func GetClickhouseInstances(ctx *Context, args *GetClickhouseInstancesArgs, opts ...InvokeOption) (*GetClickhouseInstancesResult, error)
func GetClickhouseInstancesOutput(ctx *Context, args *GetClickhouseInstancesOutputArgs, opts ...InvokeOption) GetClickhouseInstancesResultOutput

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

    public static class GetClickhouseInstances 
{
    public static Task<GetClickhouseInstancesResult> InvokeAsync(GetClickhouseInstancesArgs args, InvokeOptions? opts = null)
    public static Output<GetClickhouseInstancesResult> Invoke(GetClickhouseInstancesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetClickhouseInstancesResult> getClickhouseInstances(GetClickhouseInstancesArgs args, InvokeOptions options)
public static Output<GetClickhouseInstancesResult> getClickhouseInstances(GetClickhouseInstancesArgs args, InvokeOptions options)

    fn::invoke:
  function: tencentcloud:index/getClickhouseInstances:getClickhouseInstances
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    InstanceId string
    Search by instance ID, support exact matching.
    InstanceName string
    Search by instance name, support fuzzy matching.
    IsSimple bool
    Whether to return simplified information.
    ResultOutputFile string
    Used to save results.
    Tags Dictionary<string, string>
    Tag filter, multiple tags must be matched at the same time.
    Vips List<string>
    VIP address list for filtering instances.
    Id string
    InstanceId string
    Search by instance ID, support exact matching.
    InstanceName string
    Search by instance name, support fuzzy matching.
    IsSimple bool
    Whether to return simplified information.
    ResultOutputFile string
    Used to save results.
    Tags map[string]string
    Tag filter, multiple tags must be matched at the same time.
    Vips []string
    VIP address list for filtering instances.
    id String
    instanceId String
    Search by instance ID, support exact matching.
    instanceName String
    Search by instance name, support fuzzy matching.
    isSimple Boolean
    Whether to return simplified information.
    resultOutputFile String
    Used to save results.
    tags Map<String,String>
    Tag filter, multiple tags must be matched at the same time.
    vips List<String>
    VIP address list for filtering instances.
    id string
    instanceId string
    Search by instance ID, support exact matching.
    instanceName string
    Search by instance name, support fuzzy matching.
    isSimple boolean
    Whether to return simplified information.
    resultOutputFile string
    Used to save results.
    tags {[key: string]: string}
    Tag filter, multiple tags must be matched at the same time.
    vips string[]
    VIP address list for filtering instances.
    id str
    instance_id str
    Search by instance ID, support exact matching.
    instance_name str
    Search by instance name, support fuzzy matching.
    is_simple bool
    Whether to return simplified information.
    result_output_file str
    Used to save results.
    tags Mapping[str, str]
    Tag filter, multiple tags must be matched at the same time.
    vips Sequence[str]
    VIP address list for filtering instances.
    id String
    instanceId String
    Search by instance ID, support exact matching.
    instanceName String
    Search by instance name, support fuzzy matching.
    isSimple Boolean
    Whether to return simplified information.
    resultOutputFile String
    Used to save results.
    tags Map<String>
    Tag filter, multiple tags must be matched at the same time.
    vips List<String>
    VIP address list for filtering instances.

    getClickhouseInstances Result

    The following output properties are available:

    Id string
    InstanceLists List<GetClickhouseInstancesInstanceList>
    List of ClickHouse instances.
    InstanceId string
    Instance ID, such as cdwch-xxxx.
    InstanceName string
    Instance name.
    IsSimple bool
    ResultOutputFile string
    Tags Dictionary<string, string>
    Tag list.
    Vips List<string>
    Id string
    InstanceLists []GetClickhouseInstancesInstanceList
    List of ClickHouse instances.
    InstanceId string
    Instance ID, such as cdwch-xxxx.
    InstanceName string
    Instance name.
    IsSimple bool
    ResultOutputFile string
    Tags map[string]string
    Tag list.
    Vips []string
    id String
    instanceLists List<GetClickhouseInstancesInstanceList>
    List of ClickHouse instances.
    instanceId String
    Instance ID, such as cdwch-xxxx.
    instanceName String
    Instance name.
    isSimple Boolean
    resultOutputFile String
    tags Map<String,String>
    Tag list.
    vips List<String>
    id string
    instanceLists GetClickhouseInstancesInstanceList[]
    List of ClickHouse instances.
    instanceId string
    Instance ID, such as cdwch-xxxx.
    instanceName string
    Instance name.
    isSimple boolean
    resultOutputFile string
    tags {[key: string]: string}
    Tag list.
    vips string[]
    id str
    instance_lists Sequence[GetClickhouseInstancesInstanceList]
    List of ClickHouse instances.
    instance_id str
    Instance ID, such as cdwch-xxxx.
    instance_name str
    Instance name.
    is_simple bool
    result_output_file str
    tags Mapping[str, str]
    Tag list.
    vips Sequence[str]
    id String
    instanceLists List<Property Map>
    List of ClickHouse instances.
    instanceId String
    Instance ID, such as cdwch-xxxx.
    instanceName String
    Instance name.
    isSimple Boolean
    resultOutputFile String
    tags Map<String>
    Tag list.
    vips List<String>

    Supporting Types

    GetClickhouseInstancesInstanceList

    AccessInfo string
    Access address, such as 10.0.0.1:9000.
    CanAttachCbs bool
    Whether CBS can be attached.
    CanAttachCbsLvm bool
    Whether CBS LVM can be attached.
    CanAttachCos bool
    Whether COS can be attached.
    ChProxyVip string
    CHProxy VIP address.
    ClsLogSetId string
    CLS log set ID.
    ClsTopicId string
    CLS topic ID.
    CommonSummaries List<GetClickhouseInstancesInstanceListCommonSummary>
    Common node summary information.
    Components List<GetClickhouseInstancesInstanceListComponent>
    Component list.
    CosBucketName string
    COS bucket name.
    CreateTime string
    Creation time.
    Eip string
    Elastic IP address.
    EnableXmlConfig double
    Whether XML configuration is supported.
    ExpireTime string
    Expiration time.
    FlowMsg string
    Workflow message.
    Ha string
    High availability: true or false.
    HaZk bool
    ZooKeeper high availability.
    HasClsTopic bool
    Whether CLS topic is enabled.
    InstanceId string
    Search by instance ID, support exact matching.
    InstanceName string
    Search by instance name, support fuzzy matching.
    InstanceStateInfos List<GetClickhouseInstancesInstanceListInstanceStateInfo>
    Instance state details.
    IsElastic bool
    Whether it is an elastic instance.
    Kind string
    Instance type: external, local, or yunti.
    MasterSummaries List<GetClickhouseInstancesInstanceListMasterSummary>
    Master node summary information.
    Monitor string
    Monitoring information.
    PayMode string
    Payment mode: hour or prepay.
    Region string
    Region, such as ap-guangzhou.
    RegionDesc string
    Region description.
    RegionId double
    Region ID.
    RenewFlag bool
    Auto-renewal flag.
    Status string
    Instance status: Init, Serving, Deleted, Deleting, Modify.
    StatusDesc string
    Status description.
    SubnetId string
    Subnet ID.
    Tags List<GetClickhouseInstancesInstanceListTag>
    Tag filter, multiple tags must be matched at the same time.
    UpgradeVersions string
    Upgradeable versions.
    Version string
    Instance version.
    VpcId string
    VPC ID.
    Zone string
    Availability zone, such as ap-guangzhou-3.
    ZoneDesc string
    Zone description.
    AccessInfo string
    Access address, such as 10.0.0.1:9000.
    CanAttachCbs bool
    Whether CBS can be attached.
    CanAttachCbsLvm bool
    Whether CBS LVM can be attached.
    CanAttachCos bool
    Whether COS can be attached.
    ChProxyVip string
    CHProxy VIP address.
    ClsLogSetId string
    CLS log set ID.
    ClsTopicId string
    CLS topic ID.
    CommonSummaries []GetClickhouseInstancesInstanceListCommonSummary
    Common node summary information.
    Components []GetClickhouseInstancesInstanceListComponent
    Component list.
    CosBucketName string
    COS bucket name.
    CreateTime string
    Creation time.
    Eip string
    Elastic IP address.
    EnableXmlConfig float64
    Whether XML configuration is supported.
    ExpireTime string
    Expiration time.
    FlowMsg string
    Workflow message.
    Ha string
    High availability: true or false.
    HaZk bool
    ZooKeeper high availability.
    HasClsTopic bool
    Whether CLS topic is enabled.
    InstanceId string
    Search by instance ID, support exact matching.
    InstanceName string
    Search by instance name, support fuzzy matching.
    InstanceStateInfos []GetClickhouseInstancesInstanceListInstanceStateInfo
    Instance state details.
    IsElastic bool
    Whether it is an elastic instance.
    Kind string
    Instance type: external, local, or yunti.
    MasterSummaries []GetClickhouseInstancesInstanceListMasterSummary
    Master node summary information.
    Monitor string
    Monitoring information.
    PayMode string
    Payment mode: hour or prepay.
    Region string
    Region, such as ap-guangzhou.
    RegionDesc string
    Region description.
    RegionId float64
    Region ID.
    RenewFlag bool
    Auto-renewal flag.
    Status string
    Instance status: Init, Serving, Deleted, Deleting, Modify.
    StatusDesc string
    Status description.
    SubnetId string
    Subnet ID.
    Tags []GetClickhouseInstancesInstanceListTag
    Tag filter, multiple tags must be matched at the same time.
    UpgradeVersions string
    Upgradeable versions.
    Version string
    Instance version.
    VpcId string
    VPC ID.
    Zone string
    Availability zone, such as ap-guangzhou-3.
    ZoneDesc string
    Zone description.
    accessInfo String
    Access address, such as 10.0.0.1:9000.
    canAttachCbs Boolean
    Whether CBS can be attached.
    canAttachCbsLvm Boolean
    Whether CBS LVM can be attached.
    canAttachCos Boolean
    Whether COS can be attached.
    chProxyVip String
    CHProxy VIP address.
    clsLogSetId String
    CLS log set ID.
    clsTopicId String
    CLS topic ID.
    commonSummaries List<GetClickhouseInstancesInstanceListCommonSummary>
    Common node summary information.
    components List<GetClickhouseInstancesInstanceListComponent>
    Component list.
    cosBucketName String
    COS bucket name.
    createTime String
    Creation time.
    eip String
    Elastic IP address.
    enableXmlConfig Double
    Whether XML configuration is supported.
    expireTime String
    Expiration time.
    flowMsg String
    Workflow message.
    ha String
    High availability: true or false.
    haZk Boolean
    ZooKeeper high availability.
    hasClsTopic Boolean
    Whether CLS topic is enabled.
    instanceId String
    Search by instance ID, support exact matching.
    instanceName String
    Search by instance name, support fuzzy matching.
    instanceStateInfos List<GetClickhouseInstancesInstanceListInstanceStateInfo>
    Instance state details.
    isElastic Boolean
    Whether it is an elastic instance.
    kind String
    Instance type: external, local, or yunti.
    masterSummaries List<GetClickhouseInstancesInstanceListMasterSummary>
    Master node summary information.
    monitor String
    Monitoring information.
    payMode String
    Payment mode: hour or prepay.
    region String
    Region, such as ap-guangzhou.
    regionDesc String
    Region description.
    regionId Double
    Region ID.
    renewFlag Boolean
    Auto-renewal flag.
    status String
    Instance status: Init, Serving, Deleted, Deleting, Modify.
    statusDesc String
    Status description.
    subnetId String
    Subnet ID.
    tags List<GetClickhouseInstancesInstanceListTag>
    Tag filter, multiple tags must be matched at the same time.
    upgradeVersions String
    Upgradeable versions.
    version String
    Instance version.
    vpcId String
    VPC ID.
    zone String
    Availability zone, such as ap-guangzhou-3.
    zoneDesc String
    Zone description.
    accessInfo string
    Access address, such as 10.0.0.1:9000.
    canAttachCbs boolean
    Whether CBS can be attached.
    canAttachCbsLvm boolean
    Whether CBS LVM can be attached.
    canAttachCos boolean
    Whether COS can be attached.
    chProxyVip string
    CHProxy VIP address.
    clsLogSetId string
    CLS log set ID.
    clsTopicId string
    CLS topic ID.
    commonSummaries GetClickhouseInstancesInstanceListCommonSummary[]
    Common node summary information.
    components GetClickhouseInstancesInstanceListComponent[]
    Component list.
    cosBucketName string
    COS bucket name.
    createTime string
    Creation time.
    eip string
    Elastic IP address.
    enableXmlConfig number
    Whether XML configuration is supported.
    expireTime string
    Expiration time.
    flowMsg string
    Workflow message.
    ha string
    High availability: true or false.
    haZk boolean
    ZooKeeper high availability.
    hasClsTopic boolean
    Whether CLS topic is enabled.
    instanceId string
    Search by instance ID, support exact matching.
    instanceName string
    Search by instance name, support fuzzy matching.
    instanceStateInfos GetClickhouseInstancesInstanceListInstanceStateInfo[]
    Instance state details.
    isElastic boolean
    Whether it is an elastic instance.
    kind string
    Instance type: external, local, or yunti.
    masterSummaries GetClickhouseInstancesInstanceListMasterSummary[]
    Master node summary information.
    monitor string
    Monitoring information.
    payMode string
    Payment mode: hour or prepay.
    region string
    Region, such as ap-guangzhou.
    regionDesc string
    Region description.
    regionId number
    Region ID.
    renewFlag boolean
    Auto-renewal flag.
    status string
    Instance status: Init, Serving, Deleted, Deleting, Modify.
    statusDesc string
    Status description.
    subnetId string
    Subnet ID.
    tags GetClickhouseInstancesInstanceListTag[]
    Tag filter, multiple tags must be matched at the same time.
    upgradeVersions string
    Upgradeable versions.
    version string
    Instance version.
    vpcId string
    VPC ID.
    zone string
    Availability zone, such as ap-guangzhou-3.
    zoneDesc string
    Zone description.
    access_info str
    Access address, such as 10.0.0.1:9000.
    can_attach_cbs bool
    Whether CBS can be attached.
    can_attach_cbs_lvm bool
    Whether CBS LVM can be attached.
    can_attach_cos bool
    Whether COS can be attached.
    ch_proxy_vip str
    CHProxy VIP address.
    cls_log_set_id str
    CLS log set ID.
    cls_topic_id str
    CLS topic ID.
    common_summaries Sequence[GetClickhouseInstancesInstanceListCommonSummary]
    Common node summary information.
    components Sequence[GetClickhouseInstancesInstanceListComponent]
    Component list.
    cos_bucket_name str
    COS bucket name.
    create_time str
    Creation time.
    eip str
    Elastic IP address.
    enable_xml_config float
    Whether XML configuration is supported.
    expire_time str
    Expiration time.
    flow_msg str
    Workflow message.
    ha str
    High availability: true or false.
    ha_zk bool
    ZooKeeper high availability.
    has_cls_topic bool
    Whether CLS topic is enabled.
    instance_id str
    Search by instance ID, support exact matching.
    instance_name str
    Search by instance name, support fuzzy matching.
    instance_state_infos Sequence[GetClickhouseInstancesInstanceListInstanceStateInfo]
    Instance state details.
    is_elastic bool
    Whether it is an elastic instance.
    kind str
    Instance type: external, local, or yunti.
    master_summaries Sequence[GetClickhouseInstancesInstanceListMasterSummary]
    Master node summary information.
    monitor str
    Monitoring information.
    pay_mode str
    Payment mode: hour or prepay.
    region str
    Region, such as ap-guangzhou.
    region_desc str
    Region description.
    region_id float
    Region ID.
    renew_flag bool
    Auto-renewal flag.
    status str
    Instance status: Init, Serving, Deleted, Deleting, Modify.
    status_desc str
    Status description.
    subnet_id str
    Subnet ID.
    tags Sequence[GetClickhouseInstancesInstanceListTag]
    Tag filter, multiple tags must be matched at the same time.
    upgrade_versions str
    Upgradeable versions.
    version str
    Instance version.
    vpc_id str
    VPC ID.
    zone str
    Availability zone, such as ap-guangzhou-3.
    zone_desc str
    Zone description.
    accessInfo String
    Access address, such as 10.0.0.1:9000.
    canAttachCbs Boolean
    Whether CBS can be attached.
    canAttachCbsLvm Boolean
    Whether CBS LVM can be attached.
    canAttachCos Boolean
    Whether COS can be attached.
    chProxyVip String
    CHProxy VIP address.
    clsLogSetId String
    CLS log set ID.
    clsTopicId String
    CLS topic ID.
    commonSummaries List<Property Map>
    Common node summary information.
    components List<Property Map>
    Component list.
    cosBucketName String
    COS bucket name.
    createTime String
    Creation time.
    eip String
    Elastic IP address.
    enableXmlConfig Number
    Whether XML configuration is supported.
    expireTime String
    Expiration time.
    flowMsg String
    Workflow message.
    ha String
    High availability: true or false.
    haZk Boolean
    ZooKeeper high availability.
    hasClsTopic Boolean
    Whether CLS topic is enabled.
    instanceId String
    Search by instance ID, support exact matching.
    instanceName String
    Search by instance name, support fuzzy matching.
    instanceStateInfos List<Property Map>
    Instance state details.
    isElastic Boolean
    Whether it is an elastic instance.
    kind String
    Instance type: external, local, or yunti.
    masterSummaries List<Property Map>
    Master node summary information.
    monitor String
    Monitoring information.
    payMode String
    Payment mode: hour or prepay.
    region String
    Region, such as ap-guangzhou.
    regionDesc String
    Region description.
    regionId Number
    Region ID.
    renewFlag Boolean
    Auto-renewal flag.
    status String
    Instance status: Init, Serving, Deleted, Deleting, Modify.
    statusDesc String
    Status description.
    subnetId String
    Subnet ID.
    tags List<Property Map>
    Tag filter, multiple tags must be matched at the same time.
    upgradeVersions String
    Upgradeable versions.
    version String
    Instance version.
    vpcId String
    VPC ID.
    zone String
    Availability zone, such as ap-guangzhou-3.
    zoneDesc String
    Zone description.

    GetClickhouseInstancesInstanceListCommonSummary

    AttachCbsSpecs List<GetClickhouseInstancesInstanceListCommonSummaryAttachCbsSpec>
    Attached CBS specification.
    Core double
    CPU cores.
    Disk double
    Disk size in GB.
    DiskCount double
    Number of disks.
    DiskDesc string
    Disk description.
    DiskType string
    Disk type.
    Encrypt double
    Encryption status.
    MaxDiskSize double
    Maximum disk size.
    Memory double
    Memory size in GB.
    NodeSize double
    Number of nodes.
    Spec string
    Specification name.
    SpecCore double
    Specification CPU cores.
    SpecMemory double
    Specification memory.
    SubProductType string
    Sub-product type.
    AttachCbsSpecs []GetClickhouseInstancesInstanceListCommonSummaryAttachCbsSpec
    Attached CBS specification.
    Core float64
    CPU cores.
    Disk float64
    Disk size in GB.
    DiskCount float64
    Number of disks.
    DiskDesc string
    Disk description.
    DiskType string
    Disk type.
    Encrypt float64
    Encryption status.
    MaxDiskSize float64
    Maximum disk size.
    Memory float64
    Memory size in GB.
    NodeSize float64
    Number of nodes.
    Spec string
    Specification name.
    SpecCore float64
    Specification CPU cores.
    SpecMemory float64
    Specification memory.
    SubProductType string
    Sub-product type.
    attachCbsSpecs List<GetClickhouseInstancesInstanceListCommonSummaryAttachCbsSpec>
    Attached CBS specification.
    core Double
    CPU cores.
    disk Double
    Disk size in GB.
    diskCount Double
    Number of disks.
    diskDesc String
    Disk description.
    diskType String
    Disk type.
    encrypt Double
    Encryption status.
    maxDiskSize Double
    Maximum disk size.
    memory Double
    Memory size in GB.
    nodeSize Double
    Number of nodes.
    spec String
    Specification name.
    specCore Double
    Specification CPU cores.
    specMemory Double
    Specification memory.
    subProductType String
    Sub-product type.
    attachCbsSpecs GetClickhouseInstancesInstanceListCommonSummaryAttachCbsSpec[]
    Attached CBS specification.
    core number
    CPU cores.
    disk number
    Disk size in GB.
    diskCount number
    Number of disks.
    diskDesc string
    Disk description.
    diskType string
    Disk type.
    encrypt number
    Encryption status.
    maxDiskSize number
    Maximum disk size.
    memory number
    Memory size in GB.
    nodeSize number
    Number of nodes.
    spec string
    Specification name.
    specCore number
    Specification CPU cores.
    specMemory number
    Specification memory.
    subProductType string
    Sub-product type.
    attach_cbs_specs Sequence[GetClickhouseInstancesInstanceListCommonSummaryAttachCbsSpec]
    Attached CBS specification.
    core float
    CPU cores.
    disk float
    Disk size in GB.
    disk_count float
    Number of disks.
    disk_desc str
    Disk description.
    disk_type str
    Disk type.
    encrypt float
    Encryption status.
    max_disk_size float
    Maximum disk size.
    memory float
    Memory size in GB.
    node_size float
    Number of nodes.
    spec str
    Specification name.
    spec_core float
    Specification CPU cores.
    spec_memory float
    Specification memory.
    sub_product_type str
    Sub-product type.
    attachCbsSpecs List<Property Map>
    Attached CBS specification.
    core Number
    CPU cores.
    disk Number
    Disk size in GB.
    diskCount Number
    Number of disks.
    diskDesc String
    Disk description.
    diskType String
    Disk type.
    encrypt Number
    Encryption status.
    maxDiskSize Number
    Maximum disk size.
    memory Number
    Memory size in GB.
    nodeSize Number
    Number of nodes.
    spec String
    Specification name.
    specCore Number
    Specification CPU cores.
    specMemory Number
    Specification memory.
    subProductType String
    Sub-product type.

    GetClickhouseInstancesInstanceListCommonSummaryAttachCbsSpec

    DiskCount double
    Number of disks.
    DiskDesc string
    Disk description.
    DiskSize double
    Disk size in GB.
    DiskType string
    Disk type.
    DiskCount float64
    Number of disks.
    DiskDesc string
    Disk description.
    DiskSize float64
    Disk size in GB.
    DiskType string
    Disk type.
    diskCount Double
    Number of disks.
    diskDesc String
    Disk description.
    diskSize Double
    Disk size in GB.
    diskType String
    Disk type.
    diskCount number
    Number of disks.
    diskDesc string
    Disk description.
    diskSize number
    Disk size in GB.
    diskType string
    Disk type.
    disk_count float
    Number of disks.
    disk_desc str
    Disk description.
    disk_size float
    Disk size in GB.
    disk_type str
    Disk type.
    diskCount Number
    Number of disks.
    diskDesc String
    Disk description.
    diskSize Number
    Disk size in GB.
    diskType String
    Disk type.

    GetClickhouseInstancesInstanceListComponent

    Name string
    Component name.
    Version string
    Instance version.
    Name string
    Component name.
    Version string
    Instance version.
    name String
    Component name.
    version String
    Instance version.
    name string
    Component name.
    version string
    Instance version.
    name str
    Component name.
    version str
    Instance version.
    name String
    Component name.
    version String
    Instance version.

    GetClickhouseInstancesInstanceListInstanceStateInfo

    FlowCreateTime string
    Workflow creation time.
    FlowMsg string
    Workflow message.
    FlowName string
    Workflow name.
    FlowProgress double
    Workflow progress.
    InstanceState string
    Instance state.
    InstanceStateDesc string
    Instance state description.
    ProcessName string
    Process name.
    FlowCreateTime string
    Workflow creation time.
    FlowMsg string
    Workflow message.
    FlowName string
    Workflow name.
    FlowProgress float64
    Workflow progress.
    InstanceState string
    Instance state.
    InstanceStateDesc string
    Instance state description.
    ProcessName string
    Process name.
    flowCreateTime String
    Workflow creation time.
    flowMsg String
    Workflow message.
    flowName String
    Workflow name.
    flowProgress Double
    Workflow progress.
    instanceState String
    Instance state.
    instanceStateDesc String
    Instance state description.
    processName String
    Process name.
    flowCreateTime string
    Workflow creation time.
    flowMsg string
    Workflow message.
    flowName string
    Workflow name.
    flowProgress number
    Workflow progress.
    instanceState string
    Instance state.
    instanceStateDesc string
    Instance state description.
    processName string
    Process name.
    flow_create_time str
    Workflow creation time.
    flow_msg str
    Workflow message.
    flow_name str
    Workflow name.
    flow_progress float
    Workflow progress.
    instance_state str
    Instance state.
    instance_state_desc str
    Instance state description.
    process_name str
    Process name.
    flowCreateTime String
    Workflow creation time.
    flowMsg String
    Workflow message.
    flowName String
    Workflow name.
    flowProgress Number
    Workflow progress.
    instanceState String
    Instance state.
    instanceStateDesc String
    Instance state description.
    processName String
    Process name.

    GetClickhouseInstancesInstanceListMasterSummary

    AttachCbsSpecs List<GetClickhouseInstancesInstanceListMasterSummaryAttachCbsSpec>
    Attached CBS specification.
    Core double
    CPU cores.
    Disk double
    Disk size in GB.
    DiskCount double
    Number of disks.
    DiskDesc string
    Disk description.
    DiskType string
    Disk type.
    Encrypt double
    Encryption status.
    MaxDiskSize double
    Maximum disk size.
    Memory double
    Memory size in GB.
    NodeSize double
    Number of nodes.
    Spec string
    Specification name.
    SpecCore double
    Specification CPU cores.
    SpecMemory double
    Specification memory.
    SubProductType string
    Sub-product type.
    AttachCbsSpecs []GetClickhouseInstancesInstanceListMasterSummaryAttachCbsSpec
    Attached CBS specification.
    Core float64
    CPU cores.
    Disk float64
    Disk size in GB.
    DiskCount float64
    Number of disks.
    DiskDesc string
    Disk description.
    DiskType string
    Disk type.
    Encrypt float64
    Encryption status.
    MaxDiskSize float64
    Maximum disk size.
    Memory float64
    Memory size in GB.
    NodeSize float64
    Number of nodes.
    Spec string
    Specification name.
    SpecCore float64
    Specification CPU cores.
    SpecMemory float64
    Specification memory.
    SubProductType string
    Sub-product type.
    attachCbsSpecs List<GetClickhouseInstancesInstanceListMasterSummaryAttachCbsSpec>
    Attached CBS specification.
    core Double
    CPU cores.
    disk Double
    Disk size in GB.
    diskCount Double
    Number of disks.
    diskDesc String
    Disk description.
    diskType String
    Disk type.
    encrypt Double
    Encryption status.
    maxDiskSize Double
    Maximum disk size.
    memory Double
    Memory size in GB.
    nodeSize Double
    Number of nodes.
    spec String
    Specification name.
    specCore Double
    Specification CPU cores.
    specMemory Double
    Specification memory.
    subProductType String
    Sub-product type.
    attachCbsSpecs GetClickhouseInstancesInstanceListMasterSummaryAttachCbsSpec[]
    Attached CBS specification.
    core number
    CPU cores.
    disk number
    Disk size in GB.
    diskCount number
    Number of disks.
    diskDesc string
    Disk description.
    diskType string
    Disk type.
    encrypt number
    Encryption status.
    maxDiskSize number
    Maximum disk size.
    memory number
    Memory size in GB.
    nodeSize number
    Number of nodes.
    spec string
    Specification name.
    specCore number
    Specification CPU cores.
    specMemory number
    Specification memory.
    subProductType string
    Sub-product type.
    attach_cbs_specs Sequence[GetClickhouseInstancesInstanceListMasterSummaryAttachCbsSpec]
    Attached CBS specification.
    core float
    CPU cores.
    disk float
    Disk size in GB.
    disk_count float
    Number of disks.
    disk_desc str
    Disk description.
    disk_type str
    Disk type.
    encrypt float
    Encryption status.
    max_disk_size float
    Maximum disk size.
    memory float
    Memory size in GB.
    node_size float
    Number of nodes.
    spec str
    Specification name.
    spec_core float
    Specification CPU cores.
    spec_memory float
    Specification memory.
    sub_product_type str
    Sub-product type.
    attachCbsSpecs List<Property Map>
    Attached CBS specification.
    core Number
    CPU cores.
    disk Number
    Disk size in GB.
    diskCount Number
    Number of disks.
    diskDesc String
    Disk description.
    diskType String
    Disk type.
    encrypt Number
    Encryption status.
    maxDiskSize Number
    Maximum disk size.
    memory Number
    Memory size in GB.
    nodeSize Number
    Number of nodes.
    spec String
    Specification name.
    specCore Number
    Specification CPU cores.
    specMemory Number
    Specification memory.
    subProductType String
    Sub-product type.

    GetClickhouseInstancesInstanceListMasterSummaryAttachCbsSpec

    DiskCount double
    Number of disks.
    DiskDesc string
    Disk description.
    DiskSize double
    Disk size in GB.
    DiskType string
    Disk type.
    DiskCount float64
    Number of disks.
    DiskDesc string
    Disk description.
    DiskSize float64
    Disk size in GB.
    DiskType string
    Disk type.
    diskCount Double
    Number of disks.
    diskDesc String
    Disk description.
    diskSize Double
    Disk size in GB.
    diskType String
    Disk type.
    diskCount number
    Number of disks.
    diskDesc string
    Disk description.
    diskSize number
    Disk size in GB.
    diskType string
    Disk type.
    disk_count float
    Number of disks.
    disk_desc str
    Disk description.
    disk_size float
    Disk size in GB.
    disk_type str
    Disk type.
    diskCount Number
    Number of disks.
    diskDesc String
    Disk description.
    diskSize Number
    Disk size in GB.
    diskType String
    Disk type.

    GetClickhouseInstancesInstanceListTag

    TagKey string
    Tag key.
    TagValue string
    Tag value.
    TagKey string
    Tag key.
    TagValue string
    Tag value.
    tagKey String
    Tag key.
    tagValue String
    Tag value.
    tagKey string
    Tag key.
    tagValue string
    Tag value.
    tag_key str
    Tag key.
    tag_value str
    Tag value.
    tagKey String
    Tag key.
    tagValue String
    Tag value.

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    Viewing docs for tencentcloud 1.82.79
    published on Friday, Mar 27, 2026 by tencentcloudstack
    Schema (JSON)
    tencentcloudstack/terraform-provider-tencentcloud
      Try Pulumi Cloud free. Your team will thank you.