1. Packages
  2. Alicloud Provider
  3. API Docs
  4. ots
  5. getSearchIndexes
Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi

alicloud.ots.getSearchIndexes

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi

    This data source provides the ots search index of the current Alibaba Cloud user.

    For information about OTS search index and how to use it, see Search index overview.

    NOTE: Available in v1.187.0+.

    Using getSearchIndexes

    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 getSearchIndexes(args: GetSearchIndexesArgs, opts?: InvokeOptions): Promise<GetSearchIndexesResult>
    function getSearchIndexesOutput(args: GetSearchIndexesOutputArgs, opts?: InvokeOptions): Output<GetSearchIndexesResult>
    def get_search_indexes(ids: Optional[Sequence[str]] = None,
                           instance_name: Optional[str] = None,
                           name_regex: Optional[str] = None,
                           output_file: Optional[str] = None,
                           table_name: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetSearchIndexesResult
    def get_search_indexes_output(ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                           instance_name: Optional[pulumi.Input[str]] = None,
                           name_regex: Optional[pulumi.Input[str]] = None,
                           output_file: Optional[pulumi.Input[str]] = None,
                           table_name: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetSearchIndexesResult]
    func GetSearchIndexes(ctx *Context, args *GetSearchIndexesArgs, opts ...InvokeOption) (*GetSearchIndexesResult, error)
    func GetSearchIndexesOutput(ctx *Context, args *GetSearchIndexesOutputArgs, opts ...InvokeOption) GetSearchIndexesResultOutput

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

    public static class GetSearchIndexes 
    {
        public static Task<GetSearchIndexesResult> InvokeAsync(GetSearchIndexesArgs args, InvokeOptions? opts = null)
        public static Output<GetSearchIndexesResult> Invoke(GetSearchIndexesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSearchIndexesResult> getSearchIndexes(GetSearchIndexesArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: alicloud:ots/getSearchIndexes:getSearchIndexes
      arguments:
        # arguments dictionary

    The following arguments are supported:

    InstanceName string
    The name of OTS instance.
    TableName string
    The name of OTS table.
    Ids List<string>
    A list of search index IDs.
    NameRegex string
    A regex string to filter results by search index name.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    InstanceName string
    The name of OTS instance.
    TableName string
    The name of OTS table.
    Ids []string
    A list of search index IDs.
    NameRegex string
    A regex string to filter results by search index name.
    OutputFile string
    File name where to save data source results (after running pulumi preview).
    instanceName String
    The name of OTS instance.
    tableName String
    The name of OTS table.
    ids List<String>
    A list of search index IDs.
    nameRegex String
    A regex string to filter results by search index name.
    outputFile String
    File name where to save data source results (after running pulumi preview).
    instanceName string
    The name of OTS instance.
    tableName string
    The name of OTS table.
    ids string[]
    A list of search index IDs.
    nameRegex string
    A regex string to filter results by search index name.
    outputFile string
    File name where to save data source results (after running pulumi preview).
    instance_name str
    The name of OTS instance.
    table_name str
    The name of OTS table.
    ids Sequence[str]
    A list of search index IDs.
    name_regex str
    A regex string to filter results by search index name.
    output_file str
    File name where to save data source results (after running pulumi preview).
    instanceName String
    The name of OTS instance.
    tableName String
    The name of OTS table.
    ids List<String>
    A list of search index IDs.
    nameRegex String
    A regex string to filter results by search index name.
    outputFile String
    File name where to save data source results (after running pulumi preview).

    getSearchIndexes Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    Ids List<string>
    A list of search index IDs.
    Indexes List<Pulumi.AliCloud.Ots.Outputs.GetSearchIndexesIndex>
    A list of indexes. Each element contains the following attributes:
    InstanceName string
    The OTS instance name.
    Names List<string>
    A list of search index names.
    TableName string
    The table name of the OTS which could not be changed.
    NameRegex string
    OutputFile string
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids []string
    A list of search index IDs.
    Indexes []GetSearchIndexesIndex
    A list of indexes. Each element contains the following attributes:
    InstanceName string
    The OTS instance name.
    Names []string
    A list of search index names.
    TableName string
    The table name of the OTS which could not be changed.
    NameRegex string
    OutputFile string
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    A list of search index IDs.
    indexes List<GetSearchIndexesIndex>
    A list of indexes. Each element contains the following attributes:
    instanceName String
    The OTS instance name.
    names List<String>
    A list of search index names.
    tableName String
    The table name of the OTS which could not be changed.
    nameRegex String
    outputFile String
    id string
    The provider-assigned unique ID for this managed resource.
    ids string[]
    A list of search index IDs.
    indexes GetSearchIndexesIndex[]
    A list of indexes. Each element contains the following attributes:
    instanceName string
    The OTS instance name.
    names string[]
    A list of search index names.
    tableName string
    The table name of the OTS which could not be changed.
    nameRegex string
    outputFile string
    id str
    The provider-assigned unique ID for this managed resource.
    ids Sequence[str]
    A list of search index IDs.
    indexes Sequence[GetSearchIndexesIndex]
    A list of indexes. Each element contains the following attributes:
    instance_name str
    The OTS instance name.
    names Sequence[str]
    A list of search index names.
    table_name str
    The table name of the OTS which could not be changed.
    name_regex str
    output_file str
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    A list of search index IDs.
    indexes List<Property Map>
    A list of indexes. Each element contains the following attributes:
    instanceName String
    The OTS instance name.
    names List<String>
    A list of search index names.
    tableName String
    The table name of the OTS which could not be changed.
    nameRegex String
    outputFile String

    Supporting Types

    GetSearchIndexesIndex

    CreateTime int
    The creation time of the index.
    CurrentSyncTimestamp int
    Timestamp for sync phase.
    Id string
    The resource ID. The value is <instance_name>:<table_name>:<indexName>:<indexType>.
    IndexName string
    The index name of the OTS Table which could not be changed.
    InstanceName string
    The name of OTS instance.
    MeteringLastUpdateTime int
    Last update time for metering data..
    ReservedReadCu int
    Reserve related resources for the index.
    RowCount int
    The number of rows of data for index.
    Schema string
    JSON representation of the schema of index.
    StorageSize int
    Storage space occupied by index.
    SyncPhase string
    The synchronization state of the index.
    TableName string
    The name of OTS table.
    TimeToLive int
    TTL of index.
    CreateTime int
    The creation time of the index.
    CurrentSyncTimestamp int
    Timestamp for sync phase.
    Id string
    The resource ID. The value is <instance_name>:<table_name>:<indexName>:<indexType>.
    IndexName string
    The index name of the OTS Table which could not be changed.
    InstanceName string
    The name of OTS instance.
    MeteringLastUpdateTime int
    Last update time for metering data..
    ReservedReadCu int
    Reserve related resources for the index.
    RowCount int
    The number of rows of data for index.
    Schema string
    JSON representation of the schema of index.
    StorageSize int
    Storage space occupied by index.
    SyncPhase string
    The synchronization state of the index.
    TableName string
    The name of OTS table.
    TimeToLive int
    TTL of index.
    createTime Integer
    The creation time of the index.
    currentSyncTimestamp Integer
    Timestamp for sync phase.
    id String
    The resource ID. The value is <instance_name>:<table_name>:<indexName>:<indexType>.
    indexName String
    The index name of the OTS Table which could not be changed.
    instanceName String
    The name of OTS instance.
    meteringLastUpdateTime Integer
    Last update time for metering data..
    reservedReadCu Integer
    Reserve related resources for the index.
    rowCount Integer
    The number of rows of data for index.
    schema String
    JSON representation of the schema of index.
    storageSize Integer
    Storage space occupied by index.
    syncPhase String
    The synchronization state of the index.
    tableName String
    The name of OTS table.
    timeToLive Integer
    TTL of index.
    createTime number
    The creation time of the index.
    currentSyncTimestamp number
    Timestamp for sync phase.
    id string
    The resource ID. The value is <instance_name>:<table_name>:<indexName>:<indexType>.
    indexName string
    The index name of the OTS Table which could not be changed.
    instanceName string
    The name of OTS instance.
    meteringLastUpdateTime number
    Last update time for metering data..
    reservedReadCu number
    Reserve related resources for the index.
    rowCount number
    The number of rows of data for index.
    schema string
    JSON representation of the schema of index.
    storageSize number
    Storage space occupied by index.
    syncPhase string
    The synchronization state of the index.
    tableName string
    The name of OTS table.
    timeToLive number
    TTL of index.
    create_time int
    The creation time of the index.
    current_sync_timestamp int
    Timestamp for sync phase.
    id str
    The resource ID. The value is <instance_name>:<table_name>:<indexName>:<indexType>.
    index_name str
    The index name of the OTS Table which could not be changed.
    instance_name str
    The name of OTS instance.
    metering_last_update_time int
    Last update time for metering data..
    reserved_read_cu int
    Reserve related resources for the index.
    row_count int
    The number of rows of data for index.
    schema str
    JSON representation of the schema of index.
    storage_size int
    Storage space occupied by index.
    sync_phase str
    The synchronization state of the index.
    table_name str
    The name of OTS table.
    time_to_live int
    TTL of index.
    createTime Number
    The creation time of the index.
    currentSyncTimestamp Number
    Timestamp for sync phase.
    id String
    The resource ID. The value is <instance_name>:<table_name>:<indexName>:<indexType>.
    indexName String
    The index name of the OTS Table which could not be changed.
    instanceName String
    The name of OTS instance.
    meteringLastUpdateTime Number
    Last update time for metering data..
    reservedReadCu Number
    Reserve related resources for the index.
    rowCount Number
    The number of rows of data for index.
    schema String
    JSON representation of the schema of index.
    storageSize Number
    Storage space occupied by index.
    syncPhase String
    The synchronization state of the index.
    tableName String
    The name of OTS table.
    timeToLive Number
    TTL of index.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.62.1 published on Monday, Sep 16, 2024 by Pulumi