1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. getClickhouseInstanceNodes
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

tencentcloud.getClickhouseInstanceNodes

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

    Use this data source to query detailed information of clickhouse instance_nodes

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as tencentcloud from "@pulumi/tencentcloud";
    
    const instanceNodes = tencentcloud.getClickhouseInstanceNodes({
        displayPolicy: "all",
        forceAll: true,
        instanceId: "cdwch-mvfjh373",
        nodeRole: "data",
    });
    
    import pulumi
    import pulumi_tencentcloud as tencentcloud
    
    instance_nodes = tencentcloud.get_clickhouse_instance_nodes(display_policy="all",
        force_all=True,
        instance_id="cdwch-mvfjh373",
        node_role="data")
    
    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.GetClickhouseInstanceNodes(ctx, &tencentcloud.GetClickhouseInstanceNodesArgs{
    			DisplayPolicy: pulumi.StringRef("all"),
    			ForceAll:      pulumi.BoolRef(true),
    			InstanceId:    "cdwch-mvfjh373",
    			NodeRole:      pulumi.StringRef("data"),
    		}, 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 instanceNodes = Tencentcloud.GetClickhouseInstanceNodes.Invoke(new()
        {
            DisplayPolicy = "all",
            ForceAll = true,
            InstanceId = "cdwch-mvfjh373",
            NodeRole = "data",
        });
    
    });
    
    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.GetClickhouseInstanceNodesArgs;
    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 instanceNodes = TencentcloudFunctions.getClickhouseInstanceNodes(GetClickhouseInstanceNodesArgs.builder()
                .displayPolicy("all")
                .forceAll(true)
                .instanceId("cdwch-mvfjh373")
                .nodeRole("data")
                .build());
    
        }
    }
    
    variables:
      instanceNodes:
        fn::invoke:
          function: tencentcloud:getClickhouseInstanceNodes
          arguments:
            displayPolicy: all
            forceAll: true
            instanceId: cdwch-mvfjh373
            nodeRole: data
    

    Using getClickhouseInstanceNodes

    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 getClickhouseInstanceNodes(args: GetClickhouseInstanceNodesArgs, opts?: InvokeOptions): Promise<GetClickhouseInstanceNodesResult>
    function getClickhouseInstanceNodesOutput(args: GetClickhouseInstanceNodesOutputArgs, opts?: InvokeOptions): Output<GetClickhouseInstanceNodesResult>
    def get_clickhouse_instance_nodes(display_policy: Optional[str] = None,
                                      force_all: Optional[bool] = None,
                                      id: Optional[str] = None,
                                      instance_id: Optional[str] = None,
                                      node_role: Optional[str] = None,
                                      result_output_file: Optional[str] = None,
                                      opts: Optional[InvokeOptions] = None) -> GetClickhouseInstanceNodesResult
    def get_clickhouse_instance_nodes_output(display_policy: Optional[pulumi.Input[str]] = None,
                                      force_all: Optional[pulumi.Input[bool]] = None,
                                      id: Optional[pulumi.Input[str]] = None,
                                      instance_id: Optional[pulumi.Input[str]] = None,
                                      node_role: Optional[pulumi.Input[str]] = None,
                                      result_output_file: Optional[pulumi.Input[str]] = None,
                                      opts: Optional[InvokeOptions] = None) -> Output[GetClickhouseInstanceNodesResult]
    func GetClickhouseInstanceNodes(ctx *Context, args *GetClickhouseInstanceNodesArgs, opts ...InvokeOption) (*GetClickhouseInstanceNodesResult, error)
    func GetClickhouseInstanceNodesOutput(ctx *Context, args *GetClickhouseInstanceNodesOutputArgs, opts ...InvokeOption) GetClickhouseInstanceNodesResultOutput

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

    public static class GetClickhouseInstanceNodes 
    {
        public static Task<GetClickhouseInstanceNodesResult> InvokeAsync(GetClickhouseInstanceNodesArgs args, InvokeOptions? opts = null)
        public static Output<GetClickhouseInstanceNodesResult> Invoke(GetClickhouseInstanceNodesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetClickhouseInstanceNodesResult> getClickhouseInstanceNodes(GetClickhouseInstanceNodesArgs args, InvokeOptions options)
    public static Output<GetClickhouseInstanceNodesResult> getClickhouseInstanceNodes(GetClickhouseInstanceNodesArgs args, InvokeOptions options)
    
    fn::invoke:
      function: tencentcloud:index/getClickhouseInstanceNodes:getClickhouseInstanceNodes
      arguments:
        # arguments dictionary

    The following arguments are supported:

    InstanceId string
    InstanceId.
    DisplayPolicy string
    Display strategy, display all when All.
    ForceAll bool
    When true, returns all nodes, that is, the Limit is infinitely large.
    Id string
    NodeRole string
    Cluster role type, default is data data node.
    ResultOutputFile string
    Used to save results.
    InstanceId string
    InstanceId.
    DisplayPolicy string
    Display strategy, display all when All.
    ForceAll bool
    When true, returns all nodes, that is, the Limit is infinitely large.
    Id string
    NodeRole string
    Cluster role type, default is data data node.
    ResultOutputFile string
    Used to save results.
    instanceId String
    InstanceId.
    displayPolicy String
    Display strategy, display all when All.
    forceAll Boolean
    When true, returns all nodes, that is, the Limit is infinitely large.
    id String
    nodeRole String
    Cluster role type, default is data data node.
    resultOutputFile String
    Used to save results.
    instanceId string
    InstanceId.
    displayPolicy string
    Display strategy, display all when All.
    forceAll boolean
    When true, returns all nodes, that is, the Limit is infinitely large.
    id string
    nodeRole string
    Cluster role type, default is data data node.
    resultOutputFile string
    Used to save results.
    instance_id str
    InstanceId.
    display_policy str
    Display strategy, display all when All.
    force_all bool
    When true, returns all nodes, that is, the Limit is infinitely large.
    id str
    node_role str
    Cluster role type, default is data data node.
    result_output_file str
    Used to save results.
    instanceId String
    InstanceId.
    displayPolicy String
    Display strategy, display all when All.
    forceAll Boolean
    When true, returns all nodes, that is, the Limit is infinitely large.
    id String
    nodeRole String
    Cluster role type, default is data data node.
    resultOutputFile String
    Used to save results.

    getClickhouseInstanceNodes Result

    The following output properties are available:

    id String
    instanceId String
    instanceNodesLists List<Property Map>
    Total number of instance nodes.
    displayPolicy String
    forceAll Boolean
    nodeRole String
    resultOutputFile String

    Supporting Types

    GetClickhouseInstanceNodesInstanceNodesList

    Cluster string
    Name of the clickhouse cluster to which it belongs.
    Core double
    CPU cores.
    DiskSize double
    Disk size.
    DiskType string
    Disk type.
    Ip string
    IP Address.
    IsChProxy bool
    When true, it indicates that the chproxy process has been deployed on the node.
    Memory double
    Memory size.
    NodeGroups List<GetClickhouseInstanceNodesInstanceNodesListNodeGroup>
    Group information to which the node belongs.
    Rip string
    VPC IP.
    Spec string
    Model, such as S1.
    Cluster string
    Name of the clickhouse cluster to which it belongs.
    Core float64
    CPU cores.
    DiskSize float64
    Disk size.
    DiskType string
    Disk type.
    Ip string
    IP Address.
    IsChProxy bool
    When true, it indicates that the chproxy process has been deployed on the node.
    Memory float64
    Memory size.
    NodeGroups []GetClickhouseInstanceNodesInstanceNodesListNodeGroup
    Group information to which the node belongs.
    Rip string
    VPC IP.
    Spec string
    Model, such as S1.
    cluster String
    Name of the clickhouse cluster to which it belongs.
    core Double
    CPU cores.
    diskSize Double
    Disk size.
    diskType String
    Disk type.
    ip String
    IP Address.
    isChProxy Boolean
    When true, it indicates that the chproxy process has been deployed on the node.
    memory Double
    Memory size.
    nodeGroups List<GetClickhouseInstanceNodesInstanceNodesListNodeGroup>
    Group information to which the node belongs.
    rip String
    VPC IP.
    spec String
    Model, such as S1.
    cluster string
    Name of the clickhouse cluster to which it belongs.
    core number
    CPU cores.
    diskSize number
    Disk size.
    diskType string
    Disk type.
    ip string
    IP Address.
    isChProxy boolean
    When true, it indicates that the chproxy process has been deployed on the node.
    memory number
    Memory size.
    nodeGroups GetClickhouseInstanceNodesInstanceNodesListNodeGroup[]
    Group information to which the node belongs.
    rip string
    VPC IP.
    spec string
    Model, such as S1.
    cluster str
    Name of the clickhouse cluster to which it belongs.
    core float
    CPU cores.
    disk_size float
    Disk size.
    disk_type str
    Disk type.
    ip str
    IP Address.
    is_ch_proxy bool
    When true, it indicates that the chproxy process has been deployed on the node.
    memory float
    Memory size.
    node_groups Sequence[GetClickhouseInstanceNodesInstanceNodesListNodeGroup]
    Group information to which the node belongs.
    rip str
    VPC IP.
    spec str
    Model, such as S1.
    cluster String
    Name of the clickhouse cluster to which it belongs.
    core Number
    CPU cores.
    diskSize Number
    Disk size.
    diskType String
    Disk type.
    ip String
    IP Address.
    isChProxy Boolean
    When true, it indicates that the chproxy process has been deployed on the node.
    memory Number
    Memory size.
    nodeGroups List<Property Map>
    Group information to which the node belongs.
    rip String
    VPC IP.
    spec String
    Model, such as S1.

    GetClickhouseInstanceNodesInstanceNodesListNodeGroup

    GroupName string
    Group Name.
    ReplicaName string
    Copy variable name.
    ShardName string
    Fragmented variable name.
    GroupName string
    Group Name.
    ReplicaName string
    Copy variable name.
    ShardName string
    Fragmented variable name.
    groupName String
    Group Name.
    replicaName String
    Copy variable name.
    shardName String
    Fragmented variable name.
    groupName string
    Group Name.
    replicaName string
    Copy variable name.
    shardName string
    Fragmented variable name.
    group_name str
    Group Name.
    replica_name str
    Copy variable name.
    shard_name str
    Fragmented variable name.
    groupName String
    Group Name.
    replicaName String
    Copy variable name.
    shardName String
    Fragmented variable name.

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack