tencentcloud 1.81.189, Apr 30 25

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

tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getElasticsearchDescribeIndexList

Explore with Pulumi AI

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

tencentcloudstack/terraform-provider-tencentcloud

Example Usage

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

const describeIndexList = tencentcloud.getElasticsearchDescribeIndexList({
    indexType: "normal",
    instanceId: "es-nni6pm4s",
});

import pulumi
import pulumi_tencentcloud as tencentcloud

describe_index_list = tencentcloud.get_elasticsearch_describe_index_list(index_type="normal",
    instance_id="es-nni6pm4s")

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.GetElasticsearchDescribeIndexList(ctx, &tencentcloud.GetElasticsearchDescribeIndexListArgs{
			IndexType:  "normal",
			InstanceId: pulumi.StringRef("es-nni6pm4s"),
		}, 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 describeIndexList = Tencentcloud.GetElasticsearchDescribeIndexList.Invoke(new()
    {
        IndexType = "normal",
        InstanceId = "es-nni6pm4s",
    });

});

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.GetElasticsearchDescribeIndexListArgs;
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 describeIndexList = TencentcloudFunctions.getElasticsearchDescribeIndexList(GetElasticsearchDescribeIndexListArgs.builder()
            .indexType("normal")
            .instanceId("es-nni6pm4s")
            .build());

    }
}

variables:
  describeIndexList:
    fn::invoke:
      function: tencentcloud:getElasticsearchDescribeIndexList
      arguments:
        indexType: normal
        instanceId: es-nni6pm4s

Using getElasticsearchDescribeIndexList

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 getElasticsearchDescribeIndexList(args: GetElasticsearchDescribeIndexListArgs, opts?: InvokeOptions): Promise<GetElasticsearchDescribeIndexListResult>
function getElasticsearchDescribeIndexListOutput(args: GetElasticsearchDescribeIndexListOutputArgs, opts?: InvokeOptions): Output<GetElasticsearchDescribeIndexListResult>

def get_elasticsearch_describe_index_list(id: Optional[str] = None,
                                          index_name: Optional[str] = None,
                                          index_status_lists: Optional[Sequence[str]] = None,
                                          index_type: Optional[str] = None,
                                          instance_id: Optional[str] = None,
                                          order: Optional[str] = None,
                                          order_by: Optional[str] = None,
                                          password: Optional[str] = None,
                                          result_output_file: Optional[str] = None,
                                          username: Optional[str] = None,
                                          opts: Optional[InvokeOptions] = None) -> GetElasticsearchDescribeIndexListResult
def get_elasticsearch_describe_index_list_output(id: Optional[pulumi.Input[str]] = None,
                                          index_name: Optional[pulumi.Input[str]] = None,
                                          index_status_lists: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                                          index_type: Optional[pulumi.Input[str]] = None,
                                          instance_id: Optional[pulumi.Input[str]] = None,
                                          order: Optional[pulumi.Input[str]] = None,
                                          order_by: Optional[pulumi.Input[str]] = None,
                                          password: Optional[pulumi.Input[str]] = None,
                                          result_output_file: Optional[pulumi.Input[str]] = None,
                                          username: Optional[pulumi.Input[str]] = None,
                                          opts: Optional[InvokeOptions] = None) -> Output[GetElasticsearchDescribeIndexListResult]

func GetElasticsearchDescribeIndexList(ctx *Context, args *GetElasticsearchDescribeIndexListArgs, opts ...InvokeOption) (*GetElasticsearchDescribeIndexListResult, error)
func GetElasticsearchDescribeIndexListOutput(ctx *Context, args *GetElasticsearchDescribeIndexListOutputArgs, opts ...InvokeOption) GetElasticsearchDescribeIndexListResultOutput

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

public static class GetElasticsearchDescribeIndexList 
{
    public static Task<GetElasticsearchDescribeIndexListResult> InvokeAsync(GetElasticsearchDescribeIndexListArgs args, InvokeOptions? opts = null)
    public static Output<GetElasticsearchDescribeIndexListResult> Invoke(GetElasticsearchDescribeIndexListInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetElasticsearchDescribeIndexListResult> getElasticsearchDescribeIndexList(GetElasticsearchDescribeIndexListArgs args, InvokeOptions options)
public static Output<GetElasticsearchDescribeIndexListResult> getElasticsearchDescribeIndexList(GetElasticsearchDescribeIndexListArgs args, InvokeOptions options)

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

The following arguments are supported:

IndexType string: Index type. auto: Autonomous index; normal: General index.
Id string
IndexName string: Index name. If you fill in the blanks, get all indexes.
IndexStatusLists List<string>: Index status list.
InstanceId string: ES cluster id.
Order string: Sort order, which supports asc and desc. The default is desc data format asc,desc.
OrderBy string: Sort field. Support index name: IndexName, index storage: IndexStorage, index creation time: IndexCreateTime.
Password string: Cluster access password.
ResultOutputFile string: Used to save results.
Username string: Cluster access user name.

IndexType string: Index type. auto: Autonomous index; normal: General index.
Id string
IndexName string: Index name. If you fill in the blanks, get all indexes.
IndexStatusLists []string: Index status list.
InstanceId string: ES cluster id.
Order string: Sort order, which supports asc and desc. The default is desc data format asc,desc.
OrderBy string: Sort field. Support index name: IndexName, index storage: IndexStorage, index creation time: IndexCreateTime.
Password string: Cluster access password.
ResultOutputFile string: Used to save results.
Username string: Cluster access user name.

indexType String: Index type. auto: Autonomous index; normal: General index.
id String
indexName String: Index name. If you fill in the blanks, get all indexes.
indexStatusLists List<String>: Index status list.
instanceId String: ES cluster id.
order String: Sort order, which supports asc and desc. The default is desc data format asc,desc.
orderBy String: Sort field. Support index name: IndexName, index storage: IndexStorage, index creation time: IndexCreateTime.
password String: Cluster access password.
resultOutputFile String: Used to save results.
username String: Cluster access user name.

indexType string: Index type. auto: Autonomous index; normal: General index.
id string
indexName string: Index name. If you fill in the blanks, get all indexes.
indexStatusLists string[]: Index status list.
instanceId string: ES cluster id.
order string: Sort order, which supports asc and desc. The default is desc data format asc,desc.
orderBy string: Sort field. Support index name: IndexName, index storage: IndexStorage, index creation time: IndexCreateTime.
password string: Cluster access password.
resultOutputFile string: Used to save results.
username string: Cluster access user name.

index_type str: Index type. auto: Autonomous index; normal: General index.
id str
index_name str: Index name. If you fill in the blanks, get all indexes.
index_status_lists Sequence[str]: Index status list.
instance_id str: ES cluster id.
order str: Sort order, which supports asc and desc. The default is desc data format asc,desc.
order_by str: Sort field. Support index name: IndexName, index storage: IndexStorage, index creation time: IndexCreateTime.
password str: Cluster access password.
result_output_file str: Used to save results.
username str: Cluster access user name.

indexType String: Index type. auto: Autonomous index; normal: General index.
id String
indexName String: Index name. If you fill in the blanks, get all indexes.
indexStatusLists List<String>: Index status list.
instanceId String: ES cluster id.
order String: Sort order, which supports asc and desc. The default is desc data format asc,desc.
orderBy String: Sort field. Support index name: IndexName, index storage: IndexStorage, index creation time: IndexCreateTime.
password String: Cluster access password.
resultOutputFile String: Used to save results.
username String: Cluster access user name.

getElasticsearchDescribeIndexList Result

The following output properties are available:

Id string
IndexMetaFields List<GetElasticsearchDescribeIndexListIndexMetaField>: Index metadata field.
IndexType string: Index type.
IndexName string: Index name.
IndexStatusLists List<string>
InstanceId string
Order string
OrderBy string
Password string
ResultOutputFile string
Username string

Id string
IndexMetaFields []GetElasticsearchDescribeIndexListIndexMetaField: Index metadata field.
IndexType string: Index type.
IndexName string: Index name.
IndexStatusLists []string
InstanceId string
Order string
OrderBy string
Password string
ResultOutputFile string
Username string

id String
indexMetaFields List<GetElasticsearchDescribeIndexListIndexMetaField>: Index metadata field.
indexType String: Index type.
indexName String: Index name.
indexStatusLists List<String>
instanceId String
order String
orderBy String
password String
resultOutputFile String
username String

id string
indexMetaFields GetElasticsearchDescribeIndexListIndexMetaField[]: Index metadata field.
indexType string: Index type.
indexName string: Index name.
indexStatusLists string[]
instanceId string
order string
orderBy string
password string
resultOutputFile string
username string

id str
index_meta_fields Sequence[GetElasticsearchDescribeIndexListIndexMetaField]: Index metadata field.
index_type str: Index type.
index_name str: Index name.
index_status_lists Sequence[str]
instance_id str
order str
order_by str
password str
result_output_file str
username str

id String
indexMetaFields List<Property Map>: Index metadata field.
indexType String: Index type.
indexName String: Index name.
indexStatusLists List<String>
instanceId String
order String
orderBy String
password String
resultOutputFile String
username String

Supporting Types

GetElasticsearchDescribeIndexListIndexMetaField

AppId double: App id.
BackingIndices List<GetElasticsearchDescribeIndexListIndexMetaFieldBackingIndex>: Backing indices.
ClusterId string: Cluster id.
ClusterName string: Cluster name.
ClusterVersion string: Cluster version.
IndexCreateTime string: Index create time.
IndexDocs double: Number of indexed documents.
IndexMetaJson string: Index meta json.
IndexName string: Index name. If you fill in the blanks, get all indexes.
IndexOptionsFields List<GetElasticsearchDescribeIndexListIndexMetaFieldIndexOptionsField>: Index options field.
IndexPolicyFields List<GetElasticsearchDescribeIndexListIndexMetaFieldIndexPolicyField>: Index lifecycle field.
IndexSettingsFields List<GetElasticsearchDescribeIndexListIndexMetaFieldIndexSettingsField>: Index settings field.
IndexStatus string: Index status.
IndexStorage double: Index storage.
IndexType string: Index type. auto: Autonomous index; normal: General index.

AppId float64: App id.
BackingIndices []GetElasticsearchDescribeIndexListIndexMetaFieldBackingIndex: Backing indices.
ClusterId string: Cluster id.
ClusterName string: Cluster name.
ClusterVersion string: Cluster version.
IndexCreateTime string: Index create time.
IndexDocs float64: Number of indexed documents.
IndexMetaJson string: Index meta json.
IndexName string: Index name. If you fill in the blanks, get all indexes.
IndexOptionsFields []GetElasticsearchDescribeIndexListIndexMetaFieldIndexOptionsField: Index options field.
IndexPolicyFields []GetElasticsearchDescribeIndexListIndexMetaFieldIndexPolicyField: Index lifecycle field.
IndexSettingsFields []GetElasticsearchDescribeIndexListIndexMetaFieldIndexSettingsField: Index settings field.
IndexStatus string: Index status.
IndexStorage float64: Index storage.
IndexType string: Index type. auto: Autonomous index; normal: General index.

appId Double: App id.
backingIndices List<GetElasticsearchDescribeIndexListIndexMetaFieldBackingIndex>: Backing indices.
clusterId String: Cluster id.
clusterName String: Cluster name.
clusterVersion String: Cluster version.
indexCreateTime String: Index create time.
indexDocs Double: Number of indexed documents.
indexMetaJson String: Index meta json.
indexName String: Index name. If you fill in the blanks, get all indexes.
indexOptionsFields List<GetElasticsearchDescribeIndexListIndexMetaFieldIndexOptionsField>: Index options field.
indexPolicyFields List<GetElasticsearchDescribeIndexListIndexMetaFieldIndexPolicyField>: Index lifecycle field.
indexSettingsFields List<GetElasticsearchDescribeIndexListIndexMetaFieldIndexSettingsField>: Index settings field.
indexStatus String: Index status.
indexStorage Double: Index storage.
indexType String: Index type. auto: Autonomous index; normal: General index.

appId number: App id.
backingIndices GetElasticsearchDescribeIndexListIndexMetaFieldBackingIndex[]: Backing indices.
clusterId string: Cluster id.
clusterName string: Cluster name.
clusterVersion string: Cluster version.
indexCreateTime string: Index create time.
indexDocs number: Number of indexed documents.
indexMetaJson string: Index meta json.
indexName string: Index name. If you fill in the blanks, get all indexes.
indexOptionsFields GetElasticsearchDescribeIndexListIndexMetaFieldIndexOptionsField[]: Index options field.
indexPolicyFields GetElasticsearchDescribeIndexListIndexMetaFieldIndexPolicyField[]: Index lifecycle field.
indexSettingsFields GetElasticsearchDescribeIndexListIndexMetaFieldIndexSettingsField[]: Index settings field.
indexStatus string: Index status.
indexStorage number: Index storage.
indexType string: Index type. auto: Autonomous index; normal: General index.

app_id float: App id.
backing_indices Sequence[GetElasticsearchDescribeIndexListIndexMetaFieldBackingIndex]: Backing indices.
cluster_id str: Cluster id.
cluster_name str: Cluster name.
cluster_version str: Cluster version.
index_create_time str: Index create time.
index_docs float: Number of indexed documents.
index_meta_json str: Index meta json.
index_name str: Index name. If you fill in the blanks, get all indexes.
index_options_fields Sequence[GetElasticsearchDescribeIndexListIndexMetaFieldIndexOptionsField]: Index options field.
index_policy_fields Sequence[GetElasticsearchDescribeIndexListIndexMetaFieldIndexPolicyField]: Index lifecycle field.
index_settings_fields Sequence[GetElasticsearchDescribeIndexListIndexMetaFieldIndexSettingsField]: Index settings field.
index_status str: Index status.
index_storage float: Index storage.
index_type str: Index type. auto: Autonomous index; normal: General index.

appId Number: App id.
backingIndices List<Property Map>: Backing indices.
clusterId String: Cluster id.
clusterName String: Cluster name.
clusterVersion String: Cluster version.
indexCreateTime String: Index create time.
indexDocs Number: Number of indexed documents.
indexMetaJson String: Index meta json.
indexName String: Index name. If you fill in the blanks, get all indexes.
indexOptionsFields List<Property Map>: Index options field.
indexPolicyFields List<Property Map>: Index lifecycle field.
indexSettingsFields List<Property Map>: Index settings field.
indexStatus String: Index status.
indexStorage Number: Index storage.
indexType String: Index type. auto: Autonomous index; normal: General index.

GetElasticsearchDescribeIndexListIndexMetaFieldBackingIndex

IndexCreateTime string: Index create time.
IndexName string: Index name. If you fill in the blanks, get all indexes.
IndexPhrase string: Index phrase.
IndexStatus string: Index status.
IndexStorage double: Index storage.

IndexCreateTime string: Index create time.
IndexName string: Index name. If you fill in the blanks, get all indexes.
IndexPhrase string: Index phrase.
IndexStatus string: Index status.
IndexStorage float64: Index storage.

indexCreateTime String: Index create time.
indexName String: Index name. If you fill in the blanks, get all indexes.
indexPhrase String: Index phrase.
indexStatus String: Index status.
indexStorage Double: Index storage.

indexCreateTime string: Index create time.
indexName string: Index name. If you fill in the blanks, get all indexes.
indexPhrase string: Index phrase.
indexStatus string: Index status.
indexStorage number: Index storage.

index_create_time str: Index create time.
index_name str: Index name. If you fill in the blanks, get all indexes.
index_phrase str: Index phrase.
index_status str: Index status.
index_storage float: Index storage.

indexCreateTime String: Index create time.
indexName String: Index name. If you fill in the blanks, get all indexes.
indexPhrase String: Index phrase.
indexStatus String: Index status.
indexStorage Number: Index storage.

GetElasticsearchDescribeIndexListIndexMetaFieldIndexOptionsField

ExpireMaxAge string: Expire max age.
ExpireMaxSize string: Expire max size.
RolloverDynamic string: Whether to turn on dynamic scrolling.
RolloverMaxAge string: Rollover max age.
ShardNumDynamic string: Whether to enable dynamic slicing.
TimestampField string: Time partition field.
WriteMode string: Write mode.

ExpireMaxAge string: Expire max age.
ExpireMaxSize string: Expire max size.
RolloverDynamic string: Whether to turn on dynamic scrolling.
RolloverMaxAge string: Rollover max age.
ShardNumDynamic string: Whether to enable dynamic slicing.
TimestampField string: Time partition field.
WriteMode string: Write mode.

expireMaxAge String: Expire max age.
expireMaxSize String: Expire max size.
rolloverDynamic String: Whether to turn on dynamic scrolling.
rolloverMaxAge String: Rollover max age.
shardNumDynamic String: Whether to enable dynamic slicing.
timestampField String: Time partition field.
writeMode String: Write mode.

expireMaxAge string: Expire max age.
expireMaxSize string: Expire max size.
rolloverDynamic string: Whether to turn on dynamic scrolling.
rolloverMaxAge string: Rollover max age.
shardNumDynamic string: Whether to enable dynamic slicing.
timestampField string: Time partition field.
writeMode string: Write mode.

expire_max_age str: Expire max age.
expire_max_size str: Expire max size.
rollover_dynamic str: Whether to turn on dynamic scrolling.
rollover_max_age str: Rollover max age.
shard_num_dynamic str: Whether to enable dynamic slicing.
timestamp_field str: Time partition field.
write_mode str: Write mode.

expireMaxAge String: Expire max age.
expireMaxSize String: Expire max size.
rolloverDynamic String: Whether to turn on dynamic scrolling.
rolloverMaxAge String: Rollover max age.
shardNumDynamic String: Whether to enable dynamic slicing.
timestampField String: Time partition field.
writeMode String: Write mode.

GetElasticsearchDescribeIndexListIndexMetaFieldIndexPolicyField

ColdAction string: Cold action.
ColdEnable string: Whether to enable the cold phase.
ColdMinAge string: Cold phase transition time.
FrozenEnable string: Start frozen phase.
FrozenMinAge string: Frozen phase transition time.
WarmEnable string: Whether to enable warm.
WarmMinAge string: Warm phase transition time.

ColdAction string: Cold action.
ColdEnable string: Whether to enable the cold phase.
ColdMinAge string: Cold phase transition time.
FrozenEnable string: Start frozen phase.
FrozenMinAge string: Frozen phase transition time.
WarmEnable string: Whether to enable warm.
WarmMinAge string: Warm phase transition time.

coldAction String: Cold action.
coldEnable String: Whether to enable the cold phase.
coldMinAge String: Cold phase transition time.
frozenEnable String: Start frozen phase.
frozenMinAge String: Frozen phase transition time.
warmEnable String: Whether to enable warm.
warmMinAge String: Warm phase transition time.

coldAction string: Cold action.
coldEnable string: Whether to enable the cold phase.
coldMinAge string: Cold phase transition time.
frozenEnable string: Start frozen phase.
frozenMinAge string: Frozen phase transition time.
warmEnable string: Whether to enable warm.
warmMinAge string: Warm phase transition time.

cold_action str: Cold action.
cold_enable str: Whether to enable the cold phase.
cold_min_age str: Cold phase transition time.
frozen_enable str: Start frozen phase.
frozen_min_age str: Frozen phase transition time.
warm_enable str: Whether to enable warm.
warm_min_age str: Warm phase transition time.

coldAction String: Cold action.
coldEnable String: Whether to enable the cold phase.
coldMinAge String: Cold phase transition time.
frozenEnable String: Start frozen phase.
frozenMinAge String: Frozen phase transition time.
warmEnable String: Whether to enable warm.
warmMinAge String: Warm phase transition time.

GetElasticsearchDescribeIndexListIndexMetaFieldIndexSettingsField

NumberOfReplicas string: Number of index copy fragments.
NumberOfShards string: Number of index main fragments.
RefreshInterval string: Index refresh frequency.

NumberOfReplicas string: Number of index copy fragments.
NumberOfShards string: Number of index main fragments.
RefreshInterval string: Index refresh frequency.

numberOfReplicas String: Number of index copy fragments.
numberOfShards String: Number of index main fragments.
refreshInterval String: Index refresh frequency.

numberOfReplicas string: Number of index copy fragments.
numberOfShards string: Number of index main fragments.
refreshInterval string: Index refresh frequency.

number_of_replicas str: Number of index copy fragments.
number_of_shards str: Number of index main fragments.
refresh_interval str: Index refresh frequency.

numberOfReplicas String: Number of index copy fragments.
numberOfShards String: Number of index main fragments.
refreshInterval String: Index refresh frequency.

Package Details

Repository: tencentcloud tencentcloudstack/terraform-provider-tencentcloud
License
Notes: This Pulumi package is based on the tencentcloud Terraform Provider.

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

tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getElasticsearchDescribeIndexList

On this page

On this page

Example Usage

Using getElasticsearchDescribeIndexList

getElasticsearchDescribeIndexList Result

Supporting Types

GetElasticsearchDescribeIndexListIndexMetaField

GetElasticsearchDescribeIndexListIndexMetaFieldBackingIndex

GetElasticsearchDescribeIndexListIndexMetaFieldIndexOptionsField

GetElasticsearchDescribeIndexListIndexMetaFieldIndexPolicyField

GetElasticsearchDescribeIndexListIndexMetaFieldIndexSettingsField

Package Details

On this page

On this page