getIndexes

Volcengine v0.0.45, Feb 10 26

Volcengine v0.0.45 published on Tuesday, Feb 10, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcengine

Volcengine v0.0.45 published on Tuesday, Feb 10, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcengine

Example Usage

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

const default = volcengine.tls.getIndexes({
    topicId: "c36ed436-84f1-467a-b00e-ba504db753ca",
});

import pulumi
import pulumi_volcengine as volcengine

default = volcengine.tls.get_indexes(topic_id="c36ed436-84f1-467a-b00e-ba504db753ca")

package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/tls"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := tls.GetIndexes(ctx, &tls.GetIndexesArgs{
			TopicId: "c36ed436-84f1-467a-b00e-ba504db753ca",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var @default = Volcengine.Tls.GetIndexes.Invoke(new()
    {
        TopicId = "c36ed436-84f1-467a-b00e-ba504db753ca",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.volcengine.tls.TlsFunctions;
import com.pulumi.volcengine.tls.inputs.GetIndexesArgs;
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 default = TlsFunctions.getIndexes(GetIndexesArgs.builder()
            .topicId("c36ed436-84f1-467a-b00e-ba504db753ca")
            .build());

    }
}

variables:
  default:
    fn::invoke:
      Function: volcengine:tls:getIndexes
      Arguments:
        topicId: c36ed436-84f1-467a-b00e-ba504db753ca

Using getIndexes

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 getIndexes(args: GetIndexesArgs, opts?: InvokeOptions): Promise<GetIndexesResult>
function getIndexesOutput(args: GetIndexesOutputArgs, opts?: InvokeOptions): Output<GetIndexesResult>

def get_indexes(output_file: Optional[str] = None,
                topic_id: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetIndexesResult
def get_indexes_output(output_file: Optional[pulumi.Input[str]] = None,
                topic_id: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetIndexesResult]

func GetIndexes(ctx *Context, args *GetIndexesArgs, opts ...InvokeOption) (*GetIndexesResult, error)
func GetIndexesOutput(ctx *Context, args *GetIndexesOutputArgs, opts ...InvokeOption) GetIndexesResultOutput

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

public static class GetIndexes 
{
    public static Task<GetIndexesResult> InvokeAsync(GetIndexesArgs args, InvokeOptions? opts = null)
    public static Output<GetIndexesResult> Invoke(GetIndexesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetIndexesResult> getIndexes(GetIndexesArgs args, InvokeOptions options)
public static Output<GetIndexesResult> getIndexes(GetIndexesArgs args, InvokeOptions options)

fn::invoke:
  function: volcengine:tls/getIndexes:getIndexes
  arguments:
    # arguments dictionary

The following arguments are supported:

TopicId string: The topic id of tls index.
OutputFile string: File name where to save data source results.

TopicId string: The topic id of tls index.
OutputFile string: File name where to save data source results.

topicId String: The topic id of tls index.
outputFile String: File name where to save data source results.

topicId string: The topic id of tls index.
outputFile string: File name where to save data source results.

topic_id str: The topic id of tls index.
output_file str: File name where to save data source results.

topicId String: The topic id of tls index.
outputFile String: File name where to save data source results.

getIndexes Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
TlsIndexes List<GetIndexesTlsIndex>: The collection of tls index query.
TopicId string: The topic id of the tls index.
TotalCount int: The total count of tls index query.
OutputFile string

Id string: The provider-assigned unique ID for this managed resource.
TlsIndexes []GetIndexesTlsIndex: The collection of tls index query.
TopicId string: The topic id of the tls index.
TotalCount int: The total count of tls index query.
OutputFile string

id String: The provider-assigned unique ID for this managed resource.
tlsIndexes List<GetIndexesTlsIndex>: The collection of tls index query.
topicId String: The topic id of the tls index.
totalCount Integer: The total count of tls index query.
outputFile String

id string: The provider-assigned unique ID for this managed resource.
tlsIndexes GetIndexesTlsIndex[]: The collection of tls index query.
topicId string: The topic id of the tls index.
totalCount number: The total count of tls index query.
outputFile string

id str: The provider-assigned unique ID for this managed resource.
tls_indexes Sequence[GetIndexesTlsIndex]: The collection of tls index query.
topic_id str: The topic id of the tls index.
total_count int: The total count of tls index query.
output_file str

id String: The provider-assigned unique ID for this managed resource.
tlsIndexes List<Property Map>: The collection of tls index query.
topicId String: The topic id of the tls index.
totalCount Number: The total count of tls index query.
outputFile String

Supporting Types

GetIndexesTlsIndex

CreateTime string: The create time of the tls index.
EnableAutoIndex bool: Whether to enable auto index.
FullText GetIndexesTlsIndexFullText: The FullText index of the tls topic.
Id string: The topic id of the tls index.
KeyValues List<GetIndexesTlsIndexKeyValue>: The KeyValue index of the tls topic.
MaxTextLen int: The max text length of the tls index.
ModifyTime string: The modify time of the tls index.
TopicId string: The topic id of tls index.
UserInnerKeyValues List<GetIndexesTlsIndexUserInnerKeyValue>: The reserved field index configuration of the tls topic.

CreateTime string: The create time of the tls index.
EnableAutoIndex bool: Whether to enable auto index.
FullText GetIndexesTlsIndexFullText: The FullText index of the tls topic.
Id string: The topic id of the tls index.
KeyValues []GetIndexesTlsIndexKeyValue: The KeyValue index of the tls topic.
MaxTextLen int: The max text length of the tls index.
ModifyTime string: The modify time of the tls index.
TopicId string: The topic id of tls index.
UserInnerKeyValues []GetIndexesTlsIndexUserInnerKeyValue: The reserved field index configuration of the tls topic.

createTime String: The create time of the tls index.
enableAutoIndex Boolean: Whether to enable auto index.
fullText GetIndexesTlsIndexFullText: The FullText index of the tls topic.
id String: The topic id of the tls index.
keyValues List<GetIndexesTlsIndexKeyValue>: The KeyValue index of the tls topic.
maxTextLen Integer: The max text length of the tls index.
modifyTime String: The modify time of the tls index.
topicId String: The topic id of tls index.
userInnerKeyValues List<GetIndexesTlsIndexUserInnerKeyValue>: The reserved field index configuration of the tls topic.

createTime string: The create time of the tls index.
enableAutoIndex boolean: Whether to enable auto index.
fullText GetIndexesTlsIndexFullText: The FullText index of the tls topic.
id string: The topic id of the tls index.
keyValues GetIndexesTlsIndexKeyValue[]: The KeyValue index of the tls topic.
maxTextLen number: The max text length of the tls index.
modifyTime string: The modify time of the tls index.
topicId string: The topic id of tls index.
userInnerKeyValues GetIndexesTlsIndexUserInnerKeyValue[]: The reserved field index configuration of the tls topic.

create_time str: The create time of the tls index.
enable_auto_index bool: Whether to enable auto index.
full_text GetIndexesTlsIndexFullText: The FullText index of the tls topic.
id str: The topic id of the tls index.
key_values Sequence[GetIndexesTlsIndexKeyValue]: The KeyValue index of the tls topic.
max_text_len int: The max text length of the tls index.
modify_time str: The modify time of the tls index.
topic_id str: The topic id of tls index.
user_inner_key_values Sequence[GetIndexesTlsIndexUserInnerKeyValue]: The reserved field index configuration of the tls topic.

createTime String: The create time of the tls index.
enableAutoIndex Boolean: Whether to enable auto index.
fullText Property Map: The FullText index of the tls topic.
id String: The topic id of the tls index.
keyValues List<Property Map>: The KeyValue index of the tls topic.
maxTextLen Number: The max text length of the tls index.
modifyTime String: The modify time of the tls index.
topicId String: The topic id of tls index.
userInnerKeyValues List<Property Map>: The reserved field index configuration of the tls topic.

GetIndexesTlsIndexFullText

CaseSensitive bool: Whether the value is case sensitive.
Delimiter string: The delimiter of the value.
IncludeChinese bool: Whether the value include chinese.

CaseSensitive bool: Whether the value is case sensitive.
Delimiter string: The delimiter of the value.
IncludeChinese bool: Whether the value include chinese.

caseSensitive Boolean: Whether the value is case sensitive.
delimiter String: The delimiter of the value.
includeChinese Boolean: Whether the value include chinese.

caseSensitive boolean: Whether the value is case sensitive.
delimiter string: The delimiter of the value.
includeChinese boolean: Whether the value include chinese.

case_sensitive bool: Whether the value is case sensitive.
delimiter str: The delimiter of the value.
include_chinese bool: Whether the value include chinese.

caseSensitive Boolean: Whether the value is case sensitive.
delimiter String: The delimiter of the value.
includeChinese Boolean: Whether the value include chinese.

GetIndexesTlsIndexKeyValue

AutoIndexFlag bool: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
CaseSensitive bool: Whether the value is case sensitive.
Delimiter string: The delimiter of the value.
IncludeChinese bool: Whether the value include chinese.
IndexAll bool: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
IndexSqlAll bool: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
JsonKeys List<GetIndexesTlsIndexKeyValueJsonKey>: The JSON subfield key value index.
Key string: The key of the KeyValueInfo.
SqlFlag bool: Whether the filed is enabled for analysis.
ValueType string: The type of value. Valid values: long, double, text, json.

AutoIndexFlag bool: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
CaseSensitive bool: Whether the value is case sensitive.
Delimiter string: The delimiter of the value.
IncludeChinese bool: Whether the value include chinese.
IndexAll bool: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
IndexSqlAll bool: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
JsonKeys []GetIndexesTlsIndexKeyValueJsonKey: The JSON subfield key value index.
Key string: The key of the KeyValueInfo.
SqlFlag bool: Whether the filed is enabled for analysis.
ValueType string: The type of value. Valid values: long, double, text, json.

autoIndexFlag Boolean: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
caseSensitive Boolean: Whether the value is case sensitive.
delimiter String: The delimiter of the value.
includeChinese Boolean: Whether the value include chinese.
indexAll Boolean: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
indexSqlAll Boolean: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
jsonKeys List<GetIndexesTlsIndexKeyValueJsonKey>: The JSON subfield key value index.
key String: The key of the KeyValueInfo.
sqlFlag Boolean: Whether the filed is enabled for analysis.
valueType String: The type of value. Valid values: long, double, text, json.

autoIndexFlag boolean: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
caseSensitive boolean: Whether the value is case sensitive.
delimiter string: The delimiter of the value.
includeChinese boolean: Whether the value include chinese.
indexAll boolean: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
indexSqlAll boolean: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
jsonKeys GetIndexesTlsIndexKeyValueJsonKey[]: The JSON subfield key value index.
key string: The key of the KeyValueInfo.
sqlFlag boolean: Whether the filed is enabled for analysis.
valueType string: The type of value. Valid values: long, double, text, json.

auto_index_flag bool: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
case_sensitive bool: Whether the value is case sensitive.
delimiter str: The delimiter of the value.
include_chinese bool: Whether the value include chinese.
index_all bool: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
index_sql_all bool: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
json_keys Sequence[GetIndexesTlsIndexKeyValueJsonKey]: The JSON subfield key value index.
key str: The key of the KeyValueInfo.
sql_flag bool: Whether the filed is enabled for analysis.
value_type str: The type of value. Valid values: long, double, text, json.

autoIndexFlag Boolean: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
caseSensitive Boolean: Whether the value is case sensitive.
delimiter String: The delimiter of the value.
includeChinese Boolean: Whether the value include chinese.
indexAll Boolean: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
indexSqlAll Boolean: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
jsonKeys List<Property Map>: The JSON subfield key value index.
key String: The key of the KeyValueInfo.
sqlFlag Boolean: Whether the filed is enabled for analysis.
valueType String: The type of value. Valid values: long, double, text, json.

GetIndexesTlsIndexKeyValueJsonKey

CaseSensitive bool: Whether the value is case sensitive.
Delimiter string: The delimiter of the value.
IncludeChinese bool: Whether the value include chinese.
Key string: The key of the KeyValueInfo.
SqlFlag bool: Whether the filed is enabled for analysis.
ValueType string: The type of value. Valid values: long, double, text, json.

CaseSensitive bool: Whether the value is case sensitive.
Delimiter string: The delimiter of the value.
IncludeChinese bool: Whether the value include chinese.
Key string: The key of the KeyValueInfo.
SqlFlag bool: Whether the filed is enabled for analysis.
ValueType string: The type of value. Valid values: long, double, text, json.

caseSensitive Boolean: Whether the value is case sensitive.
delimiter String: The delimiter of the value.
includeChinese Boolean: Whether the value include chinese.
key String: The key of the KeyValueInfo.
sqlFlag Boolean: Whether the filed is enabled for analysis.
valueType String: The type of value. Valid values: long, double, text, json.

caseSensitive boolean: Whether the value is case sensitive.
delimiter string: The delimiter of the value.
includeChinese boolean: Whether the value include chinese.
key string: The key of the KeyValueInfo.
sqlFlag boolean: Whether the filed is enabled for analysis.
valueType string: The type of value. Valid values: long, double, text, json.

case_sensitive bool: Whether the value is case sensitive.
delimiter str: The delimiter of the value.
include_chinese bool: Whether the value include chinese.
key str: The key of the KeyValueInfo.
sql_flag bool: Whether the filed is enabled for analysis.
value_type str: The type of value. Valid values: long, double, text, json.

caseSensitive Boolean: Whether the value is case sensitive.
delimiter String: The delimiter of the value.
includeChinese Boolean: Whether the value include chinese.
key String: The key of the KeyValueInfo.
sqlFlag Boolean: Whether the filed is enabled for analysis.
valueType String: The type of value. Valid values: long, double, text, json.

GetIndexesTlsIndexUserInnerKeyValue

AutoIndexFlag bool: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
CaseSensitive bool: Whether the value is case sensitive.
Delimiter string: The delimiter of the value.
IncludeChinese bool: Whether the value include chinese.
IndexAll bool: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
IndexSqlAll bool: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
JsonKeys List<GetIndexesTlsIndexUserInnerKeyValueJsonKey>: The JSON subfield key value index.
Key string: The key of the KeyValueInfo.
SqlFlag bool: Whether the filed is enabled for analysis.
ValueType string: The type of value. Valid values: long, double, text, json.

AutoIndexFlag bool: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
CaseSensitive bool: Whether the value is case sensitive.
Delimiter string: The delimiter of the value.
IncludeChinese bool: Whether the value include chinese.
IndexAll bool: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
IndexSqlAll bool: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
JsonKeys []GetIndexesTlsIndexUserInnerKeyValueJsonKey: The JSON subfield key value index.
Key string: The key of the KeyValueInfo.
SqlFlag bool: Whether the filed is enabled for analysis.
ValueType string: The type of value. Valid values: long, double, text, json.

autoIndexFlag Boolean: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
caseSensitive Boolean: Whether the value is case sensitive.
delimiter String: The delimiter of the value.
includeChinese Boolean: Whether the value include chinese.
indexAll Boolean: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
indexSqlAll Boolean: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
jsonKeys List<GetIndexesTlsIndexUserInnerKeyValueJsonKey>: The JSON subfield key value index.
key String: The key of the KeyValueInfo.
sqlFlag Boolean: Whether the filed is enabled for analysis.
valueType String: The type of value. Valid values: long, double, text, json.

autoIndexFlag boolean: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
caseSensitive boolean: Whether the value is case sensitive.
delimiter string: The delimiter of the value.
includeChinese boolean: Whether the value include chinese.
indexAll boolean: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
indexSqlAll boolean: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
jsonKeys GetIndexesTlsIndexUserInnerKeyValueJsonKey[]: The JSON subfield key value index.
key string: The key of the KeyValueInfo.
sqlFlag boolean: Whether the filed is enabled for analysis.
valueType string: The type of value. Valid values: long, double, text, json.

auto_index_flag bool: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
case_sensitive bool: Whether the value is case sensitive.
delimiter str: The delimiter of the value.
include_chinese bool: Whether the value include chinese.
index_all bool: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
index_sql_all bool: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
json_keys Sequence[GetIndexesTlsIndexUserInnerKeyValueJsonKey]: The JSON subfield key value index.
key str: The key of the KeyValueInfo.
sql_flag bool: Whether the filed is enabled for analysis.
value_type str: The type of value. Valid values: long, double, text, json.

autoIndexFlag Boolean: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
caseSensitive Boolean: Whether the value is case sensitive.
delimiter String: The delimiter of the value.
includeChinese Boolean: Whether the value include chinese.
indexAll Boolean: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
indexSqlAll Boolean: Whether to create indexes for all fields in JSON fields with text values. This field is valid when the value_type is json.
jsonKeys List<Property Map>: The JSON subfield key value index.
key String: The key of the KeyValueInfo.
sqlFlag Boolean: Whether the filed is enabled for analysis.
valueType String: The type of value. Valid values: long, double, text, json.

GetIndexesTlsIndexUserInnerKeyValueJsonKey

CaseSensitive bool: Whether the value is case sensitive.
Delimiter string: The delimiter of the value.
IncludeChinese bool: Whether the value include chinese.
Key string: The key of the KeyValueInfo.
SqlFlag bool: Whether the filed is enabled for analysis.
ValueType string: The type of value. Valid values: long, double, text, json.

CaseSensitive bool: Whether the value is case sensitive.
Delimiter string: The delimiter of the value.
IncludeChinese bool: Whether the value include chinese.
Key string: The key of the KeyValueInfo.
SqlFlag bool: Whether the filed is enabled for analysis.
ValueType string: The type of value. Valid values: long, double, text, json.

caseSensitive Boolean: Whether the value is case sensitive.
delimiter String: The delimiter of the value.
includeChinese Boolean: Whether the value include chinese.
key String: The key of the KeyValueInfo.
sqlFlag Boolean: Whether the filed is enabled for analysis.
valueType String: The type of value. Valid values: long, double, text, json.

caseSensitive boolean: Whether the value is case sensitive.
delimiter string: The delimiter of the value.
includeChinese boolean: Whether the value include chinese.
key string: The key of the KeyValueInfo.
sqlFlag boolean: Whether the filed is enabled for analysis.
valueType string: The type of value. Valid values: long, double, text, json.

case_sensitive bool: Whether the value is case sensitive.
delimiter str: The delimiter of the value.
include_chinese bool: Whether the value include chinese.
key str: The key of the KeyValueInfo.
sql_flag bool: Whether the filed is enabled for analysis.
value_type str: The type of value. Valid values: long, double, text, json.

caseSensitive Boolean: Whether the value is case sensitive.
delimiter String: The delimiter of the value.
includeChinese Boolean: Whether the value include chinese.
key String: The key of the KeyValueInfo.
sqlFlag Boolean: Whether the filed is enabled for analysis.
valueType String: The type of value. Valid values: long, double, text, json.

Package Details

Repository: volcengine volcengine/pulumi-volcengine
License: Apache-2.0
Notes: This Pulumi package is based on the volcengine Terraform Provider.

Volcengine v0.0.45 published on Tuesday, Feb 10, 2026 by Volcengine

Schema (JSON)

volcengine/pulumi-volcengine

volcengine.tls.getIndexes

On this page

On this page

Example Usage

Using getIndexes

getIndexes Result

Supporting Types

GetIndexesTlsIndex

GetIndexesTlsIndexFullText

GetIndexesTlsIndexKeyValue

GetIndexesTlsIndexKeyValueJsonKey

GetIndexesTlsIndexUserInnerKeyValue

GetIndexesTlsIndexUserInnerKeyValueJsonKey

Package Details

On this page

On this page