1. Packages
  2. Volcengine
  3. API Docs
  4. tls
  5. getIndexes
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
volcengine/pulumi-volcengine

volcengine.tls.getIndexes

Get Started
volcengine logo
Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
volcengine/pulumi-volcengine

    Use this data source to query detailed information of tls indexes

    Example Usage

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

const default = volcengine.tls.getIndexes({
    ids: ["7ce12237-6670-44a7-9d79-2e36961586e6"],
});

    import pulumi
import pulumi_volcengine as volcengine

default = volcengine.tls.get_indexes(ids=["7ce12237-6670-44a7-9d79-2e36961586e6"])

    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{
			Ids: []string{
				"7ce12237-6670-44a7-9d79-2e36961586e6",
			},
		}, 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()
    {
        Ids = new[]
        {
            "7ce12237-6670-44a7-9d79-2e36961586e6",
        },
    });

});

    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()
            .ids("7ce12237-6670-44a7-9d79-2e36961586e6")
            .build());

    }
}

    variables:
  default:
    fn::invoke:
      Function: volcengine:tls:getIndexes
      Arguments:
        ids:
          - 7ce12237-6670-44a7-9d79-2e36961586e6

    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(ids: Optional[Sequence[str]] = None,
                output_file: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetIndexesResult
def get_indexes_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                output_file: 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:

    Ids List<string>
    The list of topic id of tls index.
    OutputFile string
    File name where to save data source results.
    Ids []string
    The list of topic id of tls index.
    OutputFile string
    File name where to save data source results.
    ids List<String>
    The list of topic id of tls index.
    outputFile String
    File name where to save data source results.
    ids string[]
    The list of topic id of tls index.
    outputFile string
    File name where to save data source results.
    ids Sequence[str]
    The list of topic id of tls index.
    output_file str
    File name where to save data source results.
    ids List<String>
    The list of 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.
    Ids List<string>
    TlsIndexes List<GetIndexesTlsIndex>
    The collection of tls index query.
    TotalCount int
    The total count of tls index query.
    OutputFile string
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids []string
    TlsIndexes []GetIndexesTlsIndex
    The collection of tls index query.
    TotalCount int
    The total count of tls index query.
    OutputFile string
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    tlsIndexes List<GetIndexesTlsIndex>
    The collection of tls index query.
    totalCount Integer
    The total count of tls index query.
    outputFile String
    id string
    The provider-assigned unique ID for this managed resource.
    ids string[]
    tlsIndexes GetIndexesTlsIndex[]
    The collection of tls index query.
    totalCount number
    The total count of tls index query.
    outputFile string
    id str
    The provider-assigned unique ID for this managed resource.
    ids Sequence[str]
    tls_indexes Sequence[GetIndexesTlsIndex]
    The collection of tls index query.
    total_count int
    The total count of tls index query.
    output_file str
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    tlsIndexes List<Property Map>
    The collection of tls index query.
    totalCount Number
    The total count of tls index query.
    outputFile String

    Supporting Types

    GetIndexesTlsIndex

    CreateTime string
    The create time of the tls 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.
    ModifyTime string
    The modify time of the tls index.
    TopicId string
    The topic id of the tls index.
    UserInnerKeyValues List<GetIndexesTlsIndexUserInnerKeyValue>
    The reserved field index configuration of the tls topic.
    CreateTime string
    The create time of the tls 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.
    ModifyTime string
    The modify time of the tls index.
    TopicId string
    The topic id of the tls index.
    UserInnerKeyValues []GetIndexesTlsIndexUserInnerKeyValue
    The reserved field index configuration of the tls topic.
    createTime String
    The create time of the tls 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.
    modifyTime String
    The modify time of the tls index.
    topicId String
    The topic id of the tls index.
    userInnerKeyValues List<GetIndexesTlsIndexUserInnerKeyValue>
    The reserved field index configuration of the tls topic.
    createTime string
    The create time of the tls 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.
    modifyTime string
    The modify time of the tls index.
    topicId string
    The topic id of the tls index.
    userInnerKeyValues GetIndexesTlsIndexUserInnerKeyValue[]
    The reserved field index configuration of the tls topic.
    create_time str
    The create time of the tls 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.
    modify_time str
    The modify time of the tls index.
    topic_id str
    The topic id of the 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.
    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.
    modifyTime String
    The modify time of the tls index.
    topicId String
    The topic id of the 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

    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.
    JsonKeys List<GetIndexesTlsIndexKeyValueJsonKey>
    The JSON subfield key value index.
    Key string
    The key of the KeyValue index.
    SqlFlag bool
    Whether the filed is enabled for analysis.
    ValueType string
    The type of value.
    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.
    JsonKeys []GetIndexesTlsIndexKeyValueJsonKey
    The JSON subfield key value index.
    Key string
    The key of the KeyValue index.
    SqlFlag bool
    Whether the filed is enabled for analysis.
    ValueType string
    The type of value.
    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.
    jsonKeys List<GetIndexesTlsIndexKeyValueJsonKey>
    The JSON subfield key value index.
    key String
    The key of the KeyValue index.
    sqlFlag Boolean
    Whether the filed is enabled for analysis.
    valueType String
    The type of value.
    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.
    jsonKeys GetIndexesTlsIndexKeyValueJsonKey[]
    The JSON subfield key value index.
    key string
    The key of the KeyValue index.
    sqlFlag boolean
    Whether the filed is enabled for analysis.
    valueType string
    The type of value.
    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.
    json_keys Sequence[GetIndexesTlsIndexKeyValueJsonKey]
    The JSON subfield key value index.
    key str
    The key of the KeyValue index.
    sql_flag bool
    Whether the filed is enabled for analysis.
    value_type str
    The type of value.
    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.
    jsonKeys List<Property Map>
    The JSON subfield key value index.
    key String
    The key of the KeyValue index.
    sqlFlag Boolean
    Whether the filed is enabled for analysis.
    valueType String
    The type of value.

    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 KeyValue index.
    SqlFlag bool
    Whether the filed is enabled for analysis.
    ValueType string
    The type of value.
    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 KeyValue index.
    SqlFlag bool
    Whether the filed is enabled for analysis.
    ValueType string
    The type of value.
    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 KeyValue index.
    sqlFlag Boolean
    Whether the filed is enabled for analysis.
    valueType String
    The type of value.
    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 KeyValue index.
    sqlFlag boolean
    Whether the filed is enabled for analysis.
    valueType string
    The type of value.
    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 KeyValue index.
    sql_flag bool
    Whether the filed is enabled for analysis.
    value_type str
    The type of value.
    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 KeyValue index.
    sqlFlag Boolean
    Whether the filed is enabled for analysis.
    valueType String
    The type of value.

    GetIndexesTlsIndexUserInnerKeyValue

    CaseSensitive bool
    Whether the value is case sensitive.
    Delimiter string
    The delimiter of the value.
    IncludeChinese bool
    Whether the value include chinese.
    JsonKeys List<GetIndexesTlsIndexUserInnerKeyValueJsonKey>
    The JSON subfield key value index.
    Key string
    The key of the KeyValue index.
    SqlFlag bool
    Whether the filed is enabled for analysis.
    ValueType string
    The type of value.
    CaseSensitive bool
    Whether the value is case sensitive.
    Delimiter string
    The delimiter of the value.
    IncludeChinese bool
    Whether the value include chinese.
    JsonKeys []GetIndexesTlsIndexUserInnerKeyValueJsonKey
    The JSON subfield key value index.
    Key string
    The key of the KeyValue index.
    SqlFlag bool
    Whether the filed is enabled for analysis.
    ValueType string
    The type of value.
    caseSensitive Boolean
    Whether the value is case sensitive.
    delimiter String
    The delimiter of the value.
    includeChinese Boolean
    Whether the value include chinese.
    jsonKeys List<GetIndexesTlsIndexUserInnerKeyValueJsonKey>
    The JSON subfield key value index.
    key String
    The key of the KeyValue index.
    sqlFlag Boolean
    Whether the filed is enabled for analysis.
    valueType String
    The type of value.
    caseSensitive boolean
    Whether the value is case sensitive.
    delimiter string
    The delimiter of the value.
    includeChinese boolean
    Whether the value include chinese.
    jsonKeys GetIndexesTlsIndexUserInnerKeyValueJsonKey[]
    The JSON subfield key value index.
    key string
    The key of the KeyValue index.
    sqlFlag boolean
    Whether the filed is enabled for analysis.
    valueType string
    The type of value.
    case_sensitive bool
    Whether the value is case sensitive.
    delimiter str
    The delimiter of the value.
    include_chinese bool
    Whether the value include chinese.
    json_keys Sequence[GetIndexesTlsIndexUserInnerKeyValueJsonKey]
    The JSON subfield key value index.
    key str
    The key of the KeyValue index.
    sql_flag bool
    Whether the filed is enabled for analysis.
    value_type str
    The type of value.
    caseSensitive Boolean
    Whether the value is case sensitive.
    delimiter String
    The delimiter of the value.
    includeChinese Boolean
    Whether the value include chinese.
    jsonKeys List<Property Map>
    The JSON subfield key value index.
    key String
    The key of the KeyValue index.
    sqlFlag Boolean
    Whether the filed is enabled for analysis.
    valueType String
    The type of value.

    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 KeyValue index.
    SqlFlag bool
    Whether the filed is enabled for analysis.
    ValueType string
    The type of value.
    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 KeyValue index.
    SqlFlag bool
    Whether the filed is enabled for analysis.
    ValueType string
    The type of value.
    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 KeyValue index.
    sqlFlag Boolean
    Whether the filed is enabled for analysis.
    valueType String
    The type of value.
    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 KeyValue index.
    sqlFlag boolean
    Whether the filed is enabled for analysis.
    valueType string
    The type of value.
    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 KeyValue index.
    sql_flag bool
    Whether the filed is enabled for analysis.
    value_type str
    The type of value.
    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 KeyValue index.
    sqlFlag Boolean
    Whether the filed is enabled for analysis.
    valueType String
    The type of value.

    Package Details

    Repository
    volcengine volcengine/pulumi-volcengine
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the volcengine Terraform Provider.
    volcengine logo
    Volcengine v0.0.38 published on Friday, Oct 31, 2025 by Volcengine
    volcengine/pulumi-volcengine
      Meet Neo: Your AI Platform Teammate