1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. getElasticsearchInstances
tencentcloud 1.82.34 published on Wednesday, Nov 5, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getElasticsearchInstances

Start a Neo task
Explain and create a tencentcloud.getElasticsearchInstances resource
tencentcloud logo
tencentcloud 1.82.34 published on Wednesday, Nov 5, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

    Use this data source to query Elasticsearch(ES) instances.

    Example Usage

    Query ES instances by filters

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

const example = tencentcloud.getElasticsearchInstances({
    instanceId: "es-bxffils7",
    instanceName: "tf-example",
    tags: {
        createBy: "Terraform",
    },
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

example = tencentcloud.get_elasticsearch_instances(instance_id="es-bxffils7",
    instance_name="tf-example",
    tags={
        "createBy": "Terraform",
    })

    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.GetElasticsearchInstances(ctx, &tencentcloud.GetElasticsearchInstancesArgs{
			InstanceId:   pulumi.StringRef("es-bxffils7"),
			InstanceName: pulumi.StringRef("tf-example"),
			Tags: map[string]interface{}{
				"createBy": "Terraform",
			},
		}, 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 example = Tencentcloud.GetElasticsearchInstances.Invoke(new()
    {
        InstanceId = "es-bxffils7",
        InstanceName = "tf-example",
        Tags = 
        {
            { "createBy", "Terraform" },
        },
    });

});

    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.GetElasticsearchInstancesArgs;
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 example = TencentcloudFunctions.getElasticsearchInstances(GetElasticsearchInstancesArgs.builder()
            .instanceId("es-bxffils7")
            .instanceName("tf-example")
            .tags(Map.of("createBy", "Terraform"))
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: tencentcloud:getElasticsearchInstances
      arguments:
        instanceId: es-bxffils7
        instanceName: tf-example
        tags:
          createBy: Terraform

    Using getElasticsearchInstances

    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 getElasticsearchInstances(args: GetElasticsearchInstancesArgs, opts?: InvokeOptions): Promise<GetElasticsearchInstancesResult>
function getElasticsearchInstancesOutput(args: GetElasticsearchInstancesOutputArgs, opts?: InvokeOptions): Output<GetElasticsearchInstancesResult>
    def get_elasticsearch_instances(id: Optional[str] = None,
                                instance_id: Optional[str] = None,
                                instance_name: Optional[str] = None,
                                result_output_file: Optional[str] = None,
                                tags: Optional[Mapping[str, str]] = None,
                                opts: Optional[InvokeOptions] = None) -> GetElasticsearchInstancesResult
def get_elasticsearch_instances_output(id: Optional[pulumi.Input[str]] = None,
                                instance_id: Optional[pulumi.Input[str]] = None,
                                instance_name: Optional[pulumi.Input[str]] = None,
                                result_output_file: Optional[pulumi.Input[str]] = None,
                                tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetElasticsearchInstancesResult]
    func GetElasticsearchInstances(ctx *Context, args *GetElasticsearchInstancesArgs, opts ...InvokeOption) (*GetElasticsearchInstancesResult, error)
func GetElasticsearchInstancesOutput(ctx *Context, args *GetElasticsearchInstancesOutputArgs, opts ...InvokeOption) GetElasticsearchInstancesResultOutput

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

    public static class GetElasticsearchInstances 
{
    public static Task<GetElasticsearchInstancesResult> InvokeAsync(GetElasticsearchInstancesArgs args, InvokeOptions? opts = null)
    public static Output<GetElasticsearchInstancesResult> Invoke(GetElasticsearchInstancesInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetElasticsearchInstancesResult> getElasticsearchInstances(GetElasticsearchInstancesArgs args, InvokeOptions options)
public static Output<GetElasticsearchInstancesResult> getElasticsearchInstances(GetElasticsearchInstancesArgs args, InvokeOptions options)

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

    The following arguments are supported:

    Id string
    InstanceId string
    ID of the instance to be queried.
    InstanceName string
    Name of the instance to be queried.
    ResultOutputFile string
    Used to save results.
    Tags Dictionary<string, string>
    Tag of the instance to be queried.
    Id string
    InstanceId string
    ID of the instance to be queried.
    InstanceName string
    Name of the instance to be queried.
    ResultOutputFile string
    Used to save results.
    Tags map[string]string
    Tag of the instance to be queried.
    id String
    instanceId String
    ID of the instance to be queried.
    instanceName String
    Name of the instance to be queried.
    resultOutputFile String
    Used to save results.
    tags Map<String,String>
    Tag of the instance to be queried.
    id string
    instanceId string
    ID of the instance to be queried.
    instanceName string
    Name of the instance to be queried.
    resultOutputFile string
    Used to save results.
    tags {[key: string]: string}
    Tag of the instance to be queried.
    id str
    instance_id str
    ID of the instance to be queried.
    instance_name str
    Name of the instance to be queried.
    result_output_file str
    Used to save results.
    tags Mapping[str, str]
    Tag of the instance to be queried.
    id String
    instanceId String
    ID of the instance to be queried.
    instanceName String
    Name of the instance to be queried.
    resultOutputFile String
    Used to save results.
    tags Map<String>
    Tag of the instance to be queried.

    getElasticsearchInstances Result

    The following output properties are available:

    Id string
    InstanceLists List<GetElasticsearchInstancesInstanceList>
    An information list of elasticsearch instance. Each element contains the following attributes:
    InstanceId string
    ID of the instance.
    InstanceName string
    Name of the instance.
    ResultOutputFile string
    Tags Dictionary<string, string>
    A mapping of tags to assign to the instance.
    Id string
    InstanceLists []GetElasticsearchInstancesInstanceList
    An information list of elasticsearch instance. Each element contains the following attributes:
    InstanceId string
    ID of the instance.
    InstanceName string
    Name of the instance.
    ResultOutputFile string
    Tags map[string]string
    A mapping of tags to assign to the instance.
    id String
    instanceLists List<GetElasticsearchInstancesInstanceList>
    An information list of elasticsearch instance. Each element contains the following attributes:
    instanceId String
    ID of the instance.
    instanceName String
    Name of the instance.
    resultOutputFile String
    tags Map<String,String>
    A mapping of tags to assign to the instance.
    id string
    instanceLists GetElasticsearchInstancesInstanceList[]
    An information list of elasticsearch instance. Each element contains the following attributes:
    instanceId string
    ID of the instance.
    instanceName string
    Name of the instance.
    resultOutputFile string
    tags {[key: string]: string}
    A mapping of tags to assign to the instance.
    id str
    instance_lists Sequence[GetElasticsearchInstancesInstanceList]
    An information list of elasticsearch instance. Each element contains the following attributes:
    instance_id str
    ID of the instance.
    instance_name str
    Name of the instance.
    result_output_file str
    tags Mapping[str, str]
    A mapping of tags to assign to the instance.
    id String
    instanceLists List<Property Map>
    An information list of elasticsearch instance. Each element contains the following attributes:
    instanceId String
    ID of the instance.
    instanceName String
    Name of the instance.
    resultOutputFile String
    tags Map<String>
    A mapping of tags to assign to the instance.

    Supporting Types

    GetElasticsearchInstancesInstanceList

    AvailabilityZone string
    Availability zone.
    BasicSecurityType double
    Whether to enable X-Pack security authentication in Basic Edition 6.8 and above.
    ChargeType string
    The charge type of instance.
    CreateTime string
    Instance creation time.
    DeployMode double
    Cluster deployment mode.
    ElasticsearchDomain string
    Elasticsearch domain name.
    ElasticsearchPort double
    Elasticsearch port.
    ElasticsearchPublicUrl string
    Elasticsearch public url.
    ElasticsearchVip string
    Elasticsearch VIP.
    InstanceId string
    ID of the instance to be queried.
    InstanceName string
    Name of the instance to be queried.
    KibanaUrl string
    Kibana access URL.
    LicenseType string
    License type.
    MultiZoneInfos List<GetElasticsearchInstancesInstanceListMultiZoneInfo>
    Details of AZs in multi-AZ deployment mode.
    NodeInfoLists List<GetElasticsearchInstancesInstanceListNodeInfoList>
    Node information list, which describe the specification information of various types of nodes in the cluster.
    SubnetId string
    The ID of a VPC subnet.
    Tags Dictionary<string, string>
    Tag of the instance to be queried.
    Version string
    Version of the instance.
    VpcId string
    The ID of a VPC network.
    AvailabilityZone string
    Availability zone.
    BasicSecurityType float64
    Whether to enable X-Pack security authentication in Basic Edition 6.8 and above.
    ChargeType string
    The charge type of instance.
    CreateTime string
    Instance creation time.
    DeployMode float64
    Cluster deployment mode.
    ElasticsearchDomain string
    Elasticsearch domain name.
    ElasticsearchPort float64
    Elasticsearch port.
    ElasticsearchPublicUrl string
    Elasticsearch public url.
    ElasticsearchVip string
    Elasticsearch VIP.
    InstanceId string
    ID of the instance to be queried.
    InstanceName string
    Name of the instance to be queried.
    KibanaUrl string
    Kibana access URL.
    LicenseType string
    License type.
    MultiZoneInfos []GetElasticsearchInstancesInstanceListMultiZoneInfo
    Details of AZs in multi-AZ deployment mode.
    NodeInfoLists []GetElasticsearchInstancesInstanceListNodeInfoList
    Node information list, which describe the specification information of various types of nodes in the cluster.
    SubnetId string
    The ID of a VPC subnet.
    Tags map[string]string
    Tag of the instance to be queried.
    Version string
    Version of the instance.
    VpcId string
    The ID of a VPC network.
    availabilityZone String
    Availability zone.
    basicSecurityType Double
    Whether to enable X-Pack security authentication in Basic Edition 6.8 and above.
    chargeType String
    The charge type of instance.
    createTime String
    Instance creation time.
    deployMode Double
    Cluster deployment mode.
    elasticsearchDomain String
    Elasticsearch domain name.
    elasticsearchPort Double
    Elasticsearch port.
    elasticsearchPublicUrl String
    Elasticsearch public url.
    elasticsearchVip String
    Elasticsearch VIP.
    instanceId String
    ID of the instance to be queried.
    instanceName String
    Name of the instance to be queried.
    kibanaUrl String
    Kibana access URL.
    licenseType String
    License type.
    multiZoneInfos List<GetElasticsearchInstancesInstanceListMultiZoneInfo>
    Details of AZs in multi-AZ deployment mode.
    nodeInfoLists List<GetElasticsearchInstancesInstanceListNodeInfoList>
    Node information list, which describe the specification information of various types of nodes in the cluster.
    subnetId String
    The ID of a VPC subnet.
    tags Map<String,String>
    Tag of the instance to be queried.
    version String
    Version of the instance.
    vpcId String
    The ID of a VPC network.
    availabilityZone string
    Availability zone.
    basicSecurityType number
    Whether to enable X-Pack security authentication in Basic Edition 6.8 and above.
    chargeType string
    The charge type of instance.
    createTime string
    Instance creation time.
    deployMode number
    Cluster deployment mode.
    elasticsearchDomain string
    Elasticsearch domain name.
    elasticsearchPort number
    Elasticsearch port.
    elasticsearchPublicUrl string
    Elasticsearch public url.
    elasticsearchVip string
    Elasticsearch VIP.
    instanceId string
    ID of the instance to be queried.
    instanceName string
    Name of the instance to be queried.
    kibanaUrl string
    Kibana access URL.
    licenseType string
    License type.
    multiZoneInfos GetElasticsearchInstancesInstanceListMultiZoneInfo[]
    Details of AZs in multi-AZ deployment mode.
    nodeInfoLists GetElasticsearchInstancesInstanceListNodeInfoList[]
    Node information list, which describe the specification information of various types of nodes in the cluster.
    subnetId string
    The ID of a VPC subnet.
    tags {[key: string]: string}
    Tag of the instance to be queried.
    version string
    Version of the instance.
    vpcId string
    The ID of a VPC network.
    availability_zone str
    Availability zone.
    basic_security_type float
    Whether to enable X-Pack security authentication in Basic Edition 6.8 and above.
    charge_type str
    The charge type of instance.
    create_time str
    Instance creation time.
    deploy_mode float
    Cluster deployment mode.
    elasticsearch_domain str
    Elasticsearch domain name.
    elasticsearch_port float
    Elasticsearch port.
    elasticsearch_public_url str
    Elasticsearch public url.
    elasticsearch_vip str
    Elasticsearch VIP.
    instance_id str
    ID of the instance to be queried.
    instance_name str
    Name of the instance to be queried.
    kibana_url str
    Kibana access URL.
    license_type str
    License type.
    multi_zone_infos Sequence[GetElasticsearchInstancesInstanceListMultiZoneInfo]
    Details of AZs in multi-AZ deployment mode.
    node_info_lists Sequence[GetElasticsearchInstancesInstanceListNodeInfoList]
    Node information list, which describe the specification information of various types of nodes in the cluster.
    subnet_id str
    The ID of a VPC subnet.
    tags Mapping[str, str]
    Tag of the instance to be queried.
    version str
    Version of the instance.
    vpc_id str
    The ID of a VPC network.
    availabilityZone String
    Availability zone.
    basicSecurityType Number
    Whether to enable X-Pack security authentication in Basic Edition 6.8 and above.
    chargeType String
    The charge type of instance.
    createTime String
    Instance creation time.
    deployMode Number
    Cluster deployment mode.
    elasticsearchDomain String
    Elasticsearch domain name.
    elasticsearchPort Number
    Elasticsearch port.
    elasticsearchPublicUrl String
    Elasticsearch public url.
    elasticsearchVip String
    Elasticsearch VIP.
    instanceId String
    ID of the instance to be queried.
    instanceName String
    Name of the instance to be queried.
    kibanaUrl String
    Kibana access URL.
    licenseType String
    License type.
    multiZoneInfos List<Property Map>
    Details of AZs in multi-AZ deployment mode.
    nodeInfoLists List<Property Map>
    Node information list, which describe the specification information of various types of nodes in the cluster.
    subnetId String
    The ID of a VPC subnet.
    tags Map<String>
    Tag of the instance to be queried.
    version String
    Version of the instance.
    vpcId String
    The ID of a VPC network.

    GetElasticsearchInstancesInstanceListMultiZoneInfo

    AvailabilityZone string
    Availability zone.
    SubnetId string
    The ID of a VPC subnet.
    AvailabilityZone string
    Availability zone.
    SubnetId string
    The ID of a VPC subnet.
    availabilityZone String
    Availability zone.
    subnetId String
    The ID of a VPC subnet.
    availabilityZone string
    Availability zone.
    subnetId string
    The ID of a VPC subnet.
    availability_zone str
    Availability zone.
    subnet_id str
    The ID of a VPC subnet.
    availabilityZone String
    Availability zone.
    subnetId String
    The ID of a VPC subnet.

    GetElasticsearchInstancesInstanceListNodeInfoList

    DiskSize double
    Node disk size.
    DiskType string
    Node disk type.
    Encrypt bool
    Decides this disk encrypted or not.
    NodeNum double
    Number of nodes.
    NodeType string
    Node specification.
    Type string
    Node type.
    DiskSize float64
    Node disk size.
    DiskType string
    Node disk type.
    Encrypt bool
    Decides this disk encrypted or not.
    NodeNum float64
    Number of nodes.
    NodeType string
    Node specification.
    Type string
    Node type.
    diskSize Double
    Node disk size.
    diskType String
    Node disk type.
    encrypt Boolean
    Decides this disk encrypted or not.
    nodeNum Double
    Number of nodes.
    nodeType String
    Node specification.
    type String
    Node type.
    diskSize number
    Node disk size.
    diskType string
    Node disk type.
    encrypt boolean
    Decides this disk encrypted or not.
    nodeNum number
    Number of nodes.
    nodeType string
    Node specification.
    type string
    Node type.
    disk_size float
    Node disk size.
    disk_type str
    Node disk type.
    encrypt bool
    Decides this disk encrypted or not.
    node_num float
    Number of nodes.
    node_type str
    Node specification.
    type str
    Node type.
    diskSize Number
    Node disk size.
    diskType String
    Node disk type.
    encrypt Boolean
    Decides this disk encrypted or not.
    nodeNum Number
    Number of nodes.
    nodeType String
    Node specification.
    type String
    Node type.

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.82.34 published on Wednesday, Nov 5, 2025 by tencentcloudstack
    tencentcloudstack/terraform-provider-tencentcloud
      Meet Neo: Your AI Platform Teammate