getTables

Alibaba Cloud v3.88.1, Nov 8 25

Alibaba Cloud v3.88.1 published on Saturday, Nov 8, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-alicloud

Alibaba Cloud v3.88.1 published on Saturday, Nov 8, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-alicloud

Example Usage

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

const tablesDs = alicloud.ots.getTables({
    instanceName: "sample-instance",
    nameRegex: "sample-table",
    outputFile: "tables.txt",
});
export const firstTableId = tablesDs.then(tablesDs => tablesDs.tables?.[0]?.id);

import pulumi
import pulumi_alicloud as alicloud

tables_ds = alicloud.ots.get_tables(instance_name="sample-instance",
    name_regex="sample-table",
    output_file="tables.txt")
pulumi.export("firstTableId", tables_ds.tables[0].id)

package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/ots"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tablesDs, err := ots.GetTables(ctx, &ots.GetTablesArgs{
			InstanceName: "sample-instance",
			NameRegex:    pulumi.StringRef("sample-table"),
			OutputFile:   pulumi.StringRef("tables.txt"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("firstTableId", tablesDs.Tables[0].Id)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var tablesDs = AliCloud.Ots.GetTables.Invoke(new()
    {
        InstanceName = "sample-instance",
        NameRegex = "sample-table",
        OutputFile = "tables.txt",
    });

    return new Dictionary<string, object?>
    {
        ["firstTableId"] = tablesDs.Apply(getTablesResult => getTablesResult.Tables[0]?.Id),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.ots.OtsFunctions;
import com.pulumi.alicloud.ots.inputs.GetTablesArgs;
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 tablesDs = OtsFunctions.getTables(GetTablesArgs.builder()
            .instanceName("sample-instance")
            .nameRegex("sample-table")
            .outputFile("tables.txt")
            .build());

        ctx.export("firstTableId", tablesDs.tables()[0].id());
    }
}

variables:
  tablesDs:
    fn::invoke:
      function: alicloud:ots:getTables
      arguments:
        instanceName: sample-instance
        nameRegex: sample-table
        outputFile: tables.txt
outputs:
  firstTableId: ${tablesDs.tables[0].id}

Using getTables

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 getTables(args: GetTablesArgs, opts?: InvokeOptions): Promise<GetTablesResult>
function getTablesOutput(args: GetTablesOutputArgs, opts?: InvokeOptions): Output<GetTablesResult>

def get_tables(ids: Optional[Sequence[str]] = None,
               instance_name: Optional[str] = None,
               name_regex: Optional[str] = None,
               output_file: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetTablesResult
def get_tables_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,
               opts: Optional[InvokeOptions] = None) -> Output[GetTablesResult]

func GetTables(ctx *Context, args *GetTablesArgs, opts ...InvokeOption) (*GetTablesResult, error)
func GetTablesOutput(ctx *Context, args *GetTablesOutputArgs, opts ...InvokeOption) GetTablesResultOutput

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

public static class GetTables 
{
    public static Task<GetTablesResult> InvokeAsync(GetTablesArgs args, InvokeOptions? opts = null)
    public static Output<GetTablesResult> Invoke(GetTablesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetTablesResult> getTables(GetTablesArgs args, InvokeOptions options)
public static Output<GetTablesResult> getTables(GetTablesArgs args, InvokeOptions options)

fn::invoke:
  function: alicloud:ots/getTables:getTables
  arguments:
    # arguments dictionary

The following arguments are supported:

InstanceName string: The name of OTS instance.
Ids List<string>: A list of table IDs.
NameRegex string: A regex string to filter results by table name.
OutputFile string: File name where to save data source results (after running pulumi preview).

InstanceName string: The name of OTS instance.
Ids []string: A list of table IDs.
NameRegex string: A regex string to filter results by table name.
OutputFile string: File name where to save data source results (after running pulumi preview).

instanceName String: The name of OTS instance.
ids List<String>: A list of table IDs.
nameRegex String: A regex string to filter results by table name.
outputFile String: File name where to save data source results (after running pulumi preview).

instanceName string: The name of OTS instance.
ids string[]: A list of table IDs.
nameRegex string: A regex string to filter results by table name.
outputFile string: File name where to save data source results (after running pulumi preview).

instance_name str: The name of OTS instance.
ids Sequence[str]: A list of table IDs.
name_regex str: A regex string to filter results by table name.
output_file str: File name where to save data source results (after running pulumi preview).

instanceName String: The name of OTS instance.
ids List<String>: A list of table IDs.
nameRegex String: A regex string to filter results by table name.
outputFile String: File name where to save data source results (after running pulumi preview).

getTables Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Ids List<string>: A list of table IDs.
InstanceName string: The OTS instance name.
Names List<string>: A list of table names.
Tables List<Pulumi.AliCloud.Ots.Outputs.GetTablesTable>: A list of tables. Each element contains the following attributes:
NameRegex string
OutputFile string

Id string: The provider-assigned unique ID for this managed resource.
Ids []string: A list of table IDs.
InstanceName string: The OTS instance name.
Names []string: A list of table names.
Tables []GetTablesTable: A list of tables. Each element contains the following attributes:
NameRegex string
OutputFile string

id String: The provider-assigned unique ID for this managed resource.
ids List<String>: A list of table IDs.
instanceName String: The OTS instance name.
names List<String>: A list of table names.
tables List<GetTablesTable>: A list of tables. Each element contains the following attributes:
nameRegex String
outputFile String

id string: The provider-assigned unique ID for this managed resource.
ids string[]: A list of table IDs.
instanceName string: The OTS instance name.
names string[]: A list of table names.
tables GetTablesTable[]: A list of tables. Each element contains the following attributes:
nameRegex string
outputFile string

id str: The provider-assigned unique ID for this managed resource.
ids Sequence[str]: A list of table IDs.
instance_name str: The OTS instance name.
names Sequence[str]: A list of table names.
tables Sequence[GetTablesTable]: A list of tables. Each element contains the following attributes:
name_regex str
output_file str

id String: The provider-assigned unique ID for this managed resource.
ids List<String>: A list of table IDs.
instanceName String: The OTS instance name.
names List<String>: A list of table names.
tables List<Property Map>: A list of tables. Each element contains the following attributes:
nameRegex String
outputFile String

Supporting Types

GetTablesTable

DefinedColumns List<Pulumi.AliCloud.Ots.Inputs.GetTablesTableDefinedColumn>
Id string: ID of the table. The value is <instance_name>:<table_name>.
InstanceName string: The name of OTS instance.
MaxVersion int: The maximum number of versions stored in this table.
PrimaryKeys List<Pulumi.AliCloud.Ots.Inputs.GetTablesTablePrimaryKey>: The property of TableMeta which indicates the structure information of a table.
TableName string: The table name of the OTS which could not be changed.
TimeToLive int: The retention time of data stored in this table.

DefinedColumns []GetTablesTableDefinedColumn
Id string: ID of the table. The value is <instance_name>:<table_name>.
InstanceName string: The name of OTS instance.
MaxVersion int: The maximum number of versions stored in this table.
PrimaryKeys []GetTablesTablePrimaryKey: The property of TableMeta which indicates the structure information of a table.
TableName string: The table name of the OTS which could not be changed.
TimeToLive int: The retention time of data stored in this table.

definedColumns List<GetTablesTableDefinedColumn>
id String: ID of the table. The value is <instance_name>:<table_name>.
instanceName String: The name of OTS instance.
maxVersion Integer: The maximum number of versions stored in this table.
primaryKeys List<GetTablesTablePrimaryKey>: The property of TableMeta which indicates the structure information of a table.
tableName String: The table name of the OTS which could not be changed.
timeToLive Integer: The retention time of data stored in this table.

definedColumns GetTablesTableDefinedColumn[]
id string: ID of the table. The value is <instance_name>:<table_name>.
instanceName string: The name of OTS instance.
maxVersion number: The maximum number of versions stored in this table.
primaryKeys GetTablesTablePrimaryKey[]: The property of TableMeta which indicates the structure information of a table.
tableName string: The table name of the OTS which could not be changed.
timeToLive number: The retention time of data stored in this table.

defined_columns Sequence[GetTablesTableDefinedColumn]
id str: ID of the table. The value is <instance_name>:<table_name>.
instance_name str: The name of OTS instance.
max_version int: The maximum number of versions stored in this table.
primary_keys Sequence[GetTablesTablePrimaryKey]: The property of TableMeta which indicates the structure information of a table.
table_name str: The table name of the OTS which could not be changed.
time_to_live int: The retention time of data stored in this table.

definedColumns List<Property Map>
id String: ID of the table. The value is <instance_name>:<table_name>.
instanceName String: The name of OTS instance.
maxVersion Number: The maximum number of versions stored in this table.
primaryKeys List<Property Map>: The property of TableMeta which indicates the structure information of a table.
tableName String: The table name of the OTS which could not be changed.
timeToLive Number: The retention time of data stored in this table.

GetTablesTableDefinedColumn

Name string
Type string

Name string
Type string

name String
type String

name string
type string

name str
type str

name String
type String

GetTablesTablePrimaryKey

Name string
Type string

Name string
Type string

name String
type String

name string
type string

name str
type str

name String
type String

Package Details

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

Alibaba Cloud v3.88.1 published on Saturday, Nov 8, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-alicloud

alicloud.ots.getTables

On this page

On this page

Example Usage

Using getTables

getTables Result

Supporting Types

GetTablesTable

GetTablesTableDefinedColumn

GetTablesTablePrimaryKey

Package Details

On this page

On this page